Sync classref with current source

This commit is contained in:
Rémi Verschelde
2018-05-28 14:55:19 +02:00
parent d794128b14
commit ec28f3d429
156 changed files with 5216 additions and 3596 deletions

View File

@@ -82,11 +82,13 @@ Member Functions
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_inf<class_@GDScript_is_inf>` **(** :ref:`float<class_float>` s **)** |
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_instance_valid<class_@GDScript_is_instance_valid>` **(** :ref:`Object<class_object>` instance **)** |
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_nan<class_@GDScript_is_nan>` **(** :ref:`float<class_float>` s **)** |
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`len<class_@GDScript_len>` **(** :ref:`Variant<class_variant>` var **)** |
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`lerp<class_@GDScript_lerp>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight **)** |
| :ref:`float<class_float>` | :ref:`lerp<class_@GDScript_lerp>` **(** :ref:`Variant<class_variant>` from, :ref:`Variant<class_variant>` to, :ref:`float<class_float>` weight **)** |
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`linear2db<class_@GDScript_linear2db>` **(** :ref:`float<class_float>` nrg **)** |
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -579,6 +581,10 @@ Returns a normalized value considering the given range.
Returns True/False whether ``s`` is an infinity value (either positive infinity or negative infinity).
.. _class_@GDScript_is_instance_valid:
- :ref:`bool<class_bool>` **is_instance_valid** **(** :ref:`Object<class_object>` instance **)**
.. _class_@GDScript_is_nan:
- :ref:`bool<class_bool>` **is_nan** **(** :ref:`float<class_float>` s **)**
@@ -598,7 +604,7 @@ Returns length of Variant ``var``. Length is the character count of String, elem
.. _class_@GDScript_lerp:
- :ref:`float<class_float>` **lerp** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight **)**
- :ref:`float<class_float>` **lerp** **(** :ref:`Variant<class_variant>` from, :ref:`Variant<class_variant>` to, :ref:`float<class_float>` weight **)**
Linearly interpolates between two values by a normalized value.

View File

@@ -73,7 +73,7 @@ Member Function Description
- :ref:`Button<class_button>` **add_button** **(** :ref:`String<class_string>` text, :ref:`bool<class_bool>` right=false, :ref:`String<class_string>` action="" **)**
Adds a button with label *text* and a custom *action* to the dialog and returns the created button. *action* will be passed to the custom_action signal when pressed.
Adds a button with label *text* and a custom *action* to the dialog and returns the created button. *action* will be passed to the :ref:`custom_action<class_AcceptDialog_custom_action>` signal when pressed.
If ``true``, *right* will place the button to the right of any sibling buttons. Default value: ``false``.

View File

@@ -78,6 +78,10 @@ Member Variables
- :ref:`bool<class_bool>` **playing** - If ``true`` the :ref:`animation<class_AnimatedSprite_animation>` is currently playing.
.. _class_AnimatedSprite_speed_scale:
- :ref:`float<class_float>` **speed_scale**
Description
-----------

View File

@@ -19,81 +19,81 @@ Contains data used to animate everything in the engine.
Member Functions
----------------
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`add_track<class_Animation_add_track>` **(** :ref:`int<class_int>` type, :ref:`int<class_int>` at_position=-1 **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_Animation_clear>` **(** **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`copy_track<class_Animation_copy_track>` **(** :ref:`int<class_int>` track, :ref:`Animation<class_animation>` to_animation **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`find_track<class_Animation_find_track>` **(** :ref:`NodePath<class_nodepath>` path **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_track_count<class_Animation_get_track_count>` **(** **)** 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 |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`method_track_get_params<class_Animation_method_track_get_params>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_track<class_Animation_remove_track>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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 |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`track_get_interpolation_type<class_Animation_track_get_interpolation_type>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`track_get_key_count<class_Animation_track_get_key_count>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`track_get_key_time<class_Animation_track_get_key_time>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`track_get_key_transition<class_Animation_track_get_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`track_get_key_value<class_Animation_track_get_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`track_get_path<class_Animation_track_get_path>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`track_get_type<class_Animation_track_get_type>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_insert_key<class_Animation_track_insert_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Variant<class_variant>` key, :ref:`float<class_float>` transition=1 **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`track_is_enabled<class_Animation_track_is_enabled>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`track_is_imported<class_Animation_track_is_imported>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_move_down<class_Animation_track_move_down>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_move_up<class_Animation_track_move_up>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_remove_key<class_Animation_track_remove_key>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_remove_key_at_position<class_Animation_track_remove_key_at_position>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` position **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_enabled<class_Animation_track_set_enabled>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enabled **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_imported<class_Animation_track_set_imported>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` imported **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_interpolation_loop_wrap<class_Animation_track_set_interpolation_loop_wrap>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` interpolation **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_interpolation_type<class_Animation_track_set_interpolation_type>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` interpolation **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_key_transition<class_Animation_track_set_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` transition **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_key_value<class_Animation_track_set_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key, :ref:`Variant<class_variant>` value **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_path<class_Animation_track_set_path>` **(** :ref:`int<class_int>` idx, :ref:`NodePath<class_nodepath>` path **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`transform_track_insert_key<class_Animation_transform_track_insert_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Vector3<class_vector3>` location, :ref:`Quat<class_quat>` rotation, :ref:`Vector3<class_vector3>` scale **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`transform_track_interpolate<class_Animation_transform_track_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`value_track_get_key_indices<class_Animation_value_track_get_key_indices>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`value_track_get_update_mode<class_Animation_value_track_get_update_mode>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`value_track_set_update_mode<class_Animation_value_track_set_update_mode>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` mode **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`add_track<class_Animation_add_track>` **(** :ref:`TrackType<enum_animation_tracktype>` type, :ref:`int<class_int>` at_position=-1 **)** |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_Animation_clear>` **(** **)** |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`copy_track<class_Animation_copy_track>` **(** :ref:`int<class_int>` track, :ref:`Animation<class_animation>` to_animation **)** |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`find_track<class_Animation_find_track>` **(** :ref:`NodePath<class_nodepath>` path **)** const |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_track_count<class_Animation_get_track_count>` **(** **)** 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 |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`method_track_get_params<class_Animation_method_track_get_params>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_track<class_Animation_remove_track>` **(** :ref:`int<class_int>` idx **)** |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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 |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`InterpolationType<enum_animation_interpolationtype>` | :ref:`track_get_interpolation_type<class_Animation_track_get_interpolation_type>` **(** :ref:`int<class_int>` idx **)** const |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`track_get_key_count<class_Animation_track_get_key_count>` **(** :ref:`int<class_int>` idx **)** const |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`track_get_key_time<class_Animation_track_get_key_time>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`track_get_key_transition<class_Animation_track_get_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`track_get_key_value<class_Animation_track_get_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`track_get_path<class_Animation_track_get_path>` **(** :ref:`int<class_int>` idx **)** const |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TrackType<enum_animation_tracktype>` | :ref:`track_get_type<class_Animation_track_get_type>` **(** :ref:`int<class_int>` idx **)** const |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_insert_key<class_Animation_track_insert_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Variant<class_variant>` key, :ref:`float<class_float>` transition=1 **)** |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`track_is_enabled<class_Animation_track_is_enabled>` **(** :ref:`int<class_int>` idx **)** const |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`track_is_imported<class_Animation_track_is_imported>` **(** :ref:`int<class_int>` idx **)** const |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_move_down<class_Animation_track_move_down>` **(** :ref:`int<class_int>` idx **)** |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_move_up<class_Animation_track_move_up>` **(** :ref:`int<class_int>` idx **)** |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_remove_key<class_Animation_track_remove_key>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_remove_key_at_position<class_Animation_track_remove_key_at_position>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` position **)** |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_enabled<class_Animation_track_set_enabled>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enabled **)** |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_imported<class_Animation_track_set_imported>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` imported **)** |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_interpolation_loop_wrap<class_Animation_track_set_interpolation_loop_wrap>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` interpolation **)** |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_interpolation_type<class_Animation_track_set_interpolation_type>` **(** :ref:`int<class_int>` idx, :ref:`InterpolationType<enum_animation_interpolationtype>` interpolation **)** |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_key_transition<class_Animation_track_set_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` transition **)** |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_key_value<class_Animation_track_set_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key, :ref:`Variant<class_variant>` value **)** |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_path<class_Animation_track_set_path>` **(** :ref:`int<class_int>` idx, :ref:`NodePath<class_nodepath>` path **)** |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`transform_track_insert_key<class_Animation_transform_track_insert_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Vector3<class_vector3>` location, :ref:`Quat<class_quat>` rotation, :ref:`Vector3<class_vector3>` scale **)** |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`transform_track_interpolate<class_Animation_transform_track_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec **)** const |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`value_track_get_key_indices<class_Animation_value_track_get_key_indices>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`UpdateMode<enum_animation_updatemode>` | :ref:`value_track_get_update_mode<class_Animation_value_track_get_update_mode>` **(** :ref:`int<class_int>` idx **)** const |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`value_track_set_update_mode<class_Animation_value_track_set_update_mode>` **(** :ref:`int<class_int>` idx, :ref:`UpdateMode<enum_animation_updatemode>` mode **)** |
+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -151,7 +151,7 @@ Member Function Description
.. _class_Animation_add_track:
- :ref:`int<class_int>` **add_track** **(** :ref:`int<class_int>` type, :ref:`int<class_int>` at_position=-1 **)**
- :ref:`int<class_int>` **add_track** **(** :ref:`TrackType<enum_animation_tracktype>` type, :ref:`int<class_int>` at_position=-1 **)**
Add a track to the Animation. The track type must be specified as any of the values in the TYPE\_\* enumeration.
@@ -217,7 +217,7 @@ Returns ``true`` if the track at ``idx`` wraps the interpolation loop. Default v
.. _class_Animation_track_get_interpolation_type:
- :ref:`int<class_int>` **track_get_interpolation_type** **(** :ref:`int<class_int>` idx **)** const
- :ref:`InterpolationType<enum_animation_interpolationtype>` **track_get_interpolation_type** **(** :ref:`int<class_int>` idx **)** const
Return the interpolation type of a given track, from the INTERPOLATION\_\* enum.
@@ -253,7 +253,7 @@ Get the path of a track. for more information on the path format, see :ref:`trac
.. _class_Animation_track_get_type:
- :ref:`int<class_int>` **track_get_type** **(** :ref:`int<class_int>` idx **)** const
- :ref:`TrackType<enum_animation_tracktype>` **track_get_type** **(** :ref:`int<class_int>` idx **)** const
Get the type of a track.
@@ -319,7 +319,7 @@ If ``true`` the track at ``idx`` wraps the interpolation loop.
.. _class_Animation_track_set_interpolation_type:
- void **track_set_interpolation_type** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` interpolation **)**
- void **track_set_interpolation_type** **(** :ref:`int<class_int>` idx, :ref:`InterpolationType<enum_animation_interpolationtype>` interpolation **)**
Set the interpolation type of a given track, from the INTERPOLATION\_\* enum.
@@ -361,13 +361,13 @@ Return all the key indices of a value track, given a position and delta time.
.. _class_Animation_value_track_get_update_mode:
- :ref:`int<class_int>` **value_track_get_update_mode** **(** :ref:`int<class_int>` idx **)** const
- :ref:`UpdateMode<enum_animation_updatemode>` **value_track_get_update_mode** **(** :ref:`int<class_int>` idx **)** const
Return the update mode of a value track.
.. _class_Animation_value_track_set_update_mode:
- void **value_track_set_update_mode** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` mode **)**
- void **value_track_set_update_mode** **(** :ref:`int<class_int>` idx, :ref:`UpdateMode<enum_animation_updatemode>` mode **)**
Set the update mode (UPDATE\_\*) of a value track.

View File

@@ -20,7 +20,7 @@ Member Functions
----------------
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`add_animation<class_AnimationPlayer_add_animation>` **(** :ref:`String<class_string>` name, :ref:`Animation<class_animation>` animation **)** |
| :ref:`Error<enum_@globalscope_error>` | :ref:`add_animation<class_AnimationPlayer_add_animation>` **(** :ref:`String<class_string>` name, :ref:`Animation<class_animation>` animation **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`advance<class_AnimationPlayer_advance>` **(** :ref:`float<class_float>` delta **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -118,7 +118,7 @@ Member Variables
.. _class_AnimationPlayer_playback_process_mode:
- :ref:`AnimationProcessMode<enum_animationplayer_animationprocessmode>` **playback_process_mode** - The process notification in which to update animations. Default value: enum ANIMATION_PROCESS_IDLE.
- :ref:`AnimationProcessMode<enum_animationplayer_animationprocessmode>` **playback_process_mode** - The process notification in which to update animations. Default value: :ref:`ANIMATION_PROCESS_IDLE<enum_@globalscope_animation_process_idle>`.
.. _class_AnimationPlayer_playback_speed:
@@ -150,7 +150,7 @@ Member Function Description
.. _class_AnimationPlayer_add_animation:
- :ref:`int<class_int>` **add_animation** **(** :ref:`String<class_string>` name, :ref:`Animation<class_animation>` animation **)**
- :ref:`Error<enum_@globalscope_error>` **add_animation** **(** :ref:`String<class_string>` name, :ref:`Animation<class_animation>` animation **)**
Adds ``animation`` to the player accessible with the key ``name``.

View File

@@ -19,119 +19,121 @@ Animation Player that uses a node graph for blending Animations.
Member Functions
----------------
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_node<class_AnimationTreePlayer_add_node>` **(** :ref:`int<class_int>` type, :ref:`String<class_string>` id **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`advance<class_AnimationTreePlayer_advance>` **(** :ref:`float<class_float>` delta **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Animation<class_animation>` | :ref:`animation_node_get_animation<class_AnimationTreePlayer_animation_node_get_animation>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`animation_node_get_master_animation<class_AnimationTreePlayer_animation_node_get_master_animation>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`animation_node_set_animation<class_AnimationTreePlayer_animation_node_set_animation>` **(** :ref:`String<class_string>` id, :ref:`Animation<class_animation>` animation **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`animation_node_set_filter_path<class_AnimationTreePlayer_animation_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`animation_node_set_master_animation<class_AnimationTreePlayer_animation_node_set_master_animation>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` source **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`are_nodes_connected<class_AnimationTreePlayer_are_nodes_connected>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`blend2_node_get_amount<class_AnimationTreePlayer_blend2_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend2_node_set_amount<class_AnimationTreePlayer_blend2_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend2_node_set_filter_path<class_AnimationTreePlayer_blend2_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`blend3_node_get_amount<class_AnimationTreePlayer_blend3_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend3_node_set_amount<class_AnimationTreePlayer_blend3_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`blend4_node_get_amount<class_AnimationTreePlayer_blend4_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend4_node_set_amount<class_AnimationTreePlayer_blend4_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` blend **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`connect_nodes<class_AnimationTreePlayer_connect_nodes>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect_nodes<class_AnimationTreePlayer_disconnect_nodes>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` dst_input_idx **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_node_list<class_AnimationTreePlayer_get_node_list>` **(** **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`mix_node_get_amount<class_AnimationTreePlayer_mix_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`mix_node_set_amount<class_AnimationTreePlayer_mix_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` ratio **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`node_exists<class_AnimationTreePlayer_node_exists>` **(** :ref:`String<class_string>` node **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`node_get_input_count<class_AnimationTreePlayer_node_get_input_count>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`node_get_input_source<class_AnimationTreePlayer_node_get_input_source>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` idx **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`node_get_position<class_AnimationTreePlayer_node_get_position>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`node_get_type<class_AnimationTreePlayer_node_get_type>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`node_rename<class_AnimationTreePlayer_node_rename>` **(** :ref:`String<class_string>` node, :ref:`String<class_string>` new_name **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`node_set_position<class_AnimationTreePlayer_node_set_position>` **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` screen_position **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_delay>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_random_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadein_time<class_AnimationTreePlayer_oneshot_node_get_fadein_time>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadeout_time<class_AnimationTreePlayer_oneshot_node_get_fadeout_time>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`oneshot_node_has_autorestart<class_AnimationTreePlayer_oneshot_node_has_autorestart>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`oneshot_node_is_active<class_AnimationTreePlayer_oneshot_node_is_active>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_autorestart<class_AnimationTreePlayer_oneshot_node_set_autorestart>` **(** :ref:`String<class_string>` id, :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_autorestart_delay<class_AnimationTreePlayer_oneshot_node_set_autorestart_delay>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` delay_sec **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_autorestart_random_delay<class_AnimationTreePlayer_oneshot_node_set_autorestart_random_delay>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` rand_sec **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_fadein_time<class_AnimationTreePlayer_oneshot_node_set_fadein_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_fadeout_time<class_AnimationTreePlayer_oneshot_node_set_fadeout_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_filter_path<class_AnimationTreePlayer_oneshot_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_start<class_AnimationTreePlayer_oneshot_node_start>` **(** :ref:`String<class_string>` id **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_stop<class_AnimationTreePlayer_oneshot_node_stop>` **(** :ref:`String<class_string>` id **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`recompute_caches<class_AnimationTreePlayer_recompute_caches>` **(** **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_node<class_AnimationTreePlayer_remove_node>` **(** :ref:`String<class_string>` id **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`reset<class_AnimationTreePlayer_reset>` **(** **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`timescale_node_get_scale<class_AnimationTreePlayer_timescale_node_get_scale>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`timescale_node_set_scale<class_AnimationTreePlayer_timescale_node_set_scale>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` scale **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`timeseek_node_seek<class_AnimationTreePlayer_timeseek_node_seek>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` seconds **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_delete_input<class_AnimationTreePlayer_transition_node_delete_input>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`transition_node_get_current<class_AnimationTreePlayer_transition_node_get_current>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`transition_node_get_input_count<class_AnimationTreePlayer_transition_node_get_input_count>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`transition_node_get_xfade_time<class_AnimationTreePlayer_transition_node_get_xfade_time>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`transition_node_has_input_auto_advance<class_AnimationTreePlayer_transition_node_has_input_auto_advance>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_current<class_AnimationTreePlayer_transition_node_set_current>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_input_auto_advance<class_AnimationTreePlayer_transition_node_set_input_auto_advance>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_input_count<class_AnimationTreePlayer_transition_node_set_input_count>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` count **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_xfade_time<class_AnimationTreePlayer_transition_node_set_xfade_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_node<class_AnimationTreePlayer_add_node>` **(** :ref:`NodeType<enum_animationtreeplayer_nodetype>` type, :ref:`String<class_string>` id **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`advance<class_AnimationTreePlayer_advance>` **(** :ref:`float<class_float>` delta **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Animation<class_animation>` | :ref:`animation_node_get_animation<class_AnimationTreePlayer_animation_node_get_animation>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`animation_node_get_master_animation<class_AnimationTreePlayer_animation_node_get_master_animation>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`animation_node_get_position<class_AnimationTreePlayer_animation_node_get_position>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`animation_node_set_animation<class_AnimationTreePlayer_animation_node_set_animation>` **(** :ref:`String<class_string>` id, :ref:`Animation<class_animation>` animation **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`animation_node_set_filter_path<class_AnimationTreePlayer_animation_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`animation_node_set_master_animation<class_AnimationTreePlayer_animation_node_set_master_animation>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` source **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`are_nodes_connected<class_AnimationTreePlayer_are_nodes_connected>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`blend2_node_get_amount<class_AnimationTreePlayer_blend2_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend2_node_set_amount<class_AnimationTreePlayer_blend2_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend2_node_set_filter_path<class_AnimationTreePlayer_blend2_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`blend3_node_get_amount<class_AnimationTreePlayer_blend3_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend3_node_set_amount<class_AnimationTreePlayer_blend3_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`blend4_node_get_amount<class_AnimationTreePlayer_blend4_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend4_node_set_amount<class_AnimationTreePlayer_blend4_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` blend **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`connect_nodes<class_AnimationTreePlayer_connect_nodes>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect_nodes<class_AnimationTreePlayer_disconnect_nodes>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` dst_input_idx **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_node_list<class_AnimationTreePlayer_get_node_list>` **(** **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`mix_node_get_amount<class_AnimationTreePlayer_mix_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`mix_node_set_amount<class_AnimationTreePlayer_mix_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` ratio **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`node_exists<class_AnimationTreePlayer_node_exists>` **(** :ref:`String<class_string>` node **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`node_get_input_count<class_AnimationTreePlayer_node_get_input_count>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`node_get_input_source<class_AnimationTreePlayer_node_get_input_source>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` idx **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`node_get_position<class_AnimationTreePlayer_node_get_position>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodeType<enum_animationtreeplayer_nodetype>` | :ref:`node_get_type<class_AnimationTreePlayer_node_get_type>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`node_rename<class_AnimationTreePlayer_node_rename>` **(** :ref:`String<class_string>` node, :ref:`String<class_string>` new_name **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`node_set_position<class_AnimationTreePlayer_node_set_position>` **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` screen_position **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_delay>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_random_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadein_time<class_AnimationTreePlayer_oneshot_node_get_fadein_time>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadeout_time<class_AnimationTreePlayer_oneshot_node_get_fadeout_time>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`oneshot_node_has_autorestart<class_AnimationTreePlayer_oneshot_node_has_autorestart>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`oneshot_node_is_active<class_AnimationTreePlayer_oneshot_node_is_active>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_autorestart<class_AnimationTreePlayer_oneshot_node_set_autorestart>` **(** :ref:`String<class_string>` id, :ref:`bool<class_bool>` enable **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_autorestart_delay<class_AnimationTreePlayer_oneshot_node_set_autorestart_delay>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` delay_sec **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_autorestart_random_delay<class_AnimationTreePlayer_oneshot_node_set_autorestart_random_delay>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` rand_sec **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_fadein_time<class_AnimationTreePlayer_oneshot_node_set_fadein_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_fadeout_time<class_AnimationTreePlayer_oneshot_node_set_fadeout_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_filter_path<class_AnimationTreePlayer_oneshot_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_start<class_AnimationTreePlayer_oneshot_node_start>` **(** :ref:`String<class_string>` id **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_stop<class_AnimationTreePlayer_oneshot_node_stop>` **(** :ref:`String<class_string>` id **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`recompute_caches<class_AnimationTreePlayer_recompute_caches>` **(** **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_node<class_AnimationTreePlayer_remove_node>` **(** :ref:`String<class_string>` id **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`reset<class_AnimationTreePlayer_reset>` **(** **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`timescale_node_get_scale<class_AnimationTreePlayer_timescale_node_get_scale>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`timescale_node_set_scale<class_AnimationTreePlayer_timescale_node_set_scale>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` scale **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`timeseek_node_seek<class_AnimationTreePlayer_timeseek_node_seek>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` seconds **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_delete_input<class_AnimationTreePlayer_transition_node_delete_input>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`transition_node_get_current<class_AnimationTreePlayer_transition_node_get_current>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`transition_node_get_input_count<class_AnimationTreePlayer_transition_node_get_input_count>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`transition_node_get_xfade_time<class_AnimationTreePlayer_transition_node_get_xfade_time>` **(** :ref:`String<class_string>` id **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`transition_node_has_input_auto_advance<class_AnimationTreePlayer_transition_node_has_input_auto_advance>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** const |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_current<class_AnimationTreePlayer_transition_node_set_current>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_input_auto_advance<class_AnimationTreePlayer_transition_node_set_input_auto_advance>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_input_count<class_AnimationTreePlayer_transition_node_set_input_count>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` count **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_xfade_time<class_AnimationTreePlayer_transition_node_set_xfade_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -154,7 +156,7 @@ Once set, Animation nodes can be added to the AnimationTreePlayer.
.. _class_AnimationTreePlayer_playback_process_mode:
- :ref:`AnimationProcessMode<enum_animationtreeplayer_animationprocessmode>` **playback_process_mode** - The thread in which to update animations. Default value: enum ANIMATION_PROCESS_IDLE.
- :ref:`AnimationProcessMode<enum_animationtreeplayer_animationprocessmode>` **playback_process_mode** - The thread in which to update animations. Default value: :ref:`ANIMATION_PROCESS_IDLE<enum_@globalscope_animation_process_idle>`.
Enums
@@ -195,7 +197,7 @@ Member Function Description
.. _class_AnimationTreePlayer_add_node:
- void **add_node** **(** :ref:`int<class_int>` type, :ref:`String<class_string>` id **)**
- void **add_node** **(** :ref:`NodeType<enum_animationtreeplayer_nodetype>` type, :ref:`String<class_string>` id **)**
Adds a ``type`` node to the graph with name ``id``.
@@ -217,6 +219,10 @@ Returns the :ref:`AnimationPlayer<class_animationplayer>`'s :ref:`Animation<clas
Returns the name of the :ref:`master_player<class_AnimationTreePlayer_master_player>`'s :ref:`Animation<class_animation>` bound to this animation node.
.. _class_AnimationTreePlayer_animation_node_get_position:
- :ref:`float<class_float>` **animation_node_get_position** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_animation_node_set_animation:
- void **animation_node_set_animation** **(** :ref:`String<class_string>` id, :ref:`Animation<class_animation>` animation **)**
@@ -309,7 +315,7 @@ The two pairs are blended like blend2 and then added together.
.. _class_AnimationTreePlayer_connect_nodes:
- :ref:`int<class_int>` **connect_nodes** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)**
- :ref:`Error<enum_@globalscope_error>` **connect_nodes** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)**
Connects node ``id`` to ``dst_id`` at the specified input slot.
@@ -365,13 +371,13 @@ Returns position of a node in the graph given its name.
.. _class_AnimationTreePlayer_node_get_type:
- :ref:`int<class_int>` **node_get_type** **(** :ref:`String<class_string>` id **)** const
- :ref:`NodeType<enum_animationtreeplayer_nodetype>` **node_get_type** **(** :ref:`String<class_string>` id **)** const
Get the node type, will return from NODE\_\* enum.
.. _class_AnimationTreePlayer_node_rename:
- :ref:`int<class_int>` **node_rename** **(** :ref:`String<class_string>` node, :ref:`String<class_string>` new_name **)**
- :ref:`Error<enum_@globalscope_error>` **node_rename** **(** :ref:`String<class_string>` node, :ref:`String<class_string>` new_name **)**
Rename a node in the graph.

View File

@@ -300,13 +300,13 @@ Return the amount of elements in the array.
- void **sort** **(** **)**
Sort the array using natural order and return reference to the array.
Sort the array using natural order.
.. _class_Array_sort_custom:
- void **sort_custom** **(** :ref:`Object<class_object>` obj, :ref:`String<class_string>` func **)**
Sort the array using a custom method and return reference to the array. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior.
Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior.
::

View File

@@ -19,49 +19,49 @@ Brief Description
Member Functions
----------------
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_blend_shape<class_ArrayMesh_add_blend_shape>` **(** :ref:`String<class_string>` name **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_surface_from_arrays<class_ArrayMesh_add_surface_from_arrays>` **(** :ref:`int<class_int>` primitive, :ref:`Array<class_array>` arrays, :ref:`Array<class_array>` blend_shapes=[ ], :ref:`int<class_int>` compress_flags=97792 **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`center_geometry<class_ArrayMesh_center_geometry>` **(** **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_blend_shapes<class_ArrayMesh_clear_blend_shapes>` **(** **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_blend_shape_count<class_ArrayMesh_get_blend_shape_count>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_blend_shape_name<class_ArrayMesh_get_blend_shape_name>` **(** :ref:`int<class_int>` index **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_surface_count<class_ArrayMesh_get_surface_count>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`lightmap_unwrap<class_ArrayMesh_lightmap_unwrap>` **(** :ref:`Transform<class_transform>` arg0, :ref:`float<class_float>` arg1 **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`regen_normalmaps<class_ArrayMesh_regen_normalmaps>` **(** **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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 |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`surface_get_arrays<class_ArrayMesh_surface_get_arrays>` **(** :ref:`int<class_int>` surf_idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`surface_get_blend_shape_arrays<class_ArrayMesh_surface_get_blend_shape_arrays>` **(** :ref:`int<class_int>` surf_idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`surface_get_format<class_ArrayMesh_surface_get_format>` **(** :ref:`int<class_int>` surf_idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Material<class_material>` | :ref:`surface_get_material<class_ArrayMesh_surface_get_material>` **(** :ref:`int<class_int>` surf_idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`surface_get_name<class_ArrayMesh_surface_get_name>` **(** :ref:`int<class_int>` surf_idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`surface_get_primitive_type<class_ArrayMesh_surface_get_primitive_type>` **(** :ref:`int<class_int>` surf_idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`surface_remove<class_ArrayMesh_surface_remove>` **(** :ref:`int<class_int>` surf_idx **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`surface_set_material<class_ArrayMesh_surface_set_material>` **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_material>` material **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`surface_set_name<class_ArrayMesh_surface_set_name>` **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_string>` name **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_blend_shape<class_ArrayMesh_add_blend_shape>` **(** :ref:`String<class_string>` name **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_surface_from_arrays<class_ArrayMesh_add_surface_from_arrays>` **(** :ref:`PrimitiveType<enum_mesh_primitivetype>` primitive, :ref:`Array<class_array>` arrays, :ref:`Array<class_array>` blend_shapes=[ ], :ref:`int<class_int>` compress_flags=97792 **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`center_geometry<class_ArrayMesh_center_geometry>` **(** **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_blend_shapes<class_ArrayMesh_clear_blend_shapes>` **(** **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_blend_shape_count<class_ArrayMesh_get_blend_shape_count>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_blend_shape_name<class_ArrayMesh_get_blend_shape_name>` **(** :ref:`int<class_int>` index **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_surface_count<class_ArrayMesh_get_surface_count>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`lightmap_unwrap<class_ArrayMesh_lightmap_unwrap>` **(** :ref:`Transform<class_transform>` arg0, :ref:`float<class_float>` arg1 **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`regen_normalmaps<class_ArrayMesh_regen_normalmaps>` **(** **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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 |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`surface_get_arrays<class_ArrayMesh_surface_get_arrays>` **(** :ref:`int<class_int>` surf_idx **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`surface_get_blend_shape_arrays<class_ArrayMesh_surface_get_blend_shape_arrays>` **(** :ref:`int<class_int>` surf_idx **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`surface_get_format<class_ArrayMesh_surface_get_format>` **(** :ref:`int<class_int>` surf_idx **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Material<class_material>` | :ref:`surface_get_material<class_ArrayMesh_surface_get_material>` **(** :ref:`int<class_int>` surf_idx **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`surface_get_name<class_ArrayMesh_surface_get_name>` **(** :ref:`int<class_int>` surf_idx **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PrimitiveType<enum_mesh_primitivetype>` | :ref:`surface_get_primitive_type<class_ArrayMesh_surface_get_primitive_type>` **(** :ref:`int<class_int>` surf_idx **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`surface_remove<class_ArrayMesh_surface_remove>` **(** :ref:`int<class_int>` surf_idx **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`surface_set_material<class_ArrayMesh_surface_set_material>` **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_material>` material **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`surface_set_name<class_ArrayMesh_surface_set_name>` **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_string>` name **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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
----------------
@@ -125,13 +125,13 @@ Member Function Description
.. _class_ArrayMesh_add_surface_from_arrays:
- void **add_surface_from_arrays** **(** :ref:`int<class_int>` primitive, :ref:`Array<class_array>` arrays, :ref:`Array<class_array>` blend_shapes=[ ], :ref:`int<class_int>` compress_flags=97792 **)**
- void **add_surface_from_arrays** **(** :ref:`PrimitiveType<enum_mesh_primitivetype>` primitive, :ref:`Array<class_array>` arrays, :ref:`Array<class_array>` blend_shapes=[ ], :ref:`int<class_int>` compress_flags=97792 **)**
Creates a new surface.
Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. See :ref:`Mesh<class_mesh>` for details. (As a note, when using indices, it is recommended to only use points, lines or triangles). :ref:`get_surface_count<class_ArrayMesh_get_surface_count>` will become the surf_idx for this new surface.
The ``arrays`` argument is an array of arrays. See enum ArrayType for the values used in this array. For example, ``arrays[0]`` is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array or be empty, except for ``ARRAY_INDEX`` if it is used.
The ``arrays`` argument is an array of arrays. See :ref:`ArrayType<enum_@globalscope_arraytype>` for the values used in this array. For example, ``arrays[0]`` is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array or be empty, except for ``ARRAY_INDEX`` if it is used.
Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data, and the index array defines the order of the vertices.
@@ -161,7 +161,7 @@ Return the amount of surfaces that the ``ArrayMesh`` holds.
.. _class_ArrayMesh_lightmap_unwrap:
- :ref:`int<class_int>` **lightmap_unwrap** **(** :ref:`Transform<class_transform>` arg0, :ref:`float<class_float>` arg1 **)**
- :ref:`Error<enum_@globalscope_error>` **lightmap_unwrap** **(** :ref:`Transform<class_transform>` arg0, :ref:`float<class_float>` arg1 **)**
.. _class_ArrayMesh_regen_normalmaps:
@@ -171,13 +171,13 @@ Return the amount of surfaces that the ``ArrayMesh`` holds.
- :ref:`int<class_int>` **surface_get_array_index_len** **(** :ref:`int<class_int>` surf_idx **)** const
Return the length in indices of the index array in the requested surface (see :ref:`add_surface<class_ArrayMesh_add_surface>`).
Return the length in indices of the index array in the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_add_surface_from_arrays>`).
.. _class_ArrayMesh_surface_get_array_len:
- :ref:`int<class_int>` **surface_get_array_len** **(** :ref:`int<class_int>` surf_idx **)** const
Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface<class_ArrayMesh_add_surface>`).
Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_add_surface_from_arrays>`).
.. _class_ArrayMesh_surface_get_arrays:
@@ -191,7 +191,7 @@ Return the length in vertices of the vertex array in the requested surface (see
- :ref:`int<class_int>` **surface_get_format** **(** :ref:`int<class_int>` surf_idx **)** const
Return the format mask of the requested surface (see :ref:`add_surface<class_ArrayMesh_add_surface>`).
Return the format mask of the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_add_surface_from_arrays>`).
.. _class_ArrayMesh_surface_get_material:
@@ -205,9 +205,9 @@ Return a :ref:`Material<class_material>` in a given surface. Surface is rendered
.. _class_ArrayMesh_surface_get_primitive_type:
- :ref:`int<class_int>` **surface_get_primitive_type** **(** :ref:`int<class_int>` surf_idx **)** const
- :ref:`PrimitiveType<enum_mesh_primitivetype>` **surface_get_primitive_type** **(** :ref:`int<class_int>` surf_idx **)** const
Return the primitive type of the requested surface (see :ref:`add_surface<class_ArrayMesh_add_surface>`).
Return the primitive type of the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_add_surface_from_arrays>`).
.. _class_ArrayMesh_surface_remove:

View File

@@ -19,19 +19,19 @@ A spatial node representing a spatially tracked controller.
Member Functions
----------------
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_controller_name<class_ARVRController_get_controller_name>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_hand<class_ARVRController_get_hand>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_is_active<class_ARVRController_get_is_active>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_joystick_axis<class_ARVRController_get_joystick_axis>` **(** :ref:`int<class_int>` axis **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_joystick_id<class_ARVRController_get_joystick_id>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`is_button_pressed<class_ARVRController_is_button_pressed>` **(** :ref:`int<class_int>` button **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_controller_name<class_ARVRController_get_controller_name>` **(** **)** const |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`TrackerHand<enum_arvrpositionaltracker_trackerhand>` | :ref:`get_hand<class_ARVRController_get_hand>` **(** **)** const |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_is_active<class_ARVRController_get_is_active>` **(** **)** const |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_joystick_axis<class_ARVRController_get_joystick_axis>` **(** :ref:`int<class_int>` axis **)** const |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_joystick_id<class_ARVRController_get_joystick_id>` **(** **)** const |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`is_button_pressed<class_ARVRController_is_button_pressed>` **(** :ref:`int<class_int>` button **)** const |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -87,7 +87,7 @@ If active, returns the name of the associated controller if provided by the AR/V
.. _class_ARVRController_get_hand:
- :ref:`int<class_int>` **get_hand** **(** **)** const
- :ref:`TrackerHand<enum_arvrpositionaltracker_trackerhand>` **get_hand** **(** **)** const
Returns the hand holding this controller, if known. See TRACKER\_\* constants in :ref:`ARVRPositionalTracker<class_arvrpositionaltracker>`.

View File

@@ -21,21 +21,21 @@ Base class for ARVR interface implementation.
Member Functions
----------------
+--------------------------------+---------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_capabilities<class_ARVRInterface_get_capabilities>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_name<class_ARVRInterface_get_name>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_render_targetsize<class_ARVRInterface_get_render_targetsize>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_tracking_status<class_ARVRInterface_get_tracking_status>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`initialize<class_ARVRInterface_initialize>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_stereo<class_ARVRInterface_is_stereo>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------+
| void | :ref:`uninitialize<class_ARVRInterface_uninitialize>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------+
+-------------------------------------------------------------+---------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_capabilities<class_ARVRInterface_get_capabilities>` **(** **)** const |
+-------------------------------------------------------------+---------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_name<class_ARVRInterface_get_name>` **(** **)** const |
+-------------------------------------------------------------+---------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_render_targetsize<class_ARVRInterface_get_render_targetsize>` **(** **)** |
+-------------------------------------------------------------+---------------------------------------------------------------------------------------+
| :ref:`Tracking_status<enum_arvrinterface_tracking_status>` | :ref:`get_tracking_status<class_ARVRInterface_get_tracking_status>` **(** **)** const |
+-------------------------------------------------------------+---------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`initialize<class_ARVRInterface_initialize>` **(** **)** |
+-------------------------------------------------------------+---------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_stereo<class_ARVRInterface_is_stereo>` **(** **)** |
+-------------------------------------------------------------+---------------------------------------------------------------------------------------+
| void | :ref:`uninitialize<class_ARVRInterface_uninitialize>` **(** **)** |
+-------------------------------------------------------------+---------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -115,7 +115,7 @@ Returns the resolution at which we should render our intermediate results before
.. _class_ARVRInterface_get_tracking_status:
- :ref:`int<class_int>` **get_tracking_status** **(** **)** const
- :ref:`Tracking_status<enum_arvrinterface_tracking_status>` **get_tracking_status** **(** **)** const
If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking.

View File

@@ -19,25 +19,25 @@ A tracked object
Member Functions
----------------
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_hand<class_ARVRPositionalTracker_get_hand>` **(** **)** const |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_joy_id<class_ARVRPositionalTracker_get_joy_id>` **(** **)** const |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_name<class_ARVRPositionalTracker_get_name>` **(** **)** const |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_basis>` | :ref:`get_orientation<class_ARVRPositionalTracker_get_orientation>` **(** **)** const |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_position<class_ARVRPositionalTracker_get_position>` **(** **)** const |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_tracks_orientation<class_ARVRPositionalTracker_get_tracks_orientation>` **(** **)** const |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_tracks_position<class_ARVRPositionalTracker_get_tracks_position>` **(** **)** const |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_transform<class_ARVRPositionalTracker_get_transform>` **(** :ref:`bool<class_bool>` adjust_by_reference_frame **)** const |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_type<class_ARVRPositionalTracker_get_type>` **(** **)** const |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TrackerHand<enum_arvrpositionaltracker_trackerhand>` | :ref:`get_hand<class_ARVRPositionalTracker_get_hand>` **(** **)** const |
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_joy_id<class_ARVRPositionalTracker_get_joy_id>` **(** **)** const |
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_name<class_ARVRPositionalTracker_get_name>` **(** **)** const |
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_basis>` | :ref:`get_orientation<class_ARVRPositionalTracker_get_orientation>` **(** **)** const |
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_position<class_ARVRPositionalTracker_get_position>` **(** **)** const |
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_tracks_orientation<class_ARVRPositionalTracker_get_tracks_orientation>` **(** **)** const |
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_tracks_position<class_ARVRPositionalTracker_get_tracks_position>` **(** **)** const |
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_transform<class_ARVRPositionalTracker_get_transform>` **(** :ref:`bool<class_bool>` adjust_by_reference_frame **)** const |
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TrackerType<enum_arvrserver_trackertype>` | :ref:`get_type<class_ARVRPositionalTracker_get_type>` **(** **)** const |
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -73,7 +73,7 @@ Member Function Description
.. _class_ARVRPositionalTracker_get_hand:
- :ref:`int<class_int>` **get_hand** **(** **)** const
- :ref:`TrackerHand<enum_arvrpositionaltracker_trackerhand>` **get_hand** **(** **)** const
Returns the hand holding this tracker, if known. See TRACKER\_\* constants.
@@ -121,7 +121,7 @@ Returns the transform combining this device's orientation and position.
.. _class_ARVRPositionalTracker_get_type:
- :ref:`int<class_int>` **get_type** **(** **)** const
- :ref:`TrackerType<enum_arvrserver_trackertype>` **get_type** **(** **)** const
Returns the tracker's type.

View File

@@ -19,31 +19,31 @@ This is our AR/VR Server.
Member Functions
----------------
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`center_on_hmd<class_ARVRServer_center_on_hmd>` **(** :ref:`int<class_int>` rotation_mode, :ref:`bool<class_bool>` keep_height **)** |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ARVRInterface<class_arvrinterface>` | :ref:`find_interface<class_ARVRServer_find_interface>` **(** :ref:`String<class_string>` name **)** const |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_hmd_transform<class_ARVRServer_get_hmd_transform>` **(** **)** |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ARVRInterface<class_arvrinterface>` | :ref:`get_interface<class_ARVRServer_get_interface>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_interface_count<class_ARVRServer_get_interface_count>` **(** **)** const |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_interfaces<class_ARVRServer_get_interfaces>` **(** **)** const |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_last_commit_usec<class_ARVRServer_get_last_commit_usec>` **(** **)** |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_last_frame_usec<class_ARVRServer_get_last_frame_usec>` **(** **)** |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_last_process_usec<class_ARVRServer_get_last_process_usec>` **(** **)** |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_reference_frame<class_ARVRServer_get_reference_frame>` **(** **)** const |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ARVRPositionalTracker<class_arvrpositionaltracker>` | :ref:`get_tracker<class_ARVRServer_get_tracker>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_tracker_count<class_ARVRServer_get_tracker_count>` **(** **)** const |
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`center_on_hmd<class_ARVRServer_center_on_hmd>` **(** :ref:`RotationMode<enum_arvrserver_rotationmode>` rotation_mode, :ref:`bool<class_bool>` keep_height **)** |
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ARVRInterface<class_arvrinterface>` | :ref:`find_interface<class_ARVRServer_find_interface>` **(** :ref:`String<class_string>` name **)** const |
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_hmd_transform<class_ARVRServer_get_hmd_transform>` **(** **)** |
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ARVRInterface<class_arvrinterface>` | :ref:`get_interface<class_ARVRServer_get_interface>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_interface_count<class_ARVRServer_get_interface_count>` **(** **)** const |
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_interfaces<class_ARVRServer_get_interfaces>` **(** **)** const |
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_last_commit_usec<class_ARVRServer_get_last_commit_usec>` **(** **)** |
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_last_frame_usec<class_ARVRServer_get_last_frame_usec>` **(** **)** |
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_last_process_usec<class_ARVRServer_get_last_process_usec>` **(** **)** |
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_reference_frame<class_ARVRServer_get_reference_frame>` **(** **)** const |
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ARVRPositionalTracker<class_arvrpositionaltracker>` | :ref:`get_tracker<class_ARVRServer_get_tracker>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_tracker_count<class_ARVRServer_get_tracker_count>` **(** **)** const |
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -118,7 +118,7 @@ Member Function Description
.. _class_ARVRServer_center_on_hmd:
- void **center_on_hmd** **(** :ref:`int<class_int>` rotation_mode, :ref:`bool<class_bool>` keep_height **)**
- void **center_on_hmd** **(** :ref:`RotationMode<enum_arvrserver_rotationmode>` rotation_mode, :ref:`bool<class_bool>` keep_height **)**
This is a really important function to understand correctly. AR and VR platforms all handle positioning slightly differently.

View File

@@ -19,79 +19,79 @@ Server interface for low level audio access.
Member Functions
----------------
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_bus<class_AudioServer_add_bus>` **(** :ref:`int<class_int>` at_position=-1 **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_bus_effect<class_AudioServer_add_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`AudioEffect<class_audioeffect>` effect, :ref:`int<class_int>` at_position=-1 **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AudioBusLayout<class_audiobuslayout>` | :ref:`generate_bus_layout<class_AudioServer_generate_bus_layout>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bus_count<class_AudioServer_get_bus_count>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AudioEffect<class_audioeffect>` | :ref:`get_bus_effect<class_AudioServer_get_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bus_effect_count<class_AudioServer_get_bus_effect_count>` **(** :ref:`int<class_int>` bus_idx **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bus_index<class_AudioServer_get_bus_index>` **(** :ref:`String<class_string>` bus_name **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_bus_name<class_AudioServer_get_bus_name>` **(** :ref:`int<class_int>` bus_idx **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bus_peak_volume_left_db<class_AudioServer_get_bus_peak_volume_left_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bus_peak_volume_right_db<class_AudioServer_get_bus_peak_volume_right_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_bus_send<class_AudioServer_get_bus_send>` **(** :ref:`int<class_int>` bus_idx **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bus_volume_db<class_AudioServer_get_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_device<class_AudioServer_get_device>` **(** **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_device_list<class_AudioServer_get_device_list>` **(** **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_mix_rate<class_AudioServer_get_mix_rate>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_speaker_mode<class_AudioServer_get_speaker_mode>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_bus_bypassing_effects<class_AudioServer_is_bus_bypassing_effects>` **(** :ref:`int<class_int>` bus_idx **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_bus_effect_enabled<class_AudioServer_is_bus_effect_enabled>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_bus_mute<class_AudioServer_is_bus_mute>` **(** :ref:`int<class_int>` bus_idx **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_bus_solo<class_AudioServer_is_bus_solo>` **(** :ref:`int<class_int>` bus_idx **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`lock<class_AudioServer_lock>` **(** **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`move_bus<class_AudioServer_move_bus>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` to_index **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_bus<class_AudioServer_remove_bus>` **(** :ref:`int<class_int>` index **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_bus_effect<class_AudioServer_remove_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_bypass_effects<class_AudioServer_set_bus_bypass_effects>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_count<class_AudioServer_set_bus_count>` **(** :ref:`int<class_int>` amount **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_effect_enabled<class_AudioServer_set_bus_effect_enabled>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_layout<class_AudioServer_set_bus_layout>` **(** :ref:`AudioBusLayout<class_audiobuslayout>` bus_layout **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_mute<class_AudioServer_set_bus_mute>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_name<class_AudioServer_set_bus_name>` **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_string>` name **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_send<class_AudioServer_set_bus_send>` **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_string>` send **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_solo<class_AudioServer_set_bus_solo>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_volume_db<class_AudioServer_set_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`float<class_float>` volume_db **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_device<class_AudioServer_set_device>` **(** :ref:`String<class_string>` arg0 **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`swap_bus_effects<class_AudioServer_swap_bus_effects>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` by_effect_idx **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unlock<class_AudioServer_unlock>` **(** **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_bus<class_AudioServer_add_bus>` **(** :ref:`int<class_int>` at_position=-1 **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_bus_effect<class_AudioServer_add_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`AudioEffect<class_audioeffect>` effect, :ref:`int<class_int>` at_position=-1 **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AudioBusLayout<class_audiobuslayout>` | :ref:`generate_bus_layout<class_AudioServer_generate_bus_layout>` **(** **)** const |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bus_count<class_AudioServer_get_bus_count>` **(** **)** const |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AudioEffect<class_audioeffect>` | :ref:`get_bus_effect<class_AudioServer_get_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bus_effect_count<class_AudioServer_get_bus_effect_count>` **(** :ref:`int<class_int>` bus_idx **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bus_index<class_AudioServer_get_bus_index>` **(** :ref:`String<class_string>` bus_name **)** const |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_bus_name<class_AudioServer_get_bus_name>` **(** :ref:`int<class_int>` bus_idx **)** const |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bus_peak_volume_left_db<class_AudioServer_get_bus_peak_volume_left_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bus_peak_volume_right_db<class_AudioServer_get_bus_peak_volume_right_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_bus_send<class_AudioServer_get_bus_send>` **(** :ref:`int<class_int>` bus_idx **)** const |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bus_volume_db<class_AudioServer_get_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx **)** const |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_device<class_AudioServer_get_device>` **(** **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_device_list<class_AudioServer_get_device_list>` **(** **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_mix_rate<class_AudioServer_get_mix_rate>` **(** **)** const |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`SpeakerMode<enum_audioserver_speakermode>` | :ref:`get_speaker_mode<class_AudioServer_get_speaker_mode>` **(** **)** const |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_bus_bypassing_effects<class_AudioServer_is_bus_bypassing_effects>` **(** :ref:`int<class_int>` bus_idx **)** const |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_bus_effect_enabled<class_AudioServer_is_bus_effect_enabled>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** const |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_bus_mute<class_AudioServer_is_bus_mute>` **(** :ref:`int<class_int>` bus_idx **)** const |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_bus_solo<class_AudioServer_is_bus_solo>` **(** :ref:`int<class_int>` bus_idx **)** const |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`lock<class_AudioServer_lock>` **(** **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`move_bus<class_AudioServer_move_bus>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` to_index **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_bus<class_AudioServer_remove_bus>` **(** :ref:`int<class_int>` index **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_bus_effect<class_AudioServer_remove_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_bypass_effects<class_AudioServer_set_bus_bypass_effects>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_count<class_AudioServer_set_bus_count>` **(** :ref:`int<class_int>` amount **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_effect_enabled<class_AudioServer_set_bus_effect_enabled>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`bool<class_bool>` enabled **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_layout<class_AudioServer_set_bus_layout>` **(** :ref:`AudioBusLayout<class_audiobuslayout>` bus_layout **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_mute<class_AudioServer_set_bus_mute>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_name<class_AudioServer_set_bus_name>` **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_string>` name **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_send<class_AudioServer_set_bus_send>` **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_string>` send **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_solo<class_AudioServer_set_bus_solo>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_volume_db<class_AudioServer_set_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`float<class_float>` volume_db **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_device<class_AudioServer_set_device>` **(** :ref:`String<class_string>` arg0 **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`swap_bus_effects<class_AudioServer_swap_bus_effects>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` by_effect_idx **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unlock<class_AudioServer_unlock>` **(** **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -211,7 +211,7 @@ Returns the sample rate at the output of the audioserver.
.. _class_AudioServer_get_speaker_mode:
- :ref:`int<class_int>` **get_speaker_mode** **(** **)** const
- :ref:`SpeakerMode<enum_audioserver_speakermode>` **get_speaker_mode** **(** **)** const
Returns the speaker configuration.

View File

@@ -19,6 +19,10 @@ OGG Vorbis audio stream driver.
Member Variables
----------------
.. _class_AudioStreamOGGVorbis_data:
- :ref:`PoolByteArray<class_poolbytearray>` **data** - Contains the audio data in bytes.
.. _class_AudioStreamOGGVorbis_loop:
- :ref:`bool<class_bool>` **loop**

View File

@@ -19,6 +19,10 @@ Plays audio.
Member Variables
----------------
.. _class_AudioStreamSample_data:
- :ref:`PoolByteArray<class_poolbytearray>` **data** - Contains the audio data in bytes.
.. _class_AudioStreamSample_format:
- :ref:`Format<enum_audiostreamsample_format>` **format** - Audio format. See FORMAT\_\* constants for values.

View File

@@ -19,11 +19,11 @@ Brief Description
Member Functions
----------------
+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`bake<class_BakedLightmap_bake>` **(** :ref:`Node<class_node>` from_node=null, :ref:`bool<class_bool>` create_visual_debug=false **)** |
+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`debug_bake<class_BakedLightmap_debug_bake>` **(** **)** |
+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BakeError<enum_bakedlightmap_bakeerror>` | :ref:`bake<class_BakedLightmap_bake>` **(** :ref:`Node<class_node>` from_node=null, :ref:`bool<class_bool>` create_visual_debug=false **)** |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`debug_bake<class_BakedLightmap_debug_bake>` **(** **)** |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -103,7 +103,7 @@ Member Function Description
.. _class_BakedLightmap_bake:
- :ref:`int<class_int>` **bake** **(** :ref:`Node<class_node>` from_node=null, :ref:`bool<class_bool>` create_visual_debug=false **)**
- :ref:`BakeError<enum_bakedlightmap_bakeerror>` **bake** **(** :ref:`Node<class_node>` from_node=null, :ref:`bool<class_bool>` create_visual_debug=false **)**
.. _class_BakedLightmap_debug_bake:

View File

@@ -21,15 +21,15 @@ Base class for different kinds of buttons.
Member Functions
----------------
+--------------------------+-------------------------------------------------------------------------------------------------------+
| void | :ref:`_pressed<class_BaseButton__pressed>` **(** **)** virtual |
+--------------------------+-------------------------------------------------------------------------------------------------------+
| void | :ref:`_toggled<class_BaseButton__toggled>` **(** :ref:`bool<class_bool>` button_pressed **)** virtual |
+--------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_draw_mode<class_BaseButton_get_draw_mode>` **(** **)** const |
+--------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_hovered<class_BaseButton_is_hovered>` **(** **)** const |
+--------------------------+-------------------------------------------------------------------------------------------------------+
+--------------------------------------------+-------------------------------------------------------------------------------------------------------+
| void | :ref:`_pressed<class_BaseButton__pressed>` **(** **)** virtual |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------+
| void | :ref:`_toggled<class_BaseButton__toggled>` **(** :ref:`bool<class_bool>` button_pressed **)** virtual |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`DrawMode<enum_basebutton_drawmode>` | :ref:`get_draw_mode<class_BaseButton_get_draw_mode>` **(** **)** const |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_hovered<class_BaseButton_is_hovered>` **(** **)** const |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -139,7 +139,7 @@ Called when the button is toggled (only if toggle_mode is active).
.. _class_BaseButton_get_draw_mode:
- :ref:`int<class_int>` **get_draw_mode** **(** **)** const
- :ref:`DrawMode<enum_basebutton_drawmode>` **get_draw_mode** **(** **)** const
Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW\_\* enum.

View File

@@ -42,6 +42,8 @@ Member Functions
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_basis>` | :ref:`scaled<class_Basis_scaled>` **(** :ref:`Vector3<class_vector3>` scale **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_basis>` | :ref:`slerp<class_Basis_slerp>` **(** :ref:`Basis<class_basis>` b, :ref:`float<class_float>` t **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tdotx<class_Basis_tdotx>` **(** :ref:`Vector3<class_vector3>` with **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tdoty<class_Basis_tdoty>` **(** :ref:`Vector3<class_vector3>` with **)** |
@@ -74,7 +76,7 @@ Member Variables
Description
-----------
3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z as its columns, which can be interpreted as the local basis vectors of a transformation. Can also be accessed as array of 3D vectors. These vectors are orthogonal to each other, but are not necessarily normalized. Almost always used as orthogonal basis for a :ref:`Transform<class_transform>`.
3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z as its columns, which can be interpreted as the local basis vectors of a transformation. Can also be accessed as array of 3D vectors. These vectors are orthogonal to each other, but are not necessarily normalized (due to scaling). Almost always used as orthogonal basis for a :ref:`Transform<class_transform>`.
For such use, it is composed of a scaling and a rotation matrix, in that order (M = R.S).
@@ -145,13 +147,19 @@ Return the orthonormalized version of the matrix (useful to call from time to ti
- :ref:`Basis<class_basis>` **rotated** **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)**
Introduce an additional rotation around the given axis by phi (radians). Only relevant when the matrix is being used as a part of :ref:`Transform<class_transform>`. The axis must be a normalized vector.
Introduce an additional rotation around the given axis by phi (radians). The axis must be a normalized vector.
.. _class_Basis_scaled:
- :ref:`Basis<class_basis>` **scaled** **(** :ref:`Vector3<class_vector3>` scale **)**
Introduce an additional scaling specified by the given 3D scaling factor. Only relevant when the matrix is being used as a part of :ref:`Transform<class_transform>`.
Introduce an additional scaling specified by the given 3D scaling factor.
.. _class_Basis_slerp:
- :ref:`Basis<class_basis>` **slerp** **(** :ref:`Basis<class_basis>` b, :ref:`float<class_float>` t **)**
Assuming that the matrix is a proper rotation matrix, slerp performs a spherical-linear interpolation with another rotation matrix.
.. _class_Basis_tdotx:

View File

@@ -19,25 +19,25 @@ Renders text using ``*.fnt`` fonts.
Member Functions
----------------
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_char<class_BitmapFont_add_char>` **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Vector2<class_vector2>` align=Vector2( 0, 0 ), :ref:`float<class_float>` advance=-1 **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_kerning_pair<class_BitmapFont_add_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b, :ref:`int<class_int>` kerning **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_texture<class_BitmapFont_add_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_BitmapFont_clear>` **(** **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`create_from_fnt<class_BitmapFont_create_from_fnt>` **(** :ref:`String<class_string>` path **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_char_size<class_BitmapFont_get_char_size>` **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_kerning_pair<class_BitmapFont_get_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_BitmapFont_get_texture>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_texture_count<class_BitmapFont_get_texture_count>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_char<class_BitmapFont_add_char>` **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Vector2<class_vector2>` align=Vector2( 0, 0 ), :ref:`float<class_float>` advance=-1 **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_kerning_pair<class_BitmapFont_add_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b, :ref:`int<class_int>` kerning **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_texture<class_BitmapFont_add_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_BitmapFont_clear>` **(** **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`create_from_fnt<class_BitmapFont_create_from_fnt>` **(** :ref:`String<class_string>` path **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_char_size<class_BitmapFont_get_char_size>` **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_kerning_pair<class_BitmapFont_get_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_BitmapFont_get_texture>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_texture_count<class_BitmapFont_get_texture_count>` **(** **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -93,7 +93,7 @@ Clears all the font data and settings.
.. _class_BitmapFont_create_from_fnt:
- :ref:`int<class_int>` **create_from_fnt** **(** :ref:`String<class_string>` path **)**
- :ref:`Error<enum_@globalscope_error>` **create_from_fnt** **(** :ref:`String<class_string>` path **)**
Creates a BitmapFont from the ``*.fnt`` file at ``path``.

57
classes/class_bone2d.rst Normal file
View File

@@ -0,0 +1,57 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Bone2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_Bone2D:
Bone2D
======
**Inherits:** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+----------------------------------------+------------------------------------------------------------------------------------+
| void | :ref:`apply_rest<class_Bone2D_apply_rest>` **(** **)** |
+----------------------------------------+------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_index_in_skeleton<class_Bone2D_get_index_in_skeleton>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`get_skeleton_rest<class_Bone2D_get_skeleton_rest>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_Bone2D_default_length:
- :ref:`float<class_float>` **default_length**
.. _class_Bone2D_rest:
- :ref:`Transform2D<class_transform2d>` **rest**
Member Function Description
---------------------------
.. _class_Bone2D_apply_rest:
- void **apply_rest** **(** **)**
.. _class_Bone2D_get_index_in_skeleton:
- :ref:`int<class_int>` **get_index_in_skeleton** **(** **)** const
.. _class_Bone2D_get_skeleton_rest:
- :ref:`Transform2D<class_transform2d>` **get_skeleton_rest** **(** **)** const

View File

@@ -196,6 +196,7 @@ enum **BlendMode**
- **BLEND_MODE_SUB** = **2** --- Subtractive blending mode.
- **BLEND_MODE_MUL** = **3** --- Multiplicative blending mode.
- **BLEND_MODE_PREMULT_ALPHA** = **4** --- Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value.
- **BLEND_MODE_DISABLED** = **5** --- Disable blending mode. Colors including alpha are written as is. Only applicable for render targets with a transparent background. No lighting will be applied.
Description

View File

@@ -48,7 +48,6 @@ enum **BlendMode**
- **BLEND_MODE_SUB** = **2** --- Subtractive blending mode.
- **BLEND_MODE_MUL** = **3** --- Multiplicative blending mode.
- **BLEND_MODE_PREMULT_ALPHA** = **4** --- Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value.
- **BLEND_MODE_DISABLED** = **5** --- Disable blending mode. Colors including alpha are written as is. Only applicable for render targets with a transparent background. No lighting will be applied.
Description

View File

@@ -46,7 +46,7 @@ Member Functions
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`class_has_signal<class_ClassDB_class_has_signal>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`class_set_property<class_ClassDB_class_set_property>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** const |
| :ref:`Error<enum_@globalscope_error>` | :ref:`class_set_property<class_ClassDB_class_set_property>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_class_list<class_ClassDB_get_class_list>` **(** **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -127,7 +127,7 @@ Returns the 'signal' data of 'class' or its ancestry. The returned value is a :r
- :ref:`Array<class_array>` **class_get_signal_list** **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a :ref:`Dictionary<class_dictionary>` as described in class_get_signal.
Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a :ref:`Dictionary<class_dictionary>` as described in :ref:`class_get_signal<class_ClassDB_class_get_signal>`.
.. _class_ClassDB_class_has_integer_constant:
@@ -149,7 +149,7 @@ Return whether 'class' or its ancestry has a signal called 'signal' or not.
.. _class_ClassDB_class_set_property:
- :ref:`int<class_int>` **class_set_property** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** const
- :ref:`Error<enum_@globalscope_error>` **class_set_property** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** const
Sets 'property' value of 'class' to 'value'.

View File

@@ -199,11 +199,11 @@ Returns a new color resulting from making this color darker by the specified per
- :ref:`Color<class_color>` **from_hsv** **(** :ref:`float<class_float>` h, :ref:`float<class_float>` s, :ref:`float<class_float>` v, :ref:`float<class_float>` a=1 **)**
Constructs a color from an HSV profile. ``h`` is a value between 0 and 360. ``s`` and ``v`` are values between 0 and 1.
Constructs a color from an HSV profile. ``h``, ``s``, and ``v`` are values between 0 and 1.
::
var c = Color.from_hsv(210, 0.5, 0.79, 0.8) # equivalent to HSV(210, 50, 79, 0.8) or Color8(100, 151, 201, 0.8)
var c = Color.from_hsv(0.58, 0.5, 0.79, 0.8) # equivalent to HSV(210, 50, 79, 0.8) or Color8(100, 151, 201, 0.8)
.. _class_Color_gray:

View File

@@ -19,11 +19,11 @@ Button that pops out a :ref:`ColorPicker<class_colorpicker>`.
Member Functions
----------------
+----------------------------------------+-------------------------------------------------------------------------+
| :ref:`ColorPicker<class_colorpicker>` | :ref:`get_picker<class_ColorPickerButton_get_picker>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------+
| :ref:`PopupPanel<class_popuppanel>` | :ref:`get_popup<class_ColorPickerButton_get_popup>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------+
+----------------------------------------+-----------------------------------------------------------------------+
| :ref:`ColorPicker<class_colorpicker>` | :ref:`get_picker<class_ColorPickerButton_get_picker>` **(** **)** |
+----------------------------------------+-----------------------------------------------------------------------+
| :ref:`PopupPanel<class_popuppanel>` | :ref:`get_popup<class_ColorPickerButton_get_popup>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------+
Signals
-------
@@ -34,6 +34,10 @@ Signals
Emitted when the color changes.
.. _class_ColorPickerButton_popup_closed:
- **popup_closed** **(** **)**
Member Variables
----------------
@@ -57,7 +61,7 @@ Member Function Description
.. _class_ColorPickerButton_get_picker:
- :ref:`ColorPicker<class_colorpicker>` **get_picker** **(** **)** const
- :ref:`ColorPicker<class_colorpicker>` **get_picker** **(** **)**
Returns the ``ColorPicker`` that this ``ColorPickerButton`` toggles.

View File

@@ -32,9 +32,9 @@ Member Functions
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_section_key<class_ConfigFile_has_section_key>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key **)** const |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`load<class_ConfigFile_load>` **(** :ref:`String<class_string>` path **)** |
| :ref:`Error<enum_@globalscope_error>` | :ref:`load<class_ConfigFile_load>` **(** :ref:`String<class_string>` path **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`save<class_ConfigFile_save>` **(** :ref:`String<class_string>` path **)** |
| :ref:`Error<enum_@globalscope_error>` | :ref:`save<class_ConfigFile_save>` **(** :ref:`String<class_string>` path **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_value<class_ConfigFile_set_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, :ref:`Variant<class_variant>` value **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -109,13 +109,13 @@ Returns ``true`` if the specified section-key pair exists.
.. _class_ConfigFile_load:
- :ref:`int<class_int>` **load** **(** :ref:`String<class_string>` path **)**
- :ref:`Error<enum_@globalscope_error>` **load** **(** :ref:`String<class_string>` path **)**
Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the ``OK``, ``FAILED`` or ``ERR_*`` constants listed in :ref:`@GlobalScope<class_@globalscope>`. If the load was successful, the return value is ``OK``.
.. _class_ConfigFile_save:
- :ref:`int<class_int>` **save** **(** :ref:`String<class_string>` path **)**
- :ref:`Error<enum_@globalscope_error>` **save** **(** :ref:`String<class_string>` path **)**
Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the ``OK``, ``FAILED`` or ``ERR_*`` constants listed in :ref:`@GlobalScope<class_@globalscope>`. If the load was successful, the return value is ``OK``.

View File

@@ -9,7 +9,7 @@ Container
**Inherits:** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Inherited By:** :ref:`PanelContainer<class_panelcontainer>`, :ref:`GridContainer<class_gridcontainer>`, :ref:`ScrollContainer<class_scrollcontainer>`, :ref:`ViewportContainer<class_viewportcontainer>`, :ref:`MarginContainer<class_margincontainer>`, :ref:`CenterContainer<class_centercontainer>`, :ref:`GraphNode<class_graphnode>`, :ref:`SplitContainer<class_splitcontainer>`, :ref:`BoxContainer<class_boxcontainer>`
**Inherited By:** :ref:`PanelContainer<class_panelcontainer>`, :ref:`GridContainer<class_gridcontainer>`, :ref:`ScrollContainer<class_scrollcontainer>`, :ref:`ViewportContainer<class_viewportcontainer>`, :ref:`MarginContainer<class_margincontainer>`, :ref:`CenterContainer<class_centercontainer>`, :ref:`GraphNode<class_graphnode>`, :ref:`SplitContainer<class_splitcontainer>`, :ref:`BoxContainer<class_boxcontainer>`, :ref:`EditorProperty<class_editorproperty>`
**Category:** Core

View File

@@ -21,125 +21,125 @@ All User Interface nodes inherit from Control. Features anchors and margins to a
Member Functions
----------------
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`_get_minimum_size<class_Control__get_minimum_size>` **(** **)** virtual |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_gui_input<class_Control__gui_input>` **(** :ref:`InputEvent<class_inputevent>` event **)** virtual |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`accept_event<class_Control_accept_event>` **(** **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_color_override<class_Control_add_color_override>` **(** :ref:`String<class_string>` name, :ref:`Color<class_color>` color **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_constant_override<class_Control_add_constant_override>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` constant **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_font_override<class_Control_add_font_override>` **(** :ref:`String<class_string>` name, :ref:`Font<class_font>` font **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_icon_override<class_Control_add_icon_override>` **(** :ref:`String<class_string>` name, :ref:`Texture<class_texture>` texture **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_shader_override<class_Control_add_shader_override>` **(** :ref:`String<class_string>` name, :ref:`Shader<class_shader>` shader **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_stylebox_override<class_Control_add_stylebox_override>` **(** :ref:`String<class_string>` name, :ref:`StyleBox<class_stylebox>` stylebox **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`can_drop_data<class_Control_can_drop_data>` **(** :ref:`Vector2<class_vector2>` position, :ref:`Variant<class_variant>` data **)** virtual |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`drop_data<class_Control_drop_data>` **(** :ref:`Vector2<class_vector2>` position, :ref:`Variant<class_variant>` data **)** virtual |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`force_drag<class_Control_force_drag>` **(** :ref:`Variant<class_variant>` data, :ref:`Control<class_control>` preview **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_begin<class_Control_get_begin>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_color<class_Control_get_color>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_combined_minimum_size<class_Control_get_combined_minimum_size>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_constant<class_Control_get_constant>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cursor_shape<class_Control_get_cursor_shape>` **(** :ref:`Vector2<class_vector2>` position=Vector2( 0, 0 ) **)** 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:`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:`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 |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_minimum_size<class_Control_get_minimum_size>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_parent_area_size<class_Control_get_parent_area_size>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Control<class_control>` | :ref:`get_parent_control<class_Control_get_parent_control>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_rect<class_Control_get_rect>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rotation<class_Control_get_rotation>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StyleBox<class_stylebox>` | :ref:`get_stylebox<class_Control_get_stylebox>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_tooltip<class_Control_get_tooltip>` **(** :ref:`Vector2<class_vector2>` at_position=Vector2( 0, 0 ) **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`grab_click_focus<class_Control_grab_click_focus>` **(** **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`grab_focus<class_Control_grab_focus>` **(** **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_color<class_Control_has_color>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_color_override<class_Control_has_color_override>` **(** :ref:`String<class_string>` name **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_constant<class_Control_has_constant>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_constant_override<class_Control_has_constant_override>` **(** :ref:`String<class_string>` name **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_focus<class_Control_has_focus>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_font<class_Control_has_font>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_font_override<class_Control_has_font_override>` **(** :ref:`String<class_string>` name **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_icon<class_Control_has_icon>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_icon_override<class_Control_has_icon_override>` **(** :ref:`String<class_string>` name **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_point<class_Control_has_point>` **(** :ref:`Vector2<class_vector2>` point **)** virtual |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_shader_override<class_Control_has_shader_override>` **(** :ref:`String<class_string>` name **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_stylebox<class_Control_has_stylebox>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_stylebox_override<class_Control_has_stylebox_override>` **(** :ref:`String<class_string>` name **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`minimum_size_changed<class_Control_minimum_size_changed>` **(** **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`release_focus<class_Control_release_focus>` **(** **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_anchor<class_Control_set_anchor>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` anchor, :ref:`bool<class_bool>` keep_margin=false, :ref:`bool<class_bool>` push_opposite_anchor=true **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_anchor_and_margin<class_Control_set_anchor_and_margin>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` anchor, :ref:`float<class_float>` offset, :ref:`bool<class_bool>` push_opposite_anchor=false **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_anchors_and_margins_preset<class_Control_set_anchors_and_margins_preset>` **(** :ref:`int<class_int>` preset, :ref:`int<class_int>` resize_mode=0, :ref:`int<class_int>` margin=0 **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_anchors_preset<class_Control_set_anchors_preset>` **(** :ref:`int<class_int>` preset, :ref:`bool<class_bool>` keep_margin=false **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_begin<class_Control_set_begin>` **(** :ref:`Vector2<class_vector2>` position **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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_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 **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`show_modal<class_Control_show_modal>` **(** :ref:`bool<class_bool>` exclusive=false **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`warp_mouse<class_Control_warp_mouse>` **(** :ref:`Vector2<class_vector2>` to_position **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`_get_minimum_size<class_Control__get_minimum_size>` **(** **)** virtual |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_gui_input<class_Control__gui_input>` **(** :ref:`InputEvent<class_inputevent>` event **)** virtual |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`accept_event<class_Control_accept_event>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_color_override<class_Control_add_color_override>` **(** :ref:`String<class_string>` name, :ref:`Color<class_color>` color **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_constant_override<class_Control_add_constant_override>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` constant **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_font_override<class_Control_add_font_override>` **(** :ref:`String<class_string>` name, :ref:`Font<class_font>` font **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_icon_override<class_Control_add_icon_override>` **(** :ref:`String<class_string>` name, :ref:`Texture<class_texture>` texture **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_shader_override<class_Control_add_shader_override>` **(** :ref:`String<class_string>` name, :ref:`Shader<class_shader>` shader **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_stylebox_override<class_Control_add_stylebox_override>` **(** :ref:`String<class_string>` name, :ref:`StyleBox<class_stylebox>` stylebox **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`can_drop_data<class_Control_can_drop_data>` **(** :ref:`Vector2<class_vector2>` position, :ref:`Variant<class_variant>` data **)** virtual |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`drop_data<class_Control_drop_data>` **(** :ref:`Vector2<class_vector2>` position, :ref:`Variant<class_variant>` data **)** virtual |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`force_drag<class_Control_force_drag>` **(** :ref:`Variant<class_variant>` data, :ref:`Control<class_control>` preview **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_begin<class_Control_get_begin>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_color<class_Control_get_color>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_combined_minimum_size<class_Control_get_combined_minimum_size>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_constant<class_Control_get_constant>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`CursorShape<enum_control_cursorshape>` | :ref:`get_cursor_shape<class_Control_get_cursor_shape>` **(** :ref:`Vector2<class_vector2>` position=Vector2( 0, 0 ) **)** 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:`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:`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 |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_minimum_size<class_Control_get_minimum_size>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_parent_area_size<class_Control_get_parent_area_size>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Control<class_control>` | :ref:`get_parent_control<class_Control_get_parent_control>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_rect<class_Control_get_rect>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rotation<class_Control_get_rotation>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StyleBox<class_stylebox>` | :ref:`get_stylebox<class_Control_get_stylebox>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_tooltip<class_Control_get_tooltip>` **(** :ref:`Vector2<class_vector2>` at_position=Vector2( 0, 0 ) **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`grab_click_focus<class_Control_grab_click_focus>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`grab_focus<class_Control_grab_focus>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_color<class_Control_has_color>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_color_override<class_Control_has_color_override>` **(** :ref:`String<class_string>` name **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_constant<class_Control_has_constant>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_constant_override<class_Control_has_constant_override>` **(** :ref:`String<class_string>` name **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_focus<class_Control_has_focus>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_font<class_Control_has_font>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_font_override<class_Control_has_font_override>` **(** :ref:`String<class_string>` name **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_icon<class_Control_has_icon>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_icon_override<class_Control_has_icon_override>` **(** :ref:`String<class_string>` name **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_point<class_Control_has_point>` **(** :ref:`Vector2<class_vector2>` point **)** virtual |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_shader_override<class_Control_has_shader_override>` **(** :ref:`String<class_string>` name **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_stylebox<class_Control_has_stylebox>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_stylebox_override<class_Control_has_stylebox_override>` **(** :ref:`String<class_string>` name **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`minimum_size_changed<class_Control_minimum_size_changed>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`release_focus<class_Control_release_focus>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_anchor<class_Control_set_anchor>` **(** :ref:`Margin<enum_@globalscope_margin>` margin, :ref:`float<class_float>` anchor, :ref:`bool<class_bool>` keep_margin=false, :ref:`bool<class_bool>` push_opposite_anchor=true **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_anchor_and_margin<class_Control_set_anchor_and_margin>` **(** :ref:`Margin<enum_@globalscope_margin>` margin, :ref:`float<class_float>` anchor, :ref:`float<class_float>` offset, :ref:`bool<class_bool>` push_opposite_anchor=false **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_anchors_and_margins_preset<class_Control_set_anchors_and_margins_preset>` **(** :ref:`LayoutPreset<enum_control_layoutpreset>` preset, :ref:`LayoutPresetMode<enum_control_layoutpresetmode>` resize_mode=0, :ref:`int<class_int>` margin=0 **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_anchors_preset<class_Control_set_anchors_preset>` **(** :ref:`LayoutPreset<enum_control_layoutpreset>` preset, :ref:`bool<class_bool>` keep_margin=false **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_begin<class_Control_set_begin>` **(** :ref:`Vector2<class_vector2>` position **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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_margins_preset<class_Control_set_margins_preset>` **(** :ref:`LayoutPreset<enum_control_layoutpreset>` preset, :ref:`LayoutPresetMode<enum_control_layoutpresetmode>` resize_mode=0, :ref:`int<class_int>` margin=0 **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotation<class_Control_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`show_modal<class_Control_show_modal>` **(** :ref:`bool<class_bool>` exclusive=false **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`warp_mouse<class_Control_warp_mouse>` **(** :ref:`Vector2<class_vector2>` to_position **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -489,37 +489,37 @@ Marks an input event as handled. Once you accept an input event, it stops propag
- void **add_color_override** **(** :ref:`String<class_string>` name, :ref:`Color<class_color>` color **)**
Overrides the color in the theme resource the node uses.
Overrides the color in the :ref:`theme<class_Control_theme>` resource the node uses.
.. _class_Control_add_constant_override:
- void **add_constant_override** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` constant **)**
Overrides an integer constant in the :ref:`Theme<class_theme>` resource the node uses. If the ``constant`` is invalid, Godot clears the override. See :ref:`Theme.INVALID_CONSTANT<class_Theme_INVALID_CONSTANT>` for more information.
Overrides an integer constant in the :ref:`theme<class_Control_theme>` resource the node uses. If the ``constant`` is invalid, Godot clears the override. See :ref:`Theme.INVALID_CONSTANT<class_Theme_INVALID_CONSTANT>` for more information.
.. _class_Control_add_font_override:
- void **add_font_override** **(** :ref:`String<class_string>` name, :ref:`Font<class_font>` font **)**
Overrides the ``name`` font in the theme resource the node uses. If ``font`` is empty, Godot clears the override.
Overrides the ``name`` font in the :ref:`theme<class_Control_theme>` resource the node uses. If ``font`` is empty, Godot clears the override.
.. _class_Control_add_icon_override:
- void **add_icon_override** **(** :ref:`String<class_string>` name, :ref:`Texture<class_texture>` texture **)**
Overrides the ``name`` icon in the theme resource the node uses. If ``icon`` is empty, Godot clears the override.
Overrides the ``name`` icon in the :ref:`theme<class_Control_theme>` resource the node uses. If ``icon`` is empty, Godot clears the override.
.. _class_Control_add_shader_override:
- void **add_shader_override** **(** :ref:`String<class_string>` name, :ref:`Shader<class_shader>` shader **)**
Overrides the ``name`` shader in the theme resource the node uses. If ``shader`` is empty, Godot clears the override.
Overrides the ``name`` shader in the :ref:`theme<class_Control_theme>` resource the node uses. If ``shader`` is empty, Godot clears the override.
.. _class_Control_add_stylebox_override:
- void **add_stylebox_override** **(** :ref:`String<class_string>` name, :ref:`StyleBox<class_stylebox>` stylebox **)**
Overrides the ``name`` Stylebox in the theme resource the node uses. If ``stylebox`` is empty, Godot clears the override.
Overrides the ``name`` Stylebox in the :ref:`theme<class_Control_theme>` resource the node uses. If ``stylebox`` is empty, Godot clears the override.
.. _class_Control_can_drop_data:
@@ -580,7 +580,7 @@ The methods :ref:`can_drop_data<class_Control_can_drop_data>` and :ref:`drop_dat
.. _class_Control_get_cursor_shape:
- :ref:`int<class_int>` **get_cursor_shape** **(** :ref:`Vector2<class_vector2>` position=Vector2( 0, 0 ) **)** const
- :ref:`CursorShape<enum_control_cursorshape>` **get_cursor_shape** **(** :ref:`Vector2<class_vector2>` position=Vector2( 0, 0 ) **)** const
Returns the mouse cursor shape the control displays on mouse hover, one of the ``CURSOR_*`` constants.
@@ -739,19 +739,19 @@ Give up the focus, no other control will be able to receive keyboard input.
.. _class_Control_set_anchor:
- void **set_anchor** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` anchor, :ref:`bool<class_bool>` keep_margin=false, :ref:`bool<class_bool>` push_opposite_anchor=true **)**
- void **set_anchor** **(** :ref:`Margin<enum_@globalscope_margin>` margin, :ref:`float<class_float>` anchor, :ref:`bool<class_bool>` keep_margin=false, :ref:`bool<class_bool>` push_opposite_anchor=true **)**
.. _class_Control_set_anchor_and_margin:
- void **set_anchor_and_margin** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` anchor, :ref:`float<class_float>` offset, :ref:`bool<class_bool>` push_opposite_anchor=false **)**
- void **set_anchor_and_margin** **(** :ref:`Margin<enum_@globalscope_margin>` margin, :ref:`float<class_float>` anchor, :ref:`float<class_float>` offset, :ref:`bool<class_bool>` push_opposite_anchor=false **)**
.. _class_Control_set_anchors_and_margins_preset:
- void **set_anchors_and_margins_preset** **(** :ref:`int<class_int>` preset, :ref:`int<class_int>` resize_mode=0, :ref:`int<class_int>` margin=0 **)**
- void **set_anchors_and_margins_preset** **(** :ref:`LayoutPreset<enum_control_layoutpreset>` preset, :ref:`LayoutPresetMode<enum_control_layoutpresetmode>` resize_mode=0, :ref:`int<class_int>` margin=0 **)**
.. _class_Control_set_anchors_preset:
- void **set_anchors_preset** **(** :ref:`int<class_int>` preset, :ref:`bool<class_bool>` keep_margin=false **)**
- void **set_anchors_preset** **(** :ref:`LayoutPreset<enum_control_layoutpreset>` preset, :ref:`bool<class_bool>` keep_margin=false **)**
.. _class_Control_set_begin:
@@ -804,7 +804,7 @@ Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see :ref
.. _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 **)**
- void **set_margins_preset** **(** :ref:`LayoutPreset<enum_control_layoutpreset>` preset, :ref:`LayoutPresetMode<enum_control_layoutpresetmode>` resize_mode=0, :ref:`int<class_int>` margin=0 **)**
.. _class_Control_set_rotation:

38
classes/class_csgbox.rst Normal file
View File

@@ -0,0 +1,38 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CSGBox.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_CSGBox:
CSGBox
======
**Inherits:** :ref:`CSGPrimitive<class_csgprimitive>` **<** :ref:`CSGShape<class_csgshape>` **<** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Variables
----------------
.. _class_CSGBox_depth:
- :ref:`float<class_float>` **depth**
.. _class_CSGBox_height:
- :ref:`float<class_float>` **height**
.. _class_CSGBox_material:
- :ref:`Material<class_material>` **material**
.. _class_CSGBox_width:
- :ref:`float<class_float>` **width**

View File

@@ -0,0 +1,18 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CSGCombiner.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_CSGCombiner:
CSGCombiner
===========
**Inherits:** :ref:`CSGShape<class_csgshape>` **<** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------

View File

@@ -0,0 +1,46 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CSGCylinder.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_CSGCylinder:
CSGCylinder
===========
**Inherits:** :ref:`CSGPrimitive<class_csgprimitive>` **<** :ref:`CSGShape<class_csgshape>` **<** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Variables
----------------
.. _class_CSGCylinder_cone:
- :ref:`bool<class_bool>` **cone**
.. _class_CSGCylinder_height:
- :ref:`float<class_float>` **height**
.. _class_CSGCylinder_material:
- :ref:`Material<class_material>` **material**
.. _class_CSGCylinder_radius:
- :ref:`float<class_float>` **radius**
.. _class_CSGCylinder_sides:
- :ref:`int<class_int>` **sides**
.. _class_CSGCylinder_smooth_faces:
- :ref:`bool<class_bool>` **smooth_faces**

26
classes/class_csgmesh.rst Normal file
View File

@@ -0,0 +1,26 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CSGMesh.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_CSGMesh:
CSGMesh
=======
**Inherits:** :ref:`CSGPrimitive<class_csgprimitive>` **<** :ref:`CSGShape<class_csgshape>` **<** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Variables
----------------
.. _class_CSGMesh_mesh:
- :ref:`Mesh<class_mesh>` **mesh**

View File

@@ -0,0 +1,82 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CSGPolygon.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_CSGPolygon:
CSGPolygon
==========
**Inherits:** :ref:`CSGPrimitive<class_csgprimitive>` **<** :ref:`CSGShape<class_csgshape>` **<** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Variables
----------------
.. _class_CSGPolygon_depth:
- :ref:`float<class_float>` **depth**
.. _class_CSGPolygon_material:
- :ref:`Material<class_material>` **material**
.. _class_CSGPolygon_mode:
- :ref:`Mode<enum_csgpolygon_mode>` **mode**
.. _class_CSGPolygon_path_interval:
- :ref:`float<class_float>` **path_interval**
.. _class_CSGPolygon_path_node:
- :ref:`NodePath<class_nodepath>` **path_node**
.. _class_CSGPolygon_path_rotation:
- :ref:`PathRotation<enum_csgpolygon_pathrotation>` **path_rotation**
.. _class_CSGPolygon_polygon:
- :ref:`PoolVector2Array<class_poolvector2array>` **polygon**
.. _class_CSGPolygon_smooth_faces:
- :ref:`bool<class_bool>` **smooth_faces**
.. _class_CSGPolygon_spin_degrees:
- :ref:`float<class_float>` **spin_degrees**
.. _class_CSGPolygon_spin_sides:
- :ref:`int<class_int>` **spin_sides**
Enums
-----
.. _enum_CSGPolygon_Mode:
enum **Mode**
- **MODE_DEPTH** = **0**
- **MODE_SPIN** = **1**
- **MODE_PATH** = **2**
.. _enum_CSGPolygon_PathRotation:
enum **PathRotation**
- **PATH_ROTATION_POLYGON** = **0**
- **PATH_ROTATION_PATH** = **1**
- **PATH_ROTATION_PATH_FOLLOW** = **2**

View File

@@ -0,0 +1,28 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CSGPrimitive.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_CSGPrimitive:
CSGPrimitive
============
**Inherits:** :ref:`CSGShape<class_csgshape>` **<** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Inherited By:** :ref:`CSGSphere<class_csgsphere>`, :ref:`CSGPolygon<class_csgpolygon>`, :ref:`CSGCylinder<class_csgcylinder>`, :ref:`CSGBox<class_csgbox>`, :ref:`CSGTorus<class_csgtorus>`, :ref:`CSGMesh<class_csgmesh>`
**Category:** Core
Brief Description
-----------------
Member Variables
----------------
.. _class_CSGPrimitive_invert_faces:
- :ref:`bool<class_bool>` **invert_faces**

View File

@@ -0,0 +1,63 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CSGShape.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_CSGShape:
CSGShape
========
**Inherits:** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Inherited By:** :ref:`CSGCombiner<class_csgcombiner>`, :ref:`CSGPrimitive<class_csgprimitive>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+--------------------------+----------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_root_shape<class_CSGShape_is_root_shape>` **(** **)** const |
+--------------------------+----------------------------------------------------------------------+
Member Variables
----------------
.. _class_CSGShape_operation:
- :ref:`Operation<enum_csgshape_operation>` **operation**
.. _class_CSGShape_snap:
- :ref:`float<class_float>` **snap**
.. _class_CSGShape_use_collision:
- :ref:`bool<class_bool>` **use_collision**
Enums
-----
.. _enum_CSGShape_Operation:
enum **Operation**
- **OPERATION_UNION** = **0**
- **OPERATION_INTERSECTION** = **1**
- **OPERATION_SUBTRACTION** = **2**
Member Function Description
---------------------------
.. _class_CSGShape_is_root_shape:
- :ref:`bool<class_bool>` **is_root_shape** **(** **)** const

View File

@@ -0,0 +1,42 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CSGSphere.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_CSGSphere:
CSGSphere
=========
**Inherits:** :ref:`CSGPrimitive<class_csgprimitive>` **<** :ref:`CSGShape<class_csgshape>` **<** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Variables
----------------
.. _class_CSGSphere_material:
- :ref:`Material<class_material>` **material**
.. _class_CSGSphere_radial_segments:
- :ref:`int<class_int>` **radial_segments**
.. _class_CSGSphere_radius:
- :ref:`float<class_float>` **radius**
.. _class_CSGSphere_rings:
- :ref:`int<class_int>` **rings**
.. _class_CSGSphere_smooth_faces:
- :ref:`bool<class_bool>` **smooth_faces**

View File

@@ -0,0 +1,46 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CSGTorus.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_CSGTorus:
CSGTorus
========
**Inherits:** :ref:`CSGPrimitive<class_csgprimitive>` **<** :ref:`CSGShape<class_csgshape>` **<** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Variables
----------------
.. _class_CSGTorus_inner_radius:
- :ref:`float<class_float>` **inner_radius**
.. _class_CSGTorus_material:
- :ref:`Material<class_material>` **material**
.. _class_CSGTorus_outer_radius:
- :ref:`float<class_float>` **outer_radius**
.. _class_CSGTorus_ring_sides:
- :ref:`int<class_int>` **ring_sides**
.. _class_CSGTorus_sides:
- :ref:`int<class_int>` **sides**
.. _class_CSGTorus_smooth_faces:
- :ref:`bool<class_bool>` **smooth_faces**

View File

@@ -19,15 +19,15 @@ A CubeMap is a 6 sided 3D texture.
Member Functions
----------------
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_height<class_CubeMap_get_height>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_image>` | :ref:`get_side<class_CubeMap_get_side>` **(** :ref:`int<class_int>` side **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_width<class_CubeMap_get_width>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_side<class_CubeMap_set_side>` **(** :ref:`int<class_int>` side, :ref:`Image<class_image>` image **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_height<class_CubeMap_get_height>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_image>` | :ref:`get_side<class_CubeMap_get_side>` **(** :ref:`Side<enum_cubemap_side>` side **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_width<class_CubeMap_get_width>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_side<class_CubeMap_set_side>` **(** :ref:`Side<enum_cubemap_side>` side, :ref:`Image<class_image>` image **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -93,7 +93,7 @@ Returns the ``CubeMap``'s height.
.. _class_CubeMap_get_side:
- :ref:`Image<class_image>` **get_side** **(** :ref:`int<class_int>` side **)** const
- :ref:`Image<class_image>` **get_side** **(** :ref:`Side<enum_cubemap_side>` side **)** const
Returns an :ref:`Image<class_image>` for a side of the ``CubeMap`` using one of the ``SIDE_*`` constants or an integer 0-5.
@@ -105,7 +105,7 @@ Returns the ``CubeMap``'s width.
.. _class_CubeMap_set_side:
- void **set_side** **(** :ref:`int<class_int>` side, :ref:`Image<class_image>` image **)**
- void **set_side** **(** :ref:`Side<enum_cubemap_side>` side, :ref:`Image<class_image>` image **)**
Sets an :ref:`Image<class_image>` for a side of the ``CubeMap`` using one of the ``SIDE_*`` constants or an integer 0-5.

View File

@@ -19,43 +19,43 @@ A mathematic curve.
Member Functions
----------------
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`add_point<class_Curve_add_point>` **(** :ref:`Vector2<class_vector2>` position, :ref:`float<class_float>` left_tangent=0, :ref:`float<class_float>` right_tangent=0, :ref:`int<class_int>` left_mode=0, :ref:`int<class_int>` right_mode=0 **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`bake<class_Curve_bake>` **(** **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clean_dupes<class_Curve_clean_dupes>` **(** **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_points<class_Curve_clear_points>` **(** **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_left_mode<class_Curve_get_point_left_mode>` **(** :ref:`int<class_int>` index **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_point_left_tangent<class_Curve_get_point_left_tangent>` **(** :ref:`int<class_int>` index **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_position<class_Curve_get_point_position>` **(** :ref:`int<class_int>` index **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_right_mode<class_Curve_get_point_right_mode>` **(** :ref:`int<class_int>` index **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_point_right_tangent<class_Curve_get_point_right_tangent>` **(** :ref:`int<class_int>` index **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`interpolate<class_Curve_interpolate>` **(** :ref:`float<class_float>` offset **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`interpolate_baked<class_Curve_interpolate_baked>` **(** :ref:`float<class_float>` offset **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_Curve_remove_point>` **(** :ref:`int<class_int>` index **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_left_mode<class_Curve_set_point_left_mode>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` mode **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_left_tangent<class_Curve_set_point_left_tangent>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`set_point_offset<class_Curve_set_point_offset>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` offset **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_right_mode<class_Curve_set_point_right_mode>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` mode **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_right_tangent<class_Curve_set_point_right_tangent>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_value<class_Curve_set_point_value>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` y **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`add_point<class_Curve_add_point>` **(** :ref:`Vector2<class_vector2>` position, :ref:`float<class_float>` left_tangent=0, :ref:`float<class_float>` right_tangent=0, :ref:`TangentMode<enum_curve_tangentmode>` left_mode=0, :ref:`TangentMode<enum_curve_tangentmode>` right_mode=0 **)** |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`bake<class_Curve_bake>` **(** **)** |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clean_dupes<class_Curve_clean_dupes>` **(** **)** |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_points<class_Curve_clear_points>` **(** **)** |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TangentMode<enum_curve_tangentmode>` | :ref:`get_point_left_mode<class_Curve_get_point_left_mode>` **(** :ref:`int<class_int>` index **)** const |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_point_left_tangent<class_Curve_get_point_left_tangent>` **(** :ref:`int<class_int>` index **)** const |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_position<class_Curve_get_point_position>` **(** :ref:`int<class_int>` index **)** const |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TangentMode<enum_curve_tangentmode>` | :ref:`get_point_right_mode<class_Curve_get_point_right_mode>` **(** :ref:`int<class_int>` index **)** const |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_point_right_tangent<class_Curve_get_point_right_tangent>` **(** :ref:`int<class_int>` index **)** const |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`interpolate<class_Curve_interpolate>` **(** :ref:`float<class_float>` offset **)** const |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`interpolate_baked<class_Curve_interpolate_baked>` **(** :ref:`float<class_float>` offset **)** |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_Curve_remove_point>` **(** :ref:`int<class_int>` index **)** |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_left_mode<class_Curve_set_point_left_mode>` **(** :ref:`int<class_int>` index, :ref:`TangentMode<enum_curve_tangentmode>` mode **)** |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_left_tangent<class_Curve_set_point_left_tangent>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent **)** |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`set_point_offset<class_Curve_set_point_offset>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` offset **)** |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_right_mode<class_Curve_set_point_right_mode>` **(** :ref:`int<class_int>` index, :ref:`TangentMode<enum_curve_tangentmode>` mode **)** |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_right_tangent<class_Curve_set_point_right_tangent>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent **)** |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_value<class_Curve_set_point_value>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` y **)** |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -105,7 +105,7 @@ Member Function Description
.. _class_Curve_add_point:
- :ref:`int<class_int>` **add_point** **(** :ref:`Vector2<class_vector2>` position, :ref:`float<class_float>` left_tangent=0, :ref:`float<class_float>` right_tangent=0, :ref:`int<class_int>` left_mode=0, :ref:`int<class_int>` right_mode=0 **)**
- :ref:`int<class_int>` **add_point** **(** :ref:`Vector2<class_vector2>` position, :ref:`float<class_float>` left_tangent=0, :ref:`float<class_float>` right_tangent=0, :ref:`TangentMode<enum_curve_tangentmode>` left_mode=0, :ref:`TangentMode<enum_curve_tangentmode>` right_mode=0 **)**
Adds a point to the curve. For each side, if the ``*_mode`` is ``TANGENT_LINEAR``, the ``*_tangent`` angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the ``*_tangent`` angle if ``*_mode`` is set to ``TANGENT_FREE``.
@@ -129,7 +129,7 @@ Removes all points from the curve.
.. _class_Curve_get_point_left_mode:
- :ref:`int<class_int>` **get_point_left_mode** **(** :ref:`int<class_int>` index **)** const
- :ref:`TangentMode<enum_curve_tangentmode>` **get_point_left_mode** **(** :ref:`int<class_int>` index **)** const
Returns the left ``TangentMode`` for the point at ``index``.
@@ -147,7 +147,7 @@ Returns the curve coordinates for the point at ``index``.
.. _class_Curve_get_point_right_mode:
- :ref:`int<class_int>` **get_point_right_mode** **(** :ref:`int<class_int>` index **)** const
- :ref:`TangentMode<enum_curve_tangentmode>` **get_point_right_mode** **(** :ref:`int<class_int>` index **)** const
Returns the right ``TangentMode`` for the point at ``index``.
@@ -177,7 +177,7 @@ Removes the point at ``index`` from the curve.
.. _class_Curve_set_point_left_mode:
- void **set_point_left_mode** **(** :ref:`int<class_int>` index, :ref:`int<class_int>` mode **)**
- void **set_point_left_mode** **(** :ref:`int<class_int>` index, :ref:`TangentMode<enum_curve_tangentmode>` mode **)**
Sets the left ``TangentMode`` for the point at ``index`` to ``mode``.
@@ -195,7 +195,7 @@ Sets the offset from ``0.5``
.. _class_Curve_set_point_right_mode:
- void **set_point_right_mode** **(** :ref:`int<class_int>` index, :ref:`int<class_int>` mode **)**
- void **set_point_right_mode** **(** :ref:`int<class_int>` index, :ref:`TangentMode<enum_curve_tangentmode>` mode **)**
Sets the right ``TangentMode`` for the point at ``index`` to ``mode``.

View File

@@ -28,6 +28,10 @@ Member Functions
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_baked_points<class_Curve2D_get_baked_points>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_closest_offset<class_Curve2D_get_closest_offset>` **(** :ref:`Vector2<class_vector2>` to_point **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_closest_point<class_Curve2D_get_closest_point>` **(** :ref:`Vector2<class_vector2>` to_point **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_count<class_Curve2D_get_point_count>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_in<class_Curve2D_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
@@ -97,6 +101,22 @@ Returns the total length of the curve, based on the cached points. Given enough
Returns the cache of points as a :ref:`PoolVector2Array<class_poolvector2array>`.
.. _class_Curve2D_get_closest_offset:
- :ref:`float<class_float>` **get_closest_offset** **(** :ref:`Vector2<class_vector2>` to_point **)** const
Returns the closest offset to ``to_point``. This offset is meant to be used in :ref:`interpolate_baked<class_Curve2D_interpolate_baked>`.
``to_point`` must be in this curve's local space.
.. _class_Curve2D_get_closest_point:
- :ref:`Vector2<class_vector2>` **get_closest_point** **(** :ref:`Vector2<class_vector2>` to_point **)** const
Returns the closest point (in curve's local space) to ``to_point``.
``to_point`` must be in this curve's local space.
.. _class_Curve2D_get_point_count:
- :ref:`int<class_int>` **get_point_count** **(** **)** const

View File

@@ -30,6 +30,12 @@ Member Functions
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolRealArray<class_poolrealarray>` | :ref:`get_baked_tilts<class_Curve3D_get_baked_tilts>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_baked_up_vectors<class_Curve3D_get_baked_up_vectors>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_closest_offset<class_Curve3D_get_closest_offset>` **(** :ref:`Vector3<class_vector3>` to_point **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_closest_point<class_Curve3D_get_closest_point>` **(** :ref:`Vector3<class_vector3>` to_point **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_count<class_Curve3D_get_point_count>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_in<class_Curve3D_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
@@ -44,6 +50,8 @@ Member Functions
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolate_baked<class_Curve3D_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolate_baked_up_vector<class_Curve3D_interpolate_baked_up_vector>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` apply_tilt=false **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolatef<class_Curve3D_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_Curve3D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
@@ -66,6 +74,10 @@ Member Variables
- :ref:`float<class_float>` **bake_interval** - The distance in meters between two adjacent cached points. Changing it forces the cache to be recomputed the next time the :ref:`get_baked_points<class_Curve3D_get_baked_points>` or :ref:`get_baked_length<class_Curve3D_get_baked_length>` function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care.
.. _class_Curve3D_up_vector_enabled:
- :ref:`bool<class_bool>` **up_vector_enabled** - If ``true``, the curve will bake up vectors used for orientation. See :ref:`OrientedPathFollow<class_orientedpathfollow>`. Changing it forces the cache to be recomputed.
Description
-----------
@@ -109,6 +121,30 @@ Returns the cache of points as a :ref:`PoolVector3Array<class_poolvector3array>`
Returns the cache of tilts as a RealArray.
.. _class_Curve3D_get_baked_up_vectors:
- :ref:`PoolVector3Array<class_poolvector3array>` **get_baked_up_vectors** **(** **)** const
Returns the cache of up vectors as a :ref:`PoolVector3Array<class_poolvector3array>`.
If :ref:`up_vector_enabled<class_Curve3D_up_vector_enabled>` is ``false``, the cache will be empty.
.. _class_Curve3D_get_closest_offset:
- :ref:`float<class_float>` **get_closest_offset** **(** :ref:`Vector3<class_vector3>` to_point **)** const
Returns the closest offset to ``to_point``. This offset is meant to be used in one of the interpolate_baked\* methods.
``to_point`` must be in this curve's local space.
.. _class_Curve3D_get_closest_point:
- :ref:`Vector3<class_vector3>` **get_closest_point** **(** :ref:`Vector3<class_vector3>` to_point **)** const
Returns the closest point (in curve's local space) to ``to_point``.
``to_point`` must be in this curve's local space.
.. _class_Curve3D_get_point_count:
- :ref:`int<class_int>` **get_point_count** **(** **)** const
@@ -157,6 +193,16 @@ To do that, it finds the two cached points where the "offset" lies between, then
Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough).
.. _class_Curve3D_interpolate_baked_up_vector:
- :ref:`Vector3<class_vector3>` **interpolate_baked_up_vector** **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` apply_tilt=false **)** const
Returns an up vector within the curve at position ``offset``, where ``offset`` is measured as a distance in 3D units along the curve.
To do that, it finds the two cached up vectors where the ``offset`` lies between, then interpolates the values. If ``apply_tilt`` is ``true``, an interpolated tilt is applied to the interpolated up vector.
If the curve has no up vectors, the function sends an error to the console, and returns (0, 1, 0).
.. _class_Curve3D_interpolatef:
- :ref:`Vector3<class_vector3>` **interpolatef** **(** :ref:`float<class_float>` fofs **)** const
@@ -193,7 +239,7 @@ Sets the position for the vertex "idx". If the index is out of bounds, the funct
Sets the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console.
The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a :ref:`PathFollow<class_pathfollow>`, this tilt is an offset over the natural tilt the PathFollow calculates.
The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a :ref:`PathFollow<class_pathfollow>` or :ref:`OrientedPathFollow<class_orientedpathfollow>`, this tilt is an offset over the natural tilt the :ref:`PathFollow<class_pathfollow>` or :ref:`OrientedPathFollow<class_orientedpathfollow>` calculates.
.. _class_Curve3D_tessellate:

View File

@@ -19,43 +19,43 @@ Type used to handle the filesystem.
Member Functions
----------------
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`change_dir<class_Directory_change_dir>` **(** :ref:`String<class_string>` todir **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`copy<class_Directory_copy>` **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`current_is_dir<class_Directory_current_is_dir>` **(** **)** const |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`dir_exists<class_Directory_dir_exists>` **(** :ref:`String<class_string>` path **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`file_exists<class_Directory_file_exists>` **(** :ref:`String<class_string>` path **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_current_dir<class_Directory_get_current_dir>` **(** **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_current_drive<class_Directory_get_current_drive>` **(** **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_drive<class_Directory_get_drive>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_drive_count<class_Directory_get_drive_count>` **(** **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_next<class_Directory_get_next>` **(** **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_space_left<class_Directory_get_space_left>` **(** **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`list_dir_begin<class_Directory_list_dir_begin>` **(** :ref:`bool<class_bool>` skip_navigational=false, :ref:`bool<class_bool>` skip_hidden=false **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`list_dir_end<class_Directory_list_dir_end>` **(** **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`make_dir<class_Directory_make_dir>` **(** :ref:`String<class_string>` path **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`make_dir_recursive<class_Directory_make_dir_recursive>` **(** :ref:`String<class_string>` path **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`open<class_Directory_open>` **(** :ref:`String<class_string>` path **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`remove<class_Directory_remove>` **(** :ref:`String<class_string>` path **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`rename<class_Directory_rename>` **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`change_dir<class_Directory_change_dir>` **(** :ref:`String<class_string>` todir **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`copy<class_Directory_copy>` **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`current_is_dir<class_Directory_current_is_dir>` **(** **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`dir_exists<class_Directory_dir_exists>` **(** :ref:`String<class_string>` path **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`file_exists<class_Directory_file_exists>` **(** :ref:`String<class_string>` path **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_current_dir<class_Directory_get_current_dir>` **(** **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_current_drive<class_Directory_get_current_drive>` **(** **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_drive<class_Directory_get_drive>` **(** :ref:`int<class_int>` idx **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_drive_count<class_Directory_get_drive_count>` **(** **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_next<class_Directory_get_next>` **(** **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_space_left<class_Directory_get_space_left>` **(** **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`list_dir_begin<class_Directory_list_dir_begin>` **(** :ref:`bool<class_bool>` skip_navigational=false, :ref:`bool<class_bool>` skip_hidden=false **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`list_dir_end<class_Directory_list_dir_end>` **(** **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`make_dir<class_Directory_make_dir>` **(** :ref:`String<class_string>` path **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`make_dir_recursive<class_Directory_make_dir_recursive>` **(** :ref:`String<class_string>` path **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`open<class_Directory_open>` **(** :ref:`String<class_string>` path **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`remove<class_Directory_remove>` **(** :ref:`String<class_string>` path **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`rename<class_Directory_rename>` **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -85,7 +85,7 @@ Member Function Description
.. _class_Directory_change_dir:
- :ref:`int<class_int>` **change_dir** **(** :ref:`String<class_string>` todir **)**
- :ref:`Error<enum_@globalscope_error>` **change_dir** **(** :ref:`String<class_string>` todir **)**
Change the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. ``newdir`` or ``../newdir``), or an absolute path (e.g. ``/tmp/newdir`` or ``res://somedir/newdir``).
@@ -93,7 +93,7 @@ The method returns one of the error code constants defined in :ref:`@GlobalScope
.. _class_Directory_copy:
- :ref:`int<class_int>` **copy** **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)**
- :ref:`Error<enum_@globalscope_error>` **copy** **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)**
Copy the *from* file to the *to* destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten.
@@ -157,7 +157,7 @@ On Unix desktop systems, return the available space on the current directory's d
.. _class_Directory_list_dir_begin:
- :ref:`int<class_int>` **list_dir_begin** **(** :ref:`bool<class_bool>` skip_navigational=false, :ref:`bool<class_bool>` skip_hidden=false **)**
- :ref:`Error<enum_@globalscope_error>` **list_dir_begin** **(** :ref:`bool<class_bool>` skip_navigational=false, :ref:`bool<class_bool>` skip_hidden=false **)**
Initialise the stream used to list all files and directories using the :ref:`get_next<class_Directory_get_next>` function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with :ref:`list_dir_end<class_Directory_list_dir_end>`.
@@ -173,7 +173,7 @@ Close the current stream opened with :ref:`list_dir_begin<class_Directory_list_d
.. _class_Directory_make_dir:
- :ref:`int<class_int>` **make_dir** **(** :ref:`String<class_string>` path **)**
- :ref:`Error<enum_@globalscope_error>` **make_dir** **(** :ref:`String<class_string>` path **)**
Create a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see :ref:`make_dir_recursive<class_Directory_make_dir_recursive>`).
@@ -181,7 +181,7 @@ The method returns one of the error code constants defined in :ref:`@GlobalScope
.. _class_Directory_make_dir_recursive:
- :ref:`int<class_int>` **make_dir_recursive** **(** :ref:`String<class_string>` path **)**
- :ref:`Error<enum_@globalscope_error>` **make_dir_recursive** **(** :ref:`String<class_string>` path **)**
Create a target directory and all necessary intermediate directories in its path, by calling :ref:`make_dir<class_Directory_make_dir>` recursively. The argument can be relative to the current directory, or an absolute path.
@@ -189,7 +189,7 @@ Return one of the error code constants defined in :ref:`@GlobalScope<class_@glob
.. _class_Directory_open:
- :ref:`int<class_int>` **open** **(** :ref:`String<class_string>` path **)**
- :ref:`Error<enum_@globalscope_error>` **open** **(** :ref:`String<class_string>` path **)**
Open an existing directory of the filesystem. The *path* argument can be within the project tree (``res://folder``), the user directory (``user://folder``) or an absolute path of the user filesystem (e.g. ``/tmp/folder`` or ``C:\tmp\folder``).
@@ -197,7 +197,7 @@ The method returns one of the error code constants defined in :ref:`@GlobalScope
.. _class_Directory_remove:
- :ref:`int<class_int>` **remove** **(** :ref:`String<class_string>` path **)**
- :ref:`Error<enum_@globalscope_error>` **remove** **(** :ref:`String<class_string>` path **)**
Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail.
@@ -205,7 +205,7 @@ Return one of the error code constants defined in :ref:`@GlobalScope<class_@glob
.. _class_Directory_rename:
- :ref:`int<class_int>` **rename** **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)**
- :ref:`Error<enum_@globalscope_error>` **rename** **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)**
Rename (move) the *from* file to the *to* destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten.

View File

@@ -54,6 +54,14 @@ Member Variables
- :ref:`DynamicFontData<class_dynamicfontdata>` **font_data** - The font data.
.. _class_DynamicFont_outline_color:
- :ref:`Color<class_color>` **outline_color**
.. _class_DynamicFont_outline_size:
- :ref:`int<class_int>` **outline_size**
.. _class_DynamicFont_size:
- :ref:`int<class_int>` **size** - The font size.

View File

@@ -0,0 +1,34 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the EditorInspector.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_EditorInspector:
EditorInspector
===============
**Inherits:** :ref:`ScrollContainer<class_scrollcontainer>` **<** :ref:`Container<class_container>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Signals
-------
.. _class_EditorInspector_object_id_selected:
- **object_id_selected** **(** :ref:`int<class_int>` id **)**
.. _class_EditorInspector_property_keyed:
- **property_keyed** **(** :ref:`String<class_string>` property **)**
.. _class_EditorInspector_resource_selected:
- **resource_selected** **(** :ref:`Object<class_object>` res, :ref:`String<class_string>` prop **)**

View File

@@ -0,0 +1,75 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the EditorInspectorPlugin.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_EditorInspectorPlugin:
EditorInspectorPlugin
=====================
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_custom_control<class_EditorInspectorPlugin_add_custom_control>` **(** :ref:`Control<class_control>` control **)** |
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_property_editor<class_EditorInspectorPlugin_add_property_editor>` **(** :ref:`String<class_string>` property, :ref:`Control<class_control>` editor **)** |
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_property_editor_for_multiple_properties<class_EditorInspectorPlugin_add_property_editor_for_multiple_properties>` **(** :ref:`String<class_string>` label, :ref:`PoolStringArray<class_poolstringarray>` properties, :ref:`Control<class_control>` editor **)** |
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`can_handle<class_EditorInspectorPlugin_can_handle>` **(** :ref:`Object<class_object>` object **)** virtual |
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`parse_begin<class_EditorInspectorPlugin_parse_begin>` **(** :ref:`Object<class_object>` object **)** virtual |
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`parse_category<class_EditorInspectorPlugin_parse_category>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` category **)** virtual |
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`parse_end<class_EditorInspectorPlugin_parse_end>` **(** **)** virtual |
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`parse_property<class_EditorInspectorPlugin_parse_property>` **(** :ref:`Object<class_object>` object, :ref:`int<class_int>` type, :ref:`String<class_string>` path, :ref:`int<class_int>` hint, :ref:`String<class_string>` hint_text, :ref:`int<class_int>` usage **)** virtual |
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_EditorInspectorPlugin_add_custom_control:
- void **add_custom_control** **(** :ref:`Control<class_control>` control **)**
.. _class_EditorInspectorPlugin_add_property_editor:
- void **add_property_editor** **(** :ref:`String<class_string>` property, :ref:`Control<class_control>` editor **)**
.. _class_EditorInspectorPlugin_add_property_editor_for_multiple_properties:
- void **add_property_editor_for_multiple_properties** **(** :ref:`String<class_string>` label, :ref:`PoolStringArray<class_poolstringarray>` properties, :ref:`Control<class_control>` editor **)**
.. _class_EditorInspectorPlugin_can_handle:
- void **can_handle** **(** :ref:`Object<class_object>` object **)** virtual
.. _class_EditorInspectorPlugin_parse_begin:
- void **parse_begin** **(** :ref:`Object<class_object>` object **)** virtual
.. _class_EditorInspectorPlugin_parse_category:
- void **parse_category** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` category **)** virtual
.. _class_EditorInspectorPlugin_parse_end:
- void **parse_end** **(** **)** virtual
.. _class_EditorInspectorPlugin_parse_property:
- :ref:`bool<class_bool>` **parse_property** **(** :ref:`Object<class_object>` object, :ref:`int<class_int>` type, :ref:`String<class_string>` path, :ref:`int<class_int>` hint, :ref:`String<class_string>` hint_text, :ref:`int<class_int>` usage **)** virtual

View File

@@ -52,7 +52,7 @@ Member Functions
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`reload_scene_from_path<class_EditorInterface_reload_scene_from_path>` **(** :ref:`String<class_string>` scene_filepath **)** |
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`save_scene<class_EditorInterface_save_scene>` **(** **)** |
| :ref:`Error<enum_@globalscope_error>` | :ref:`save_scene<class_EditorInterface_save_scene>` **(** **)** |
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`save_scene_as<class_EditorInterface_save_scene_as>` **(** :ref:`String<class_string>` path, :ref:`bool<class_bool>` with_preview=true **)** |
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -64,7 +64,7 @@ Member Functions
Description
-----------
Editor interface. Allows saving and (re-)loading scenes, rendering mesh previews, inspecting and editing resources and objects and provides access to :ref:`EditorSettings<class_editorsettings>`, :ref:`EditorFileSystem<class_editorfilesystem>`, :ref:`EditorResourcePreview<class_editorresourcepreview>`\ er, :ref:`ScriptEditor<class_scripteditor>`, the editor viewport, as well as information about scenes. Also see :ref:`EditorPlugin<class_editorplugin>` and :ref:`EditorScript<class_editorscript>`.
Editor interface. Allows saving and (re-)loading scenes, rendering mesh previews, inspecting and editing resources and objects and provides access to :ref:`EditorSettings<class_editorsettings>`, :ref:`EditorFileSystem<class_editorfilesystem>`, :ref:`EditorResourcePreview<class_editorresourcepreview>`, :ref:`ScriptEditor<class_scripteditor>`, the editor viewport, as well as information about scenes. Also see :ref:`EditorPlugin<class_editorplugin>` and :ref:`EditorScript<class_editorscript>`.
Member Function Description
---------------------------
@@ -165,7 +165,7 @@ Reloads the scene at the given path.
.. _class_EditorInterface_save_scene:
- :ref:`int<class_int>` **save_scene** **(** **)**
- :ref:`Error<enum_@globalscope_error>` **save_scene** **(** **)**
Saves the scene. Returns either OK or ERR_CANT_CREATE. See :ref:`@GlobalScope<class_@globalscope>` constants.

View File

@@ -24,16 +24,18 @@ Member Functions
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ToolButton<class_toolbutton>` | :ref:`add_control_to_bottom_panel<class_EditorPlugin_add_control_to_bottom_panel>` **(** :ref:`Control<class_control>` control, :ref:`String<class_string>` title **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_control_to_container<class_EditorPlugin_add_control_to_container>` **(** :ref:`int<class_int>` container, :ref:`Control<class_control>` control **)** |
| void | :ref:`add_control_to_container<class_EditorPlugin_add_control_to_container>` **(** :ref:`CustomControlContainer<enum_editorplugin_customcontrolcontainer>` container, :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_control_to_dock<class_EditorPlugin_add_control_to_dock>` **(** :ref:`int<class_int>` slot, :ref:`Control<class_control>` control **)** |
| void | :ref:`add_control_to_dock<class_EditorPlugin_add_control_to_dock>` **(** :ref:`DockSlot<enum_editorplugin_dockslot>` slot, :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_custom_type<class_EditorPlugin_add_custom_type>` **(** :ref:`String<class_string>` type, :ref:`String<class_string>` base, :ref:`Script<class_script>` script, :ref:`Texture<class_texture>` icon **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_export_plugin<class_EditorPlugin_add_export_plugin>` **(** :ref:`EditorExportPlugin<class_editorexportplugin>` exporter **)** |
| void | :ref:`add_export_plugin<class_EditorPlugin_add_export_plugin>` **(** :ref:`EditorExportPlugin<class_editorexportplugin>` plugin **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_import_plugin<class_EditorPlugin_add_import_plugin>` **(** :ref:`EditorImportPlugin<class_editorimportplugin>` importer **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_inspector_plugin<class_EditorPlugin_add_inspector_plugin>` **(** :ref:`EditorInspectorPlugin<class_editorinspectorplugin>` plugin **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_scene_import_plugin<class_EditorPlugin_add_scene_import_plugin>` **(** :ref:`EditorSceneImporter<class_editorsceneimporter>` scene_importer **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_tool_menu_item<class_EditorPlugin_add_tool_menu_item>` **(** :ref:`String<class_string>` name, :ref:`Object<class_object>` handler, :ref:`String<class_string>` callback, :ref:`Variant<class_variant>` ud=null **)** |
@@ -42,6 +44,8 @@ Member Functions
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`apply_changes<class_EditorPlugin_apply_changes>` **(** **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`build<class_EditorPlugin_build>` **(** **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_EditorPlugin_clear>` **(** **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorSpatialGizmo<class_editorspatialgizmo>` | :ref:`create_spatial_gizmo<class_EditorPlugin_create_spatial_gizmo>` **(** :ref:`Spatial<class_spatial>` for_spatial **)** virtual |
@@ -86,16 +90,18 @@ Member Functions
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_control_from_bottom_panel<class_EditorPlugin_remove_control_from_bottom_panel>` **(** :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_control_from_container<class_EditorPlugin_remove_control_from_container>` **(** :ref:`int<class_int>` container, :ref:`Control<class_control>` control **)** |
| void | :ref:`remove_control_from_container<class_EditorPlugin_remove_control_from_container>` **(** :ref:`CustomControlContainer<enum_editorplugin_customcontrolcontainer>` container, :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_control_from_docks<class_EditorPlugin_remove_control_from_docks>` **(** :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_custom_type<class_EditorPlugin_remove_custom_type>` **(** :ref:`String<class_string>` type **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_export_plugin<class_EditorPlugin_remove_export_plugin>` **(** :ref:`EditorExportPlugin<class_editorexportplugin>` exporter **)** |
| void | :ref:`remove_export_plugin<class_EditorPlugin_remove_export_plugin>` **(** :ref:`EditorExportPlugin<class_editorexportplugin>` plugin **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_import_plugin<class_EditorPlugin_remove_import_plugin>` **(** :ref:`EditorImportPlugin<class_editorimportplugin>` importer **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_inspector_plugin<class_EditorPlugin_remove_inspector_plugin>` **(** :ref:`EditorInspectorPlugin<class_editorinspectorplugin>` plugin **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_scene_import_plugin<class_EditorPlugin_remove_scene_import_plugin>` **(** :ref:`EditorSceneImporter<class_editorsceneimporter>` scene_importer **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_tool_menu_item<class_EditorPlugin_remove_tool_menu_item>` **(** :ref:`String<class_string>` name **)** |
@@ -122,6 +128,10 @@ Signals
Emitted when user change main screen view (2D, 3D, Script, AssetLib). Works also with screens which are defined by plugins.
.. _class_EditorPlugin_resource_saved:
- **resource_saved** **(** :ref:`Object<class_object>` resource **)**
.. _class_EditorPlugin_scene_changed:
- **scene_changed** **(** :ref:`Object<class_object>` scene_root **)**
@@ -188,7 +198,7 @@ Add a control to the bottom panel (together with Output, Debug, Animation, etc).
.. _class_EditorPlugin_add_control_to_container:
- void **add_control_to_container** **(** :ref:`int<class_int>` container, :ref:`Control<class_control>` control **)**
- void **add_control_to_container** **(** :ref:`CustomControlContainer<enum_editorplugin_customcontrolcontainer>` container, :ref:`Control<class_control>` control **)**
Add a custom control to a container (see CONTAINER\_\* enum). There are many locations where custom controls can be added in the editor UI.
@@ -198,7 +208,7 @@ If your plugin is being removed, also make sure to remove your custom controls t
.. _class_EditorPlugin_add_control_to_dock:
- void **add_control_to_dock** **(** :ref:`int<class_int>` slot, :ref:`Control<class_control>` control **)**
- void **add_control_to_dock** **(** :ref:`DockSlot<enum_editorplugin_dockslot>` slot, :ref:`Control<class_control>` control **)**
Add the control to a specific dock slot (see DOCK\_\* enum for options).
@@ -220,12 +230,16 @@ During run-time, this will be a simple object with a script so this function doe
.. _class_EditorPlugin_add_export_plugin:
- void **add_export_plugin** **(** :ref:`EditorExportPlugin<class_editorexportplugin>` exporter **)**
- void **add_export_plugin** **(** :ref:`EditorExportPlugin<class_editorexportplugin>` plugin **)**
.. _class_EditorPlugin_add_import_plugin:
- void **add_import_plugin** **(** :ref:`EditorImportPlugin<class_editorimportplugin>` importer **)**
.. _class_EditorPlugin_add_inspector_plugin:
- void **add_inspector_plugin** **(** :ref:`EditorInspectorPlugin<class_editorinspectorplugin>` plugin **)**
.. _class_EditorPlugin_add_scene_import_plugin:
- void **add_scene_import_plugin** **(** :ref:`EditorSceneImporter<class_editorsceneimporter>` scene_importer **)**
@@ -248,6 +262,10 @@ This method is called when the editor is about to save the project, switch to an
This is used, for example, in shader editors to let the plugin know that it must apply the shader code being written by the user to the object.
.. _class_EditorPlugin_build:
- :ref:`bool<class_bool>` **build** **(** **)** virtual
.. _class_EditorPlugin_clear:
- void **clear** **(** **)** virtual
@@ -370,7 +388,7 @@ Remove the control from the bottom panel. Don't forget to call this if you added
.. _class_EditorPlugin_remove_control_from_container:
- void **remove_control_from_container** **(** :ref:`int<class_int>` container, :ref:`Control<class_control>` control **)**
- void **remove_control_from_container** **(** :ref:`CustomControlContainer<enum_editorplugin_customcontrolcontainer>` container, :ref:`Control<class_control>` control **)**
Remove the control from the specified container. Use it when cleaning up after adding a control with :ref:`add_control_to_container<class_EditorPlugin_add_control_to_container>`. Note that you can simply free the control if you won't use it anymore.
@@ -388,12 +406,16 @@ Remove a custom type added by :ref:`EditorPlugin.add_custom_type<class_EditorPlu
.. _class_EditorPlugin_remove_export_plugin:
- void **remove_export_plugin** **(** :ref:`EditorExportPlugin<class_editorexportplugin>` exporter **)**
- void **remove_export_plugin** **(** :ref:`EditorExportPlugin<class_editorexportplugin>` plugin **)**
.. _class_EditorPlugin_remove_import_plugin:
- void **remove_import_plugin** **(** :ref:`EditorImportPlugin<class_editorimportplugin>` importer **)**
.. _class_EditorPlugin_remove_inspector_plugin:
- void **remove_inspector_plugin** **(** :ref:`EditorInspectorPlugin<class_editorinspectorplugin>` plugin **)**
.. _class_EditorPlugin_remove_scene_import_plugin:
- void **remove_scene_import_plugin** **(** :ref:`EditorSceneImporter<class_editorsceneimporter>` scene_importer **)**

View File

@@ -0,0 +1,109 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the EditorProperty.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_EditorProperty:
EditorProperty
==============
**Inherits:** :ref:`Container<class_container>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+------------------------------+----------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_edited_object<class_EditorProperty_get_edited_object>` **(** **)** |
+------------------------------+----------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_edited_property<class_EditorProperty_get_edited_property>` **(** **)** |
+------------------------------+----------------------------------------------------------------------------------+
| void | :ref:`update_property<class_EditorProperty_update_property>` **(** **)** virtual |
+------------------------------+----------------------------------------------------------------------------------+
Signals
-------
.. _class_EditorProperty_multiple_properties_changed:
- **multiple_properties_changed** **(** :ref:`PoolStringArray<class_poolstringarray>` properties, :ref:`Array<class_array>` value **)**
.. _class_EditorProperty_object_id_selected:
- **object_id_selected** **(** :ref:`String<class_string>` property, :ref:`int<class_int>` id **)**
.. _class_EditorProperty_property_changed:
- **property_changed** **(** :ref:`String<class_string>` property, :ref:`Nil<class_nil>` value **)**
.. _class_EditorProperty_property_checked:
- **property_checked** **(** :ref:`String<class_string>` property, :ref:`String<class_string>` bool **)**
.. _class_EditorProperty_property_keyed:
- **property_keyed** **(** :ref:`String<class_string>` property **)**
.. _class_EditorProperty_property_keyed_with_value:
- **property_keyed_with_value** **(** :ref:`String<class_string>` property, :ref:`Nil<class_nil>` value **)**
.. _class_EditorProperty_resource_selected:
- **resource_selected** **(** :ref:`String<class_string>` path, :ref:`Object<class_object>` resource **)**
.. _class_EditorProperty_selected:
- **selected** **(** :ref:`String<class_string>` path, :ref:`int<class_int>` focusable_idx **)**
Member Variables
----------------
.. _class_EditorProperty_checkable:
- :ref:`bool<class_bool>` **checkable**
.. _class_EditorProperty_checked:
- :ref:`bool<class_bool>` **checked**
.. _class_EditorProperty_draw_red:
- :ref:`bool<class_bool>` **draw_red**
.. _class_EditorProperty_keying:
- :ref:`bool<class_bool>` **keying**
.. _class_EditorProperty_label:
- :ref:`String<class_string>` **label**
.. _class_EditorProperty_read_only:
- :ref:`bool<class_bool>` **read_only**
Member Function Description
---------------------------
.. _class_EditorProperty_get_edited_object:
- :ref:`Object<class_object>` **get_edited_object** **(** **)**
.. _class_EditorProperty_get_edited_property:
- :ref:`String<class_string>` **get_edited_property** **(** **)**
.. _class_EditorProperty_update_property:
- void **update_property** **(** **)** virtual

View File

@@ -19,35 +19,39 @@ Object that holds the project-independent editor settings.
Member Functions
----------------
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_property_info<class_EditorSettings_add_property_info>` **(** :ref:`Dictionary<class_dictionary>` info **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase<class_EditorSettings_erase>` **(** :ref:`String<class_string>` property **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_favorite_dirs<class_EditorSettings_get_favorite_dirs>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_project_settings_dir<class_EditorSettings_get_project_settings_dir>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_recent_dirs<class_EditorSettings_get_recent_dirs>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_setting<class_EditorSettings_get_setting>` **(** :ref:`String<class_string>` name **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_settings_dir<class_EditorSettings_get_settings_dir>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_setting<class_EditorSettings_has_setting>` **(** :ref:`String<class_string>` name **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`property_can_revert<class_EditorSettings_property_can_revert>` **(** :ref:`String<class_string>` name **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`property_get_revert<class_EditorSettings_property_get_revert>` **(** :ref:`String<class_string>` name **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_favorite_dirs<class_EditorSettings_set_favorite_dirs>` **(** :ref:`PoolStringArray<class_poolstringarray>` dirs **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_initial_value<class_EditorSettings_set_initial_value>` **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` value, :ref:`bool<class_bool>` update_current **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_recent_dirs<class_EditorSettings_set_recent_dirs>` **(** :ref:`PoolStringArray<class_poolstringarray>` dirs **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_setting<class_EditorSettings_set_setting>` **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` value **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_property_info<class_EditorSettings_add_property_info>` **(** :ref:`Dictionary<class_dictionary>` info **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase<class_EditorSettings_erase>` **(** :ref:`String<class_string>` property **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_favorite_dirs<class_EditorSettings_get_favorite_dirs>` **(** **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_project_metadata<class_EditorSettings_get_project_metadata>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, :ref:`Variant<class_variant>` default=null **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_project_settings_dir<class_EditorSettings_get_project_settings_dir>` **(** **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_recent_dirs<class_EditorSettings_get_recent_dirs>` **(** **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_setting<class_EditorSettings_get_setting>` **(** :ref:`String<class_string>` name **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_settings_dir<class_EditorSettings_get_settings_dir>` **(** **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_setting<class_EditorSettings_has_setting>` **(** :ref:`String<class_string>` name **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`property_can_revert<class_EditorSettings_property_can_revert>` **(** :ref:`String<class_string>` name **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`property_get_revert<class_EditorSettings_property_get_revert>` **(** :ref:`String<class_string>` name **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_favorite_dirs<class_EditorSettings_set_favorite_dirs>` **(** :ref:`PoolStringArray<class_poolstringarray>` dirs **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_initial_value<class_EditorSettings_set_initial_value>` **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` value, :ref:`bool<class_bool>` update_current **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_project_metadata<class_EditorSettings_set_project_metadata>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, :ref:`Variant<class_variant>` data **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_recent_dirs<class_EditorSettings_set_recent_dirs>` **(** :ref:`PoolStringArray<class_poolstringarray>` dirs **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_setting<class_EditorSettings_set_setting>` **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` value **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -106,6 +110,10 @@ Erase a given setting (pass full property path).
Get the list of favorite directories for this project.
.. _class_EditorSettings_get_project_metadata:
- :ref:`Variant<class_variant>` **get_project_metadata** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, :ref:`Variant<class_variant>` default=null **)** const
.. _class_EditorSettings_get_project_settings_dir:
- :ref:`String<class_string>` **get_project_settings_dir** **(** **)** const
@@ -154,6 +162,10 @@ Set the list of favorite directories for this project.
- void **set_initial_value** **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` value, :ref:`bool<class_bool>` update_current **)**
.. _class_EditorSettings_set_project_metadata:
- void **set_project_metadata** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, :ref:`Variant<class_variant>` data **)**
.. _class_EditorSettings_set_recent_dirs:
- void **set_recent_dirs** **(** :ref:`PoolStringArray<class_poolstringarray>` dirs **)**

View File

@@ -19,11 +19,21 @@ Access to basic engine properties.
Member Functions
----------------
+--------------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_author_info<class_Engine_get_author_info>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_copyright_info<class_Engine_get_copyright_info>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_donor_info<class_Engine_get_donor_info>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------+
| :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:`Dictionary<class_dictionary>` | :ref:`get_license_info<class_Engine_get_license_info>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_license_text<class_Engine_get_license_text>` **(** **)** 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 |
@@ -46,6 +56,10 @@ Member Variables
- :ref:`int<class_int>` **iterations_per_second** - The number of fixed iterations per second (for fixed process and physics).
.. _class_Engine_physics_jitter_fix:
- :ref:`float<class_float>` **physics_jitter_fix**
.. _class_Engine_target_fps:
- :ref:`int<class_int>` **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.
@@ -63,6 +77,42 @@ The ``Engine`` class allows you to query and modify the game's run-time paramete
Member Function Description
---------------------------
.. _class_Engine_get_author_info:
- :ref:`Dictionary<class_dictionary>` **get_author_info** **(** **)** const
Returns engine author information in a Dictionary.
"lead_developers" - Array of Strings, lead developer names
"founders" - Array of Strings, founder names
"project_managers" - Array of Strings, project manager names
"developers" - Array of Strings, developer names
.. _class_Engine_get_copyright_info:
- :ref:`Array<class_array>` **get_copyright_info** **(** **)** const
Returns an Array of copyright information Dictionaries.
"name" - String, component name
"parts" - Array of Dictionaries {"files", "copyright", "license"} describing subsections of the component
.. _class_Engine_get_donor_info:
- :ref:`Dictionary<class_dictionary>` **get_donor_info** **(** **)** const
Returns a Dictionary of Arrays of donor names.
{"platinum_sponsors", "gold_sponsors", "mini_sponsors", "gold_donors", "silver_donors", "bronze_donors"}
.. _class_Engine_get_frames_drawn:
- :ref:`int<class_int>` **get_frames_drawn** **(** **)**
@@ -75,6 +125,18 @@ Returns the total number of frames drawn.
Returns the frames per second of the running game.
.. _class_Engine_get_license_info:
- :ref:`Dictionary<class_dictionary>` **get_license_info** **(** **)** const
Returns Dictionary of licenses used by Godot and included third party components.
.. _class_Engine_get_license_text:
- :ref:`String<class_string>` **get_license_text** **(** **)** const
Returns Godot license text.
.. _class_Engine_get_main_loop:
- :ref:`MainLoop<class_mainloop>` **get_main_loop** **(** **)** const

View File

@@ -42,7 +42,7 @@ Member Functions
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_double<class_File_get_double>` **(** **)** const |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_error<class_File_get_error>` **(** **)** const |
| :ref:`Error<enum_@globalscope_error>` | :ref:`get_error<class_File_get_error>` **(** **)** const |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_float<class_File_get_float>` **(** **)** const |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -70,13 +70,13 @@ Member Functions
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_open<class_File_is_open>` **(** **)** const |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`open<class_File_open>` **(** :ref:`String<class_string>` path, :ref:`int<class_int>` flags **)** |
| :ref:`Error<enum_@globalscope_error>` | :ref:`open<class_File_open>` **(** :ref:`String<class_string>` path, :ref:`int<class_int>` flags **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`open_compressed<class_File_open_compressed>` **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`int<class_int>` compression_mode=0 **)** |
| :ref:`Error<enum_@globalscope_error>` | :ref:`open_compressed<class_File_open_compressed>` **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`int<class_int>` compression_mode=0 **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`open_encrypted<class_File_open_encrypted>` **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`PoolByteArray<class_poolbytearray>` key **)** |
| :ref:`Error<enum_@globalscope_error>` | :ref:`open_encrypted<class_File_open_encrypted>` **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`PoolByteArray<class_poolbytearray>` key **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`open_encrypted_with_pass<class_File_open_encrypted_with_pass>` **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`String<class_string>` pass **)** |
| :ref:`Error<enum_@globalscope_error>` | :ref:`open_encrypted_with_pass<class_File_open_encrypted_with_pass>` **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`String<class_string>` pass **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`seek<class_File_seek>` **(** :ref:`int<class_int>` position **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -232,7 +232,7 @@ Returns the next 64 bits from the file as a floating point number.
.. _class_File_get_error:
- :ref:`int<class_int>` **get_error** **(** **)** const
- :ref:`Error<enum_@globalscope_error>` **get_error** **(** **)** const
Returns the last error that happened when trying to perform operations. Compare with the ``ERR_FILE_*`` constants from :ref:`@GlobalScope<class_@globalscope>`.
@@ -316,25 +316,25 @@ Returns ``true`` if the file is currently opened.
.. _class_File_open:
- :ref:`int<class_int>` **open** **(** :ref:`String<class_string>` path, :ref:`int<class_int>` flags **)**
- :ref:`Error<enum_@globalscope_error>` **open** **(** :ref:`String<class_string>` path, :ref:`int<class_int>` flags **)**
Opens the file for writing or reading, depending on the flags.
.. _class_File_open_compressed:
- :ref:`int<class_int>` **open_compressed** **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`int<class_int>` compression_mode=0 **)**
- :ref:`Error<enum_@globalscope_error>` **open_compressed** **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`int<class_int>` compression_mode=0 **)**
Opens a compressed file for reading or writing. Use COMPRESSION\_\* constants to set ``compression_mode``.
.. _class_File_open_encrypted:
- :ref:`int<class_int>` **open_encrypted** **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`PoolByteArray<class_poolbytearray>` key **)**
- :ref:`Error<enum_@globalscope_error>` **open_encrypted** **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`PoolByteArray<class_poolbytearray>` key **)**
Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it.
.. _class_File_open_encrypted_with_pass:
- :ref:`int<class_int>` **open_encrypted_with_pass** **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`String<class_string>` pass **)**
- :ref:`Error<enum_@globalscope_error>` **open_encrypted_with_pass** **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`String<class_string>` pass **)**
Opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it.

View File

@@ -21,23 +21,25 @@ Internationalized font and text drawing support.
Member Functions
----------------
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw<class_Font_draw>` **(** :ref:`RID<class_rid>` canvas_item, :ref:`Vector2<class_vector2>` position, :ref:`String<class_string>` string, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :ref:`int<class_int>` clip_w=-1 **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`draw_char<class_Font_draw_char>` **(** :ref:`RID<class_rid>` canvas_item, :ref:`Vector2<class_vector2>` position, :ref:`int<class_int>` char, :ref:`int<class_int>` next=-1, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ) **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_ascent<class_Font_get_ascent>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_descent<class_Font_get_descent>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_height<class_Font_get_height>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_string_size<class_Font_get_string_size>` **(** :ref:`String<class_string>` string **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_distance_field_hint<class_Font_is_distance_field_hint>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update_changes<class_Font_update_changes>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw<class_Font_draw>` **(** :ref:`RID<class_rid>` canvas_item, :ref:`Vector2<class_vector2>` position, :ref:`String<class_string>` string, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :ref:`int<class_int>` clip_w=-1, :ref:`Color<class_color>` outline_modulate=Color( 1, 1, 1, 1 ) **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`draw_char<class_Font_draw_char>` **(** :ref:`RID<class_rid>` canvas_item, :ref:`Vector2<class_vector2>` position, :ref:`int<class_int>` char, :ref:`int<class_int>` next=-1, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` outline=false **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_ascent<class_Font_get_ascent>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_descent<class_Font_get_descent>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_height<class_Font_get_height>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_string_size<class_Font_get_string_size>` **(** :ref:`String<class_string>` string **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_outline<class_Font_has_outline>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_distance_field_hint<class_Font_is_distance_field_hint>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update_changes<class_Font_update_changes>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -49,13 +51,13 @@ Member Function Description
.. _class_Font_draw:
- void **draw** **(** :ref:`RID<class_rid>` canvas_item, :ref:`Vector2<class_vector2>` position, :ref:`String<class_string>` string, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :ref:`int<class_int>` clip_w=-1 **)** const
- void **draw** **(** :ref:`RID<class_rid>` canvas_item, :ref:`Vector2<class_vector2>` position, :ref:`String<class_string>` string, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :ref:`int<class_int>` clip_w=-1, :ref:`Color<class_color>` outline_modulate=Color( 1, 1, 1, 1 ) **)** const
Draw "string" into a canvas item using the font at a given position, with "modulate" color, and optionally clipping the width. "position" specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis.
.. _class_Font_draw_char:
- :ref:`float<class_float>` **draw_char** **(** :ref:`RID<class_rid>` canvas_item, :ref:`Vector2<class_vector2>` position, :ref:`int<class_int>` char, :ref:`int<class_int>` next=-1, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ) **)** const
- :ref:`float<class_float>` **draw_char** **(** :ref:`RID<class_rid>` canvas_item, :ref:`Vector2<class_vector2>` position, :ref:`int<class_int>` char, :ref:`int<class_int>` next=-1, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` outline=false **)** const
Draw character "char" into a canvas item using the font at a given position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "position" specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character.
@@ -83,6 +85,10 @@ Return the total font height (ascent plus descent) in pixels.
Return the size of a string, taking kerning and advance into account.
.. _class_Font_has_outline:
- :ref:`bool<class_bool>` **has_outline** **(** **)** const
.. _class_Font_is_distance_field_hint:
- :ref:`bool<class_bool>` **is_distance_field_hint** **(** **)** const

View File

@@ -22,9 +22,9 @@ Member Functions
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`build_box_planes<class_Geometry_build_box_planes>` **(** :ref:`Vector3<class_vector3>` extents **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`build_capsule_planes<class_Geometry_build_capsule_planes>` **(** :ref:`float<class_float>` radius, :ref:`float<class_float>` height, :ref:`int<class_int>` sides, :ref:`int<class_int>` lats, :ref:`int<class_int>` axis=2 **)** |
| :ref:`Array<class_array>` | :ref:`build_capsule_planes<class_Geometry_build_capsule_planes>` **(** :ref:`float<class_float>` radius, :ref:`float<class_float>` height, :ref:`int<class_int>` sides, :ref:`int<class_int>` lats, :ref:`Axis<enum_vector3_axis>` axis=2 **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`build_cylinder_planes<class_Geometry_build_cylinder_planes>` **(** :ref:`float<class_float>` radius, :ref:`float<class_float>` height, :ref:`int<class_int>` sides, :ref:`int<class_int>` axis=2 **)** |
| :ref:`Array<class_array>` | :ref:`build_cylinder_planes<class_Geometry_build_cylinder_planes>` **(** :ref:`float<class_float>` radius, :ref:`float<class_float>` height, :ref:`int<class_int>` sides, :ref:`Axis<enum_vector3_axis>` axis=2 **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`clip_polygon<class_Geometry_clip_polygon>` **(** :ref:`PoolVector3Array<class_poolvector3array>` points, :ref:`Plane<class_plane>` plane **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -44,6 +44,8 @@ Member Functions
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_uv84_normal_bit<class_Geometry_get_uv84_normal_bit>` **(** :ref:`Vector3<class_vector3>` normal **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`line_intersects_line_2d<class_Geometry_line_intersects_line_2d>` **(** :ref:`Vector2<class_vector2>` from_a, :ref:`Vector2<class_vector2>` dir_a, :ref:`Vector2<class_vector2>` from_b, :ref:`Vector2<class_vector2>` dir_b **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`make_atlas<class_Geometry_make_atlas>` **(** :ref:`PoolVector2Array<class_poolvector2array>` sizes **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`point_is_inside_triangle<class_Geometry_point_is_inside_triangle>` **(** :ref:`Vector2<class_vector2>` point, :ref:`Vector2<class_vector2>` a, :ref:`Vector2<class_vector2>` b, :ref:`Vector2<class_vector2>` c **)** const |
@@ -58,8 +60,6 @@ Member Functions
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`segment_intersects_segment_2d<class_Geometry_segment_intersects_segment_2d>` **(** :ref:`Vector2<class_vector2>` from_a, :ref:`Vector2<class_vector2>` to_a, :ref:`Vector2<class_vector2>` from_b, :ref:`Vector2<class_vector2>` to_b **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`line_intersects_line_2d<class_Geometry_line_intersects_line_2d>` **(** :ref:`Vector2<class_vector2>` from_a, :ref:`Vector2<class_vector2>` dir_a, :ref:`Vector2<class_vector2>` from_b, :ref:`Vector2<class_vector2>` dir_b **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`segment_intersects_sphere<class_Geometry_segment_intersects_sphere>` **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`Vector3<class_vector3>` sphere_position, :ref:`float<class_float>` sphere_radius **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`segment_intersects_triangle<class_Geometry_segment_intersects_triangle>` **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`Vector3<class_vector3>` a, :ref:`Vector3<class_vector3>` b, :ref:`Vector3<class_vector3>` c **)** |
@@ -78,13 +78,13 @@ Returns an array with 6 :ref:`Plane<class_plane>`\ s that describe the sides of
.. _class_Geometry_build_capsule_planes:
- :ref:`Array<class_array>` **build_capsule_planes** **(** :ref:`float<class_float>` radius, :ref:`float<class_float>` height, :ref:`int<class_int>` sides, :ref:`int<class_int>` lats, :ref:`int<class_int>` axis=2 **)**
- :ref:`Array<class_array>` **build_capsule_planes** **(** :ref:`float<class_float>` radius, :ref:`float<class_float>` height, :ref:`int<class_int>` sides, :ref:`int<class_int>` lats, :ref:`Axis<enum_vector3_axis>` axis=2 **)**
Returns an array of :ref:`Plane<class_plane>`\ s closely bounding a faceted capsule centered at the origin with radius ``radius`` and height ``height``. The parameter ``sides`` defines how many planes will be generated for the side part of the capsule, whereas ``lats`` gives the number of latitudinal steps at the bottom and top of the capsule. The parameter ``axis`` describes the axis along which the capsule is oriented (0 for X, 1 for Y, 2 for Z).
.. _class_Geometry_build_cylinder_planes:
- :ref:`Array<class_array>` **build_cylinder_planes** **(** :ref:`float<class_float>` radius, :ref:`float<class_float>` height, :ref:`int<class_int>` sides, :ref:`int<class_int>` axis=2 **)**
- :ref:`Array<class_array>` **build_cylinder_planes** **(** :ref:`float<class_float>` radius, :ref:`float<class_float>` height, :ref:`int<class_int>` sides, :ref:`Axis<enum_vector3_axis>` axis=2 **)**
Returns an array of :ref:`Plane<class_plane>`\ s closely bounding a faceted cylinder centered at the origin with radius ``radius`` and height ``height``. The parameter ``sides`` defines how many planes will be generated for the round part of the cylinder. The parameter ``axis`` describes the axis along which the cylinder is oriented (0 for X, 1 for Y, 2 for Z).
@@ -140,6 +140,12 @@ Given the two 2d segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two
- :ref:`int<class_int>` **get_uv84_normal_bit** **(** :ref:`Vector3<class_vector3>` normal **)**
.. _class_Geometry_line_intersects_line_2d:
- :ref:`Variant<class_variant>` **line_intersects_line_2d** **(** :ref:`Vector2<class_vector2>` from_a, :ref:`Vector2<class_vector2>` dir_a, :ref:`Vector2<class_vector2>` from_b, :ref:`Vector2<class_vector2>` dir_b **)**
Checks if the two lines (``from_a``, ``dir_a``) and (``from_b``, ``dir_b``) intersect. If yes, return the point of intersection as :ref:`Vector2<class_vector2>`. If no intersection takes place, returns an empty :ref:`Variant<class_variant>`. Note that the lines are specified using direction vectors, not end points.
.. _class_Geometry_make_atlas:
- :ref:`Dictionary<class_dictionary>` **make_atlas** **(** :ref:`PoolVector2Array<class_poolvector2array>` sizes **)**
@@ -182,12 +188,6 @@ Checks if the segment (``from``, ``to``) intersects the cylinder with height ``h
Checks if the two segments (``from_a``, ``to_a``) and (``from_b``, ``to_b``) intersect. If yes, return the point of intersection as :ref:`Vector2<class_vector2>`. If no intersection takes place, returns an empty :ref:`Variant<class_variant>`.
.. _class_Geometry_line_intersects_line_2d:
- :ref:`Variant<class_variant>` **line_intersects_line_2d** **(** :ref:`Vector2<class_vector2>` from_a, :ref:`Vector2<class_vector2>` dir_a, :ref:`Vector2<class_vector2>` from_b, :ref:`Vector2<class_vector2>` dir_b **)**
Checks if the two lines (``from_a``, ``dir_a``) and (``from_b``, ``dir_b``) intersect. If yes, return the point of intersection as :ref:`Vector2<class_vector2>`. If no intersection takes place, returns an empty :ref:`Variant<class_variant>`. Note that the lines are specified using direction vectors, not end points.
.. _class_Geometry_segment_intersects_sphere:
- :ref:`PoolVector3Array<class_poolvector3array>` **segment_intersects_sphere** **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`Vector3<class_vector3>` sphere_position, :ref:`float<class_float>` sphere_radius **)**

View File

@@ -19,33 +19,33 @@ GraphEdit is an area capable of showing various GraphNodes. It manages connectio
Member Functions
----------------
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_valid_connection_type<class_GraphEdit_add_valid_connection_type>` **(** :ref:`int<class_int>` from_type, :ref:`int<class_int>` to_type **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_valid_left_disconnect_type<class_GraphEdit_add_valid_left_disconnect_type>` **(** :ref:`int<class_int>` type **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_valid_right_disconnect_type<class_GraphEdit_add_valid_right_disconnect_type>` **(** :ref:`int<class_int>` type **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_connections<class_GraphEdit_clear_connections>` **(** **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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 **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_valid_connection_type<class_GraphEdit_is_valid_connection_type>` **(** :ref:`int<class_int>` from_type, :ref:`int<class_int>` to_type **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_valid_connection_type<class_GraphEdit_remove_valid_connection_type>` **(** :ref:`int<class_int>` from_type, :ref:`int<class_int>` to_type **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_valid_left_disconnect_type<class_GraphEdit_remove_valid_left_disconnect_type>` **(** :ref:`int<class_int>` type **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_valid_right_disconnect_type<class_GraphEdit_remove_valid_right_disconnect_type>` **(** :ref:`int<class_int>` type **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_selected<class_GraphEdit_set_selected>` **(** :ref:`Node<class_node>` node **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_valid_connection_type<class_GraphEdit_add_valid_connection_type>` **(** :ref:`int<class_int>` from_type, :ref:`int<class_int>` to_type **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_valid_left_disconnect_type<class_GraphEdit_add_valid_left_disconnect_type>` **(** :ref:`int<class_int>` type **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_valid_right_disconnect_type<class_GraphEdit_add_valid_right_disconnect_type>` **(** :ref:`int<class_int>` type **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_connections<class_GraphEdit_clear_connections>` **(** **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :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 **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_valid_connection_type<class_GraphEdit_is_valid_connection_type>` **(** :ref:`int<class_int>` from_type, :ref:`int<class_int>` to_type **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_valid_connection_type<class_GraphEdit_remove_valid_connection_type>` **(** :ref:`int<class_int>` from_type, :ref:`int<class_int>` to_type **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_valid_left_disconnect_type<class_GraphEdit_remove_valid_left_disconnect_type>` **(** :ref:`int<class_int>` type **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_valid_right_disconnect_type<class_GraphEdit_remove_valid_right_disconnect_type>` **(** :ref:`int<class_int>` type **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_selected<class_GraphEdit_set_selected>` **(** :ref:`Node<class_node>` node **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -167,7 +167,7 @@ Remove all connections between nodes.
.. _class_GraphEdit_connect_node:
- :ref:`int<class_int>` **connect_node** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_port, :ref:`String<class_string>` to, :ref:`int<class_int>` to_port **)**
- :ref:`Error<enum_@globalscope_error>` **connect_node** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_port, :ref:`String<class_string>` to, :ref:`int<class_int>` to_port **)**
Create a connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode. If the connection already exists, no connection is created.

View File

@@ -16,6 +16,13 @@ Brief Description
Grid container used to arrange elements in a grid like layout.
Member Functions
----------------
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Control<class_control>` | :ref:`get_child_control_at_cell<class_GridContainer_get_child_control_at_cell>` **(** :ref:`int<class_int>` row, :ref:`int<class_int>` column **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -29,3 +36,11 @@ Description
Grid container will arrange its children in a grid like structure, the grid columns are specified using the :ref:`set_columns<class_GridContainer_set_columns>` method and the number of rows will be equal to the number of children in the container divided by the number of columns, for example: if the container has 5 children, and 2 columns, there will be 3 rows in the container. Notice that grid layout will preserve the columns and rows for every size of the container.
Member Function Description
---------------------------
.. _class_GridContainer_get_child_control_at_cell:
- :ref:`Control<class_control>` **get_child_control_at_cell** **(** :ref:`int<class_int>` row, :ref:`int<class_int>` column **)**

View File

@@ -48,7 +48,7 @@ Member Functions
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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_clip<class_GridMap_set_clip>` **(** :ref:`bool<class_bool>` enabled, :ref:`bool<class_bool>` clipabove=true, :ref:`int<class_int>` floor=0, :ref:`Axis<enum_vector3_axis>` axis=0 **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_layer_bit<class_GridMap_set_collision_layer_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -190,7 +190,7 @@ Optionally, the item's orientation can be passed.
.. _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 **)**
- void **set_clip** **(** :ref:`bool<class_bool>` enabled, :ref:`bool<class_bool>` clipabove=true, :ref:`int<class_int>` floor=0, :ref:`Axis<enum_vector3_axis>` axis=0 **)**
.. _class_GridMap_set_collision_layer_bit:

View File

@@ -19,37 +19,37 @@ Hyper-text transfer protocol client.
Member Functions
----------------
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`close<class_HTTPClient_close>` **(** **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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:`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 |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_response_headers<class_HTTPClient_get_response_headers>` **(** **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_response_headers_as_dictionary<class_HTTPClient_get_response_headers_as_dictionary>` **(** **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_status<class_HTTPClient_get_status>` **(** **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_response<class_HTTPClient_has_response>` **(** **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_response_chunked<class_HTTPClient_is_response_chunked>` **(** **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`poll<class_HTTPClient_poll>` **(** **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`query_string_from_dict<class_HTTPClient_query_string_from_dict>` **(** :ref:`Dictionary<class_dictionary>` fields **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`read_response_body_chunk<class_HTTPClient_read_response_body_chunk>` **(** **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`request<class_HTTPClient_request>` **(** :ref:`int<class_int>` method, :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` headers, :ref:`String<class_string>` body="" **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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_read_chunk_size<class_HTTPClient_set_read_chunk_size>` **(** :ref:`int<class_int>` bytes **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`close<class_HTTPClient_close>` **(** **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :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:`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 |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_response_headers<class_HTTPClient_get_response_headers>` **(** **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_response_headers_as_dictionary<class_HTTPClient_get_response_headers_as_dictionary>` **(** **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Status<enum_httpclient_status>` | :ref:`get_status<class_HTTPClient_get_status>` **(** **)** const |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_response<class_HTTPClient_has_response>` **(** **)** const |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_response_chunked<class_HTTPClient_is_response_chunked>` **(** **)** const |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`poll<class_HTTPClient_poll>` **(** **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`query_string_from_dict<class_HTTPClient_query_string_from_dict>` **(** :ref:`Dictionary<class_dictionary>` fields **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`read_response_body_chunk<class_HTTPClient_read_response_body_chunk>` **(** **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`request<class_HTTPClient_request>` **(** :ref:`Method<enum_httpclient_method>` method, :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` headers, :ref:`String<class_string>` body="" **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`request_raw<class_HTTPClient_request_raw>` **(** :ref:`Method<enum_httpclient_method>` method, :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` headers, :ref:`PoolByteArray<class_poolbytearray>` body **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_read_chunk_size<class_HTTPClient_set_read_chunk_size>` **(** :ref:`int<class_int>` bytes **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -185,7 +185,7 @@ Closes the current connection, allowing reuse of this ``HTTPClient``.
.. _class_HTTPClient_connect_to_host:
- :ref:`int<class_int>` **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:`Error<enum_@globalscope_error>` **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 **)**
Connect to a host. This needs to be done before any requests are sent.
@@ -225,7 +225,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
.. _class_HTTPClient_get_status:
- :ref:`int<class_int>` **get_status** **(** **)** const
- :ref:`Status<enum_httpclient_status>` **get_status** **(** **)** const
Returns a STATUS\_\* enum constant. Need to call :ref:`poll<class_HTTPClient_poll>` in order to get status updates.
@@ -243,7 +243,7 @@ If ``true`` this ``HTTPClient`` has a response that is chunked.
.. _class_HTTPClient_poll:
- :ref:`int<class_int>` **poll** **(** **)**
- :ref:`Error<enum_@globalscope_error>` **poll** **(** **)**
This needs to be called in order to have any request processed. Check results with :ref:`get_status<class_HTTPClient_get_status>`
@@ -275,7 +275,7 @@ Reads one chunk from the response.
.. _class_HTTPClient_request:
- :ref:`int<class_int>` **request** **(** :ref:`int<class_int>` method, :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` headers, :ref:`String<class_string>` body="" **)**
- :ref:`Error<enum_@globalscope_error>` **request** **(** :ref:`Method<enum_httpclient_method>` method, :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` headers, :ref:`String<class_string>` body="" **)**
Sends a request to the connected host. The URL parameter is just the part after the host, so for ``http://somehost.com/index.php``, it is ``index.php``.
@@ -292,7 +292,7 @@ To create a POST request with query strings to push to the server, do:
.. _class_HTTPClient_request_raw:
- :ref:`int<class_int>` **request_raw** **(** :ref:`int<class_int>` method, :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` headers, :ref:`PoolByteArray<class_poolbytearray>` body **)**
- :ref:`Error<enum_@globalscope_error>` **request_raw** **(** :ref:`Method<enum_httpclient_method>` method, :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` headers, :ref:`PoolByteArray<class_poolbytearray>` body **)**
Sends a raw request to the connected host. The URL parameter is just the part after the host, so for ``http://somehost.com/index.php``, it is ``index.php``.

View File

@@ -19,17 +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:`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:`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:`Status<enum_httpclient_status>` | :ref:`get_http_client_status<class_HTTPRequest_get_http_client_status>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :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:`Method<enum_httpclient_method>` method=0, :ref:`String<class_string>` request_data="" **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -112,13 +112,13 @@ Returns the amount of bytes this HTTPRequest downloaded.
.. _class_HTTPRequest_get_http_client_status:
- :ref:`int<class_int>` **get_http_client_status** **(** **)** const
- :ref:`Status<enum_httpclient_status>` **get_http_client_status** **(** **)** const
Returns the current status of the underlying :ref:`HTTPClient<class_httpclient>`. See ``STATUS_*`` enum on :ref:`HTTPClient<class_httpclient>`.
.. _class_HTTPRequest_request:
- :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="" **)**
- :ref:`Error<enum_@globalscope_error>` **request** **(** :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` custom_headers=PoolStringArray( ), :ref:`bool<class_bool>` ssl_validate_domain=true, :ref:`Method<enum_httpclient_method>` method=0, :ref:`String<class_string>` request_data="" **)**
Creates request on the underlying :ref:`HTTPClient<class_httpclient>`. If there is no configuration errors, it tries to connect using :ref:`HTTPClient.connect_to_host<class_HTTPClient_connect_to_host>` and passes parameters onto :ref:`HTTPClient.request<class_HTTPClient_request>`.

View File

@@ -19,99 +19,103 @@ Image datatype.
Member Functions
----------------
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend_rect<class_Image_blend_rect>` **(** :ref:`Image<class_image>` src, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dst **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend_rect_mask<class_Image_blend_rect_mask>` **(** :ref:`Image<class_image>` src, :ref:`Image<class_image>` mask, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dst **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blit_rect<class_Image_blit_rect>` **(** :ref:`Image<class_image>` src, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dst **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blit_rect_mask<class_Image_blit_rect_mask>` **(** :ref:`Image<class_image>` src, :ref:`Image<class_image>` mask, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dst **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`bumpmap_to_normalmap<class_Image_bumpmap_to_normalmap>` **(** :ref:`float<class_float>` bump_scale=1.0 **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_mipmaps<class_Image_clear_mipmaps>` **(** **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`compress<class_Image_compress>` **(** :ref:`int<class_int>` mode, :ref:`int<class_int>` source, :ref:`float<class_float>` lossy_quality **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`convert<class_Image_convert>` **(** :ref:`int<class_int>` format **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`copy_from<class_Image_copy_from>` **(** :ref:`Image<class_image>` src **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create<class_Image_create>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` use_mipmaps, :ref:`int<class_int>` format **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create_from_data<class_Image_create_from_data>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` use_mipmaps, :ref:`int<class_int>` format, :ref:`PoolByteArray<class_poolbytearray>` data **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`crop<class_Image_crop>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`decompress<class_Image_decompress>` **(** **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`detect_alpha<class_Image_detect_alpha>` **(** **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`expand_x2_hq2x<class_Image_expand_x2_hq2x>` **(** **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`fill<class_Image_fill>` **(** :ref:`Color<class_color>` color **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`fix_alpha_edges<class_Image_fix_alpha_edges>` **(** **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`flip_x<class_Image_flip_x>` **(** **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`flip_y<class_Image_flip_y>` **(** **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`generate_mipmaps<class_Image_generate_mipmaps>` **(** **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`get_data<class_Image_get_data>` **(** **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_format<class_Image_get_format>` **(** **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_height<class_Image_get_height>` **(** **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mipmap_offset<class_Image_get_mipmap_offset>` **(** :ref:`int<class_int>` mipmap **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_pixel<class_Image_get_pixel>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_image>` | :ref:`get_rect<class_Image_get_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_size<class_Image_get_size>` **(** **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_used_rect<class_Image_get_used_rect>` **(** **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_width<class_Image_get_width>` **(** **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_mipmaps<class_Image_has_mipmaps>` **(** **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_compressed<class_Image_is_compressed>` **(** **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_empty<class_Image_is_empty>` **(** **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_invisible<class_Image_is_invisible>` **(** **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`load<class_Image_load>` **(** :ref:`String<class_string>` path **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`load_jpg_from_buffer<class_Image_load_jpg_from_buffer>` **(** :ref:`PoolByteArray<class_poolbytearray>` buffer **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`load_png_from_buffer<class_Image_load_png_from_buffer>` **(** :ref:`PoolByteArray<class_poolbytearray>` buffer **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`lock<class_Image_lock>` **(** **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`normalmap_to_xy<class_Image_normalmap_to_xy>` **(** **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`premultiply_alpha<class_Image_premultiply_alpha>` **(** **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`resize<class_Image_resize>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` interpolation=1 **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`resize_to_po2<class_Image_resize_to_po2>` **(** :ref:`bool<class_bool>` square=false **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`save_png<class_Image_save_png>` **(** :ref:`String<class_string>` path **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pixel<class_Image_set_pixel>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`Color<class_color>` color **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`shrink_x2<class_Image_shrink_x2>` **(** **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`srgb_to_linear<class_Image_srgb_to_linear>` **(** **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unlock<class_Image_unlock>` **(** **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend_rect<class_Image_blend_rect>` **(** :ref:`Image<class_image>` src, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dst **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend_rect_mask<class_Image_blend_rect_mask>` **(** :ref:`Image<class_image>` src, :ref:`Image<class_image>` mask, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dst **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blit_rect<class_Image_blit_rect>` **(** :ref:`Image<class_image>` src, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dst **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blit_rect_mask<class_Image_blit_rect_mask>` **(** :ref:`Image<class_image>` src, :ref:`Image<class_image>` mask, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dst **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`bumpmap_to_normalmap<class_Image_bumpmap_to_normalmap>` **(** :ref:`float<class_float>` bump_scale=1.0 **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_mipmaps<class_Image_clear_mipmaps>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`compress<class_Image_compress>` **(** :ref:`CompressMode<enum_image_compressmode>` mode, :ref:`CompressSource<enum_image_compresssource>` source, :ref:`float<class_float>` lossy_quality **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`convert<class_Image_convert>` **(** :ref:`Format<enum_image_format>` format **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`copy_from<class_Image_copy_from>` **(** :ref:`Image<class_image>` src **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create<class_Image_create>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` use_mipmaps, :ref:`Format<enum_image_format>` format **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create_from_data<class_Image_create_from_data>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` use_mipmaps, :ref:`Format<enum_image_format>` format, :ref:`PoolByteArray<class_poolbytearray>` data **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`crop<class_Image_crop>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`decompress<class_Image_decompress>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AlphaMode<enum_image_alphamode>` | :ref:`detect_alpha<class_Image_detect_alpha>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`expand_x2_hq2x<class_Image_expand_x2_hq2x>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`fill<class_Image_fill>` **(** :ref:`Color<class_color>` color **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`fix_alpha_edges<class_Image_fix_alpha_edges>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`flip_x<class_Image_flip_x>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`flip_y<class_Image_flip_y>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`generate_mipmaps<class_Image_generate_mipmaps>` **(** :ref:`bool<class_bool>` renormalize=false **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`get_data<class_Image_get_data>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Format<enum_image_format>` | :ref:`get_format<class_Image_get_format>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_height<class_Image_get_height>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mipmap_offset<class_Image_get_mipmap_offset>` **(** :ref:`int<class_int>` mipmap **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_pixel<class_Image_get_pixel>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_pixelv<class_Image_get_pixelv>` **(** :ref:`Vector2<class_vector2>` src **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_image>` | :ref:`get_rect<class_Image_get_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_size<class_Image_get_size>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_used_rect<class_Image_get_used_rect>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_width<class_Image_get_width>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_mipmaps<class_Image_has_mipmaps>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_compressed<class_Image_is_compressed>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_empty<class_Image_is_empty>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_invisible<class_Image_is_invisible>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`load<class_Image_load>` **(** :ref:`String<class_string>` path **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`load_jpg_from_buffer<class_Image_load_jpg_from_buffer>` **(** :ref:`PoolByteArray<class_poolbytearray>` buffer **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`load_png_from_buffer<class_Image_load_png_from_buffer>` **(** :ref:`PoolByteArray<class_poolbytearray>` buffer **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`lock<class_Image_lock>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`normalmap_to_xy<class_Image_normalmap_to_xy>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`premultiply_alpha<class_Image_premultiply_alpha>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`resize<class_Image_resize>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`Interpolation<enum_image_interpolation>` interpolation=1 **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`resize_to_po2<class_Image_resize_to_po2>` **(** :ref:`bool<class_bool>` square=false **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`save_png<class_Image_save_png>` **(** :ref:`String<class_string>` path **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pixel<class_Image_set_pixel>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`Color<class_color>` color **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pixelv<class_Image_set_pixelv>` **(** :ref:`Vector2<class_vector2>` dst, :ref:`Color<class_color>` color **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`shrink_x2<class_Image_shrink_x2>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`srgb_to_linear<class_Image_srgb_to_linear>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unlock<class_Image_unlock>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -246,13 +250,13 @@ Removes the image's mipmaps.
.. _class_Image_compress:
- :ref:`int<class_int>` **compress** **(** :ref:`int<class_int>` mode, :ref:`int<class_int>` source, :ref:`float<class_float>` lossy_quality **)**
- :ref:`Error<enum_@globalscope_error>` **compress** **(** :ref:`CompressMode<enum_image_compressmode>` mode, :ref:`CompressSource<enum_image_compresssource>` source, :ref:`float<class_float>` lossy_quality **)**
Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. See ``COMPRESS_*`` constants.
.. _class_Image_convert:
- void **convert** **(** :ref:`int<class_int>` format **)**
- void **convert** **(** :ref:`Format<enum_image_format>` format **)**
Converts the image's format. See ``FORMAT_*`` constants.
@@ -264,13 +268,13 @@ Copies ``src`` image to this image.
.. _class_Image_create:
- void **create** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` use_mipmaps, :ref:`int<class_int>` format **)**
- void **create** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` use_mipmaps, :ref:`Format<enum_image_format>` format **)**
Creates an empty image of given size and format. See ``FORMAT_*`` constants. If ``use_mipmaps`` is true then generate mipmaps for this image. See the ``generate_mipmaps`` method.
.. _class_Image_create_from_data:
- void **create_from_data** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` use_mipmaps, :ref:`int<class_int>` format, :ref:`PoolByteArray<class_poolbytearray>` data **)**
- void **create_from_data** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` use_mipmaps, :ref:`Format<enum_image_format>` format, :ref:`PoolByteArray<class_poolbytearray>` data **)**
Creates a new image of given size and format. See ``FORMAT_*`` constants. Fills the image with the given raw data. If ``use_mipmaps`` is true then generate mipmaps for this image. See the ``generate_mipmaps`` method.
@@ -282,13 +286,13 @@ Crops the image to the given ``width`` and ``height``. If the specified size is
.. _class_Image_decompress:
- :ref:`int<class_int>` **decompress** **(** **)**
- :ref:`Error<enum_@globalscope_error>` **decompress** **(** **)**
Decompresses the image if it is compressed. Returns an error if decompress function is not available.
.. _class_Image_detect_alpha:
- :ref:`int<class_int>` **detect_alpha** **(** **)** const
- :ref:`AlphaMode<enum_image_alphamode>` **detect_alpha** **(** **)** const
Returns ALPHA_BLEND if the image has data for alpha values. Returns ALPHA_BIT if all the alpha values are below a certain threshold or the maximum value. Returns ALPHA_NONE if no data for alpha values is found.
@@ -324,7 +328,7 @@ Flips the image vertically.
.. _class_Image_generate_mipmaps:
- :ref:`int<class_int>` **generate_mipmaps** **(** **)**
- :ref:`Error<enum_@globalscope_error>` **generate_mipmaps** **(** :ref:`bool<class_bool>` renormalize=false **)**
Generates mipmaps for the image. Mipmaps are pre-calculated and lower resolution copies of the image. Mipmaps are automatically used if the image needs to be scaled down when rendered. This improves image quality and the performance of the rendering. Returns an error if the image is compressed, in a custom format or if the image's width/height is 0.
@@ -336,7 +340,7 @@ Returns the image's raw data.
.. _class_Image_get_format:
- :ref:`int<class_int>` **get_format** **(** **)** const
- :ref:`Format<enum_image_format>` **get_format** **(** **)** const
Returns the images format. See ``FORMAT_*`` constants.
@@ -358,6 +362,10 @@ Returns the offset where the image's mipmap with index ``mipmap`` is stored in t
Returns the color of the pixel at ``(x, y)`` if the image is locked. If the image is unlocked it always returns a :ref:`Color<class_color>` with the value ``(0, 0, 0, 1.0)``.
.. _class_Image_get_pixelv:
- :ref:`Color<class_color>` **get_pixelv** **(** :ref:`Vector2<class_vector2>` src **)** const
.. _class_Image_get_rect:
- :ref:`Image<class_image>` **get_rect** **(** :ref:`Rect2<class_rect2>` rect **)** const
@@ -408,17 +416,21 @@ Returns ``true`` if all the image's pixels have an alpha value of 0. Returns ``f
.. _class_Image_load:
- :ref:`int<class_int>` **load** **(** :ref:`String<class_string>` path **)**
- :ref:`Error<enum_@globalscope_error>` **load** **(** :ref:`String<class_string>` path **)**
Loads an image from file ``path``.
.. _class_Image_load_jpg_from_buffer:
- :ref:`int<class_int>` **load_jpg_from_buffer** **(** :ref:`PoolByteArray<class_poolbytearray>` buffer **)**
- :ref:`Error<enum_@globalscope_error>` **load_jpg_from_buffer** **(** :ref:`PoolByteArray<class_poolbytearray>` buffer **)**
Loads an image from the binary contents of a JPEG file.
.. _class_Image_load_png_from_buffer:
- :ref:`int<class_int>` **load_png_from_buffer** **(** :ref:`PoolByteArray<class_poolbytearray>` buffer **)**
- :ref:`Error<enum_@globalscope_error>` **load_png_from_buffer** **(** :ref:`PoolByteArray<class_poolbytearray>` buffer **)**
Loads an image from the binary contents of a PNG file.
.. _class_Image_lock:
@@ -440,7 +452,7 @@ Multiplies color values with alpha values. Resulting color values for a pixel ar
.. _class_Image_resize:
- void **resize** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` interpolation=1 **)**
- void **resize** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`Interpolation<enum_image_interpolation>` interpolation=1 **)**
Resizes the image to the given ``width`` and ``height``. New pixels are calculated using ``interpolation``. See ``interpolation`` constants.
@@ -452,7 +464,7 @@ Resizes the image to the nearest power of 2 for the width and height. If ``squar
.. _class_Image_save_png:
- :ref:`int<class_int>` **save_png** **(** :ref:`String<class_string>` path **)** const
- :ref:`Error<enum_@globalscope_error>` **save_png** **(** :ref:`String<class_string>` path **)** const
Saves the image as a PNG file to ``path``.
@@ -471,6 +483,10 @@ Sets the :ref:`Color<class_color>` of the pixel at ``(x, y)`` if the image is lo
img.unlock()
img.set_pixel(x, y, color) # Does not have an effect
.. _class_Image_set_pixelv:
- void **set_pixelv** **(** :ref:`Vector2<class_vector2>` dst, :ref:`Color<class_color>` color **)**
.. _class_Image_shrink_x2:
- void **shrink_x2** **(** **)**

View File

@@ -19,19 +19,19 @@ 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 |
+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 **)** |
+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create<class_ImageTexture_create>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`Format<enum_image_format>` 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:`Format<enum_image_format>` | :ref:`get_format<class_ImageTexture_get_format>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :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
----------------
@@ -67,7 +67,7 @@ Member Function Description
.. _class_ImageTexture_create:
- void **create** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` format, :ref:`int<class_int>` flags=7 **)**
- void **create** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`Format<enum_image_format>` format, :ref:`int<class_int>` flags=7 **)**
Create a new ``ImageTexture`` with "width" and "height".
@@ -83,15 +83,15 @@ Create a new ``ImageTexture`` from an :ref:`Image<class_image>` with "flags" fro
.. _class_ImageTexture_get_format:
- :ref:`int<class_int>` **get_format** **(** **)** const
- :ref:`Format<enum_image_format>` **get_format** **(** **)** const
Return the format of the ``ImageTexture``, one of :ref:`Image<class_image>`.FORMAT\_\*.
.. _class_ImageTexture_load:
- void **load** **(** :ref:`String<class_string>` path **)**
- :ref:`Error<enum_@globalscope_error>` **load** **(** :ref:`String<class_string>` path **)**
Load an ``ImageTexture``.
Load an ``ImageTexture`` from a file path.
.. _class_ImageTexture_set_data:

View File

@@ -24,7 +24,7 @@ Member Functions
+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_vertex<class_ImmediateGeometry_add_vertex>` **(** :ref:`Vector3<class_vector3>` position **)** |
+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`begin<class_ImmediateGeometry_begin>` **(** :ref:`int<class_int>` primitive, :ref:`Texture<class_texture>` texture=null **)** |
| void | :ref:`begin<class_ImmediateGeometry_begin>` **(** :ref:`PrimitiveType<enum_mesh_primitivetype>` primitive, :ref:`Texture<class_texture>` texture=null **)** |
+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_ImmediateGeometry_clear>` **(** **)** |
+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -63,7 +63,7 @@ Adds a vertex with the currently set color/uv/etc.
.. _class_ImmediateGeometry_begin:
- void **begin** **(** :ref:`int<class_int>` primitive, :ref:`Texture<class_texture>` texture=null **)**
- void **begin** **(** :ref:`PrimitiveType<enum_mesh_primitivetype>` primitive, :ref:`Texture<class_texture>` texture=null **)**
Begin drawing (And optionally pass a texture override). When done call end(). For more information on how this works, search for glBegin() glEnd() references.

View File

@@ -21,77 +21,81 @@ A Singleton that deals with inputs.
Member Functions
----------------
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_press<class_Input_action_press>` **(** :ref:`String<class_string>` action **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_release<class_Input_action_release>` **(** :ref:`String<class_string>` action **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_joy_mapping<class_Input_add_joy_mapping>` **(** :ref:`String<class_string>` mapping, :ref:`bool<class_bool>` update_existing=false **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_accelerometer<class_Input_get_accelerometer>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_connected_joypads<class_Input_get_connected_joypads>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_gravity<class_Input_get_gravity>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_gyroscope<class_Input_get_gyroscope>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_joy_axis<class_Input_get_joy_axis>` **(** :ref:`int<class_int>` device, :ref:`int<class_int>` axis **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_joy_axis_index_from_string<class_Input_get_joy_axis_index_from_string>` **(** :ref:`String<class_string>` axis **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_joy_axis_string<class_Input_get_joy_axis_string>` **(** :ref:`int<class_int>` axis_index **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_joy_button_index_from_string<class_Input_get_joy_button_index_from_string>` **(** :ref:`String<class_string>` button **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_joy_button_string<class_Input_get_joy_button_string>` **(** :ref:`int<class_int>` button_index **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_joy_guid<class_Input_get_joy_guid>` **(** :ref:`int<class_int>` device **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_joy_name<class_Input_get_joy_name>` **(** :ref:`int<class_int>` device **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_joy_vibration_duration<class_Input_get_joy_vibration_duration>` **(** :ref:`int<class_int>` device **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_joy_vibration_strength<class_Input_get_joy_vibration_strength>` **(** :ref:`int<class_int>` device **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_last_mouse_speed<class_Input_get_last_mouse_speed>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_magnetometer<class_Input_get_magnetometer>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mouse_button_mask<class_Input_get_mouse_button_mask>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mouse_mode<class_Input_get_mouse_mode>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_just_pressed<class_Input_is_action_just_pressed>` **(** :ref:`String<class_string>` action **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_just_released<class_Input_is_action_just_released>` **(** :ref:`String<class_string>` action **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_Input_is_action_pressed>` **(** :ref:`String<class_string>` action **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_joy_button_pressed<class_Input_is_joy_button_pressed>` **(** :ref:`int<class_int>` device, :ref:`int<class_int>` button **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_joy_known<class_Input_is_joy_known>` **(** :ref:`int<class_int>` device **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_key_pressed<class_Input_is_key_pressed>` **(** :ref:`int<class_int>` scancode **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_mouse_button_pressed<class_Input_is_mouse_button_pressed>` **(** :ref:`int<class_int>` button **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`joy_connection_changed<class_Input_joy_connection_changed>` **(** :ref:`int<class_int>` device, :ref:`bool<class_bool>` connected, :ref:`String<class_string>` name, :ref:`String<class_string>` guid **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`parse_input_event<class_Input_parse_input_event>` **(** :ref:`InputEvent<class_inputevent>` event **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_joy_mapping<class_Input_remove_joy_mapping>` **(** :ref:`String<class_string>` guid **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_mouse_cursor<class_Input_set_custom_mouse_cursor>` **(** :ref:`Resource<class_resource>` image, :ref:`int<class_int>` shape=0, :ref:`Vector2<class_vector2>` hotspot=Vector2( 0, 0 ) **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mouse_mode<class_Input_set_mouse_mode>` **(** :ref:`int<class_int>` mode **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`start_joy_vibration<class_Input_start_joy_vibration>` **(** :ref:`int<class_int>` device, :ref:`float<class_float>` weak_magnitude, :ref:`float<class_float>` strong_magnitude, :ref:`float<class_float>` duration=0 **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop_joy_vibration<class_Input_stop_joy_vibration>` **(** :ref:`int<class_int>` device **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`warp_mouse_position<class_Input_warp_mouse_position>` **(** :ref:`Vector2<class_vector2>` to **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_press<class_Input_action_press>` **(** :ref:`String<class_string>` action **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_release<class_Input_action_release>` **(** :ref:`String<class_string>` action **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_joy_mapping<class_Input_add_joy_mapping>` **(** :ref:`String<class_string>` mapping, :ref:`bool<class_bool>` update_existing=false **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_accelerometer<class_Input_get_accelerometer>` **(** **)** const |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_action_strength<class_Input_get_action_strength>` **(** :ref:`String<class_string>` action **)** const |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_connected_joypads<class_Input_get_connected_joypads>` **(** **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_gravity<class_Input_get_gravity>` **(** **)** const |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_gyroscope<class_Input_get_gyroscope>` **(** **)** const |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_joy_axis<class_Input_get_joy_axis>` **(** :ref:`int<class_int>` device, :ref:`int<class_int>` axis **)** const |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_joy_axis_index_from_string<class_Input_get_joy_axis_index_from_string>` **(** :ref:`String<class_string>` axis **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_joy_axis_string<class_Input_get_joy_axis_string>` **(** :ref:`int<class_int>` axis_index **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_joy_button_index_from_string<class_Input_get_joy_button_index_from_string>` **(** :ref:`String<class_string>` button **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_joy_button_string<class_Input_get_joy_button_string>` **(** :ref:`int<class_int>` button_index **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_joy_guid<class_Input_get_joy_guid>` **(** :ref:`int<class_int>` device **)** const |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_joy_name<class_Input_get_joy_name>` **(** :ref:`int<class_int>` device **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_joy_vibration_duration<class_Input_get_joy_vibration_duration>` **(** :ref:`int<class_int>` device **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_joy_vibration_strength<class_Input_get_joy_vibration_strength>` **(** :ref:`int<class_int>` device **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_last_mouse_speed<class_Input_get_last_mouse_speed>` **(** **)** const |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_magnetometer<class_Input_get_magnetometer>` **(** **)** const |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mouse_button_mask<class_Input_get_mouse_button_mask>` **(** **)** const |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`MouseMode<enum_input_mousemode>` | :ref:`get_mouse_mode<class_Input_get_mouse_mode>` **(** **)** const |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_just_pressed<class_Input_is_action_just_pressed>` **(** :ref:`String<class_string>` action **)** const |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_just_released<class_Input_is_action_just_released>` **(** :ref:`String<class_string>` action **)** const |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_Input_is_action_pressed>` **(** :ref:`String<class_string>` action **)** const |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_joy_button_pressed<class_Input_is_joy_button_pressed>` **(** :ref:`int<class_int>` device, :ref:`int<class_int>` button **)** const |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_joy_known<class_Input_is_joy_known>` **(** :ref:`int<class_int>` device **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_key_pressed<class_Input_is_key_pressed>` **(** :ref:`int<class_int>` scancode **)** const |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_mouse_button_pressed<class_Input_is_mouse_button_pressed>` **(** :ref:`int<class_int>` button **)** const |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`joy_connection_changed<class_Input_joy_connection_changed>` **(** :ref:`int<class_int>` device, :ref:`bool<class_bool>` connected, :ref:`String<class_string>` name, :ref:`String<class_string>` guid **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`parse_input_event<class_Input_parse_input_event>` **(** :ref:`InputEvent<class_inputevent>` event **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_joy_mapping<class_Input_remove_joy_mapping>` **(** :ref:`String<class_string>` guid **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_mouse_cursor<class_Input_set_custom_mouse_cursor>` **(** :ref:`Resource<class_resource>` image, :ref:`CursorShape<enum_input_cursorshape>` shape=0, :ref:`Vector2<class_vector2>` hotspot=Vector2( 0, 0 ) **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_default_cursor_shape<class_Input_set_default_cursor_shape>` **(** :ref:`CursorShape<enum_input_cursorshape>` shape=0 **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mouse_mode<class_Input_set_mouse_mode>` **(** :ref:`MouseMode<enum_input_mousemode>` mode **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`start_joy_vibration<class_Input_start_joy_vibration>` **(** :ref:`int<class_int>` device, :ref:`float<class_float>` weak_magnitude, :ref:`float<class_float>` strong_magnitude, :ref:`float<class_float>` duration=0 **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop_joy_vibration<class_Input_stop_joy_vibration>` **(** :ref:`int<class_int>` device **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`warp_mouse_position<class_Input_warp_mouse_position>` **(** :ref:`Vector2<class_vector2>` to **)** |
+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -170,6 +174,10 @@ Add a new mapping entry (in SDL2 format) to the mapping database. Optionally upd
If the device has an accelerometer, this will return the acceleration. Otherwise, it returns an empty :ref:`Vector3<class_vector3>`.
.. _class_Input_get_action_strength:
- :ref:`float<class_float>` **get_action_strength** **(** :ref:`String<class_string>` action **)** const
.. _class_Input_get_connected_joypads:
- :ref:`Array<class_array>` **get_connected_joypads** **(** **)**
@@ -254,7 +262,7 @@ Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the
.. _class_Input_get_mouse_mode:
- :ref:`int<class_int>` **get_mouse_mode** **(** **)** const
- :ref:`MouseMode<enum_input_mousemode>` **get_mouse_mode** **(** **)** const
Return the mouse mode. See the constants for more information.
@@ -320,13 +328,17 @@ Removes all mappings from the internal db that match the given uid.
.. _class_Input_set_custom_mouse_cursor:
- void **set_custom_mouse_cursor** **(** :ref:`Resource<class_resource>` image, :ref:`int<class_int>` shape=0, :ref:`Vector2<class_vector2>` hotspot=Vector2( 0, 0 ) **)**
- void **set_custom_mouse_cursor** **(** :ref:`Resource<class_resource>` image, :ref:`CursorShape<enum_input_cursorshape>` shape=0, :ref:`Vector2<class_vector2>` hotspot=Vector2( 0, 0 ) **)**
Set a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. See enum ``CURSOR_*`` for the list of shapes.
Set a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. Passing ``null`` to the image parameter resets to the system cursor. See enum ``CURSOR_*`` for the list of shapes.
.. _class_Input_set_default_cursor_shape:
- void **set_default_cursor_shape** **(** :ref:`CursorShape<enum_input_cursorshape>` shape=0 **)**
.. _class_Input_set_mouse_mode:
- void **set_mouse_mode** **(** :ref:`int<class_int>` mode **)**
- void **set_mouse_mode** **(** :ref:`MouseMode<enum_input_mousemode>` mode **)**
Set the mouse mode. See the constants for more information.

View File

@@ -21,11 +21,11 @@ Generic input event
Member Functions
----------------
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`action_match<class_InputEvent_action_match>` **(** :ref:`InputEvent<class_inputevent>` event **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`as_text<class_InputEvent_as_text>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_action_strength<class_InputEvent_get_action_strength>` **(** :ref:`String<class_string>` action **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action<class_InputEvent_is_action>` **(** :ref:`String<class_string>` action **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_InputEvent_is_action_pressed>` **(** :ref:`String<class_string>` action **)** const |
@@ -59,18 +59,16 @@ Base class of all sort of input event. See :ref:`Node._input<class_Node__input>`
Member Function Description
---------------------------
.. _class_InputEvent_action_match:
- :ref:`bool<class_bool>` **action_match** **(** :ref:`InputEvent<class_inputevent>` event **)** const
Returns ``true`` if this event matches ``event``.
.. _class_InputEvent_as_text:
- :ref:`String<class_string>` **as_text** **(** **)** const
Returns a :ref:`String<class_string>` representation of the event.
.. _class_InputEvent_get_action_strength:
- :ref:`float<class_float>` **get_action_strength** **(** :ref:`String<class_string>` action **)** const
.. _class_InputEvent_is_action:
- :ref:`bool<class_bool>` **is_action** **(** :ref:`String<class_string>` action **)** const

View File

@@ -21,7 +21,7 @@ Member Variables
.. _class_InputEventJoypadButton_button_index:
- :ref:`int<class_int>` **button_index** - Button identifier. One of the ``JOY_BUTTON_*`` constants from @global Scope.
- :ref:`int<class_int>` **button_index** - Button identifier. One of the ``JOY_BUTTON_*`` constants from :ref:`@GlobalScope<class_@globalscope>`.
.. _class_InputEventJoypadButton_pressed:

View File

@@ -21,7 +21,7 @@ Member Variables
.. _class_InputEventJoypadMotion_axis:
- :ref:`int<class_int>` **axis** - Axis identifier. Use one of the ``JOY_AXIS_*`` constants in @global Scope.
- :ref:`int<class_int>` **axis** - Axis identifier. Use one of the ``JOY_AXIS_*`` constants in :ref:`@GlobalScope<class_@globalscope>`.
.. _class_InputEventJoypadMotion_axis_value:

View File

@@ -36,7 +36,7 @@ Member Variables
.. _class_InputEventKey_scancode:
- :ref:`int<class_int>` **scancode** - Key scancode, one of the ``KEY_*`` constants in @global Scope.
- :ref:`int<class_int>` **scancode** - Key scancode, one of the ``KEY_*`` constants in :ref:`@GlobalScope<class_@globalscope>`.
.. _class_InputEventKey_unicode:

View File

@@ -24,9 +24,13 @@ Member Functions
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_erase_event<class_InputMap_action_erase_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_erase_events<class_InputMap_action_erase_events>` **(** :ref:`String<class_string>` action **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`action_has_event<class_InputMap_action_has_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_action<class_InputMap_add_action>` **(** :ref:`String<class_string>` action **)** |
| void | :ref:`action_set_deadzone<class_InputMap_action_set_deadzone>` **(** :ref:`String<class_string>` deadzone, :ref:`float<class_float>` arg1 **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_action<class_InputMap_add_action>` **(** :ref:`String<class_string>` action, :ref:`float<class_float>` deadzone=0.5 **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_action<class_InputMap_erase_action>` **(** :ref:`String<class_string>` action **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -61,17 +65,27 @@ Adds an :ref:`InputEvent<class_inputevent>` to an action. This :ref:`InputEvent<
Removes an :ref:`InputEvent<class_inputevent>` from an action.
.. _class_InputMap_action_erase_events:
- void **action_erase_events** **(** :ref:`String<class_string>` action **)**
.. _class_InputMap_action_has_event:
- :ref:`bool<class_bool>` **action_has_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
Returns true if an action has an :ref:`InputEvent<class_inputevent>` associated with it.
.. _class_InputMap_action_set_deadzone:
- void **action_set_deadzone** **(** :ref:`String<class_string>` deadzone, :ref:`float<class_float>` arg1 **)**
.. _class_InputMap_add_action:
- void **add_action** **(** :ref:`String<class_string>` action **)**
- void **add_action** **(** :ref:`String<class_string>` action, :ref:`float<class_float>` deadzone=0.5 **)**
Adds an (empty) action to the ``InputMap``. An :ref:`InputEvent<class_inputevent>` can then be added to this action with :ref:`action_add_event<class_InputMap_action_add_event>`.
Adds an (empty) action to the ``InputMap``, with a configurable ``deadzone``.
An :ref:`InputEvent<class_inputevent>` can then be added to this action with :ref:`action_add_event<class_InputMap_action_add_event>`.
.. _class_InputMap_erase_action:

View File

@@ -19,13 +19,15 @@ Placeholder for the root :ref:`Node<class_node>` of a :ref:`PackedScene<class_pa
Member Functions
----------------
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_instance_path<class_InstancePlaceholder_get_instance_path>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_stored_values<class_InstancePlaceholder_get_stored_values>` **(** :ref:`bool<class_bool>` with_order=false **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`replace_by_instance<class_InstancePlaceholder_replace_by_instance>` **(** :ref:`PackedScene<class_packedscene>` custom_scene=null **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Node<class_node>` | :ref:`create_instance<class_InstancePlaceholder_create_instance>` **(** :ref:`bool<class_bool>` replace=false, :ref:`PackedScene<class_packedscene>` custom_scene=null **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_instance_path<class_InstancePlaceholder_get_instance_path>` **(** **)** const |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_stored_values<class_InstancePlaceholder_get_stored_values>` **(** :ref:`bool<class_bool>` with_order=false **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`replace_by_instance<class_InstancePlaceholder_replace_by_instance>` **(** :ref:`PackedScene<class_packedscene>` custom_scene=null **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -37,6 +39,10 @@ The InstancePlaceholder does not have a transform. This causes any child nodes t
Member Function Description
---------------------------
.. _class_InstancePlaceholder_create_instance:
- :ref:`Node<class_node>` **create_instance** **(** :ref:`bool<class_bool>` replace=false, :ref:`PackedScene<class_packedscene>` custom_scene=null **)**
.. _class_InstancePlaceholder_get_instance_path:
- :ref:`String<class_string>` **get_instance_path** **(** **)** const

View File

@@ -21,21 +21,21 @@ Internet protocol (IP) support functions like DNS resolution.
Member Functions
----------------
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_cache<class_IP_clear_cache>` **(** :ref:`String<class_string>` hostname="" **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_resolve_item<class_IP_erase_resolve_item>` **(** :ref:`int<class_int>` id **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_local_addresses<class_IP_get_local_addresses>` **(** **)** const |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_resolve_item_address<class_IP_get_resolve_item_address>` **(** :ref:`int<class_int>` id **)** const |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_resolve_item_status<class_IP_get_resolve_item_status>` **(** :ref:`int<class_int>` id **)** const |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`resolve_hostname<class_IP_resolve_hostname>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=3 **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`resolve_hostname_queue_item<class_IP_resolve_hostname_queue_item>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=3 **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_cache<class_IP_clear_cache>` **(** :ref:`String<class_string>` hostname="" **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_resolve_item<class_IP_erase_resolve_item>` **(** :ref:`int<class_int>` id **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_local_addresses<class_IP_get_local_addresses>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_resolve_item_address<class_IP_get_resolve_item_address>` **(** :ref:`int<class_int>` id **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ResolverStatus<enum_ip_resolverstatus>` | :ref:`get_resolve_item_status<class_IP_get_resolve_item_status>` **(** :ref:`int<class_int>` id **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`resolve_hostname<class_IP_resolve_hostname>` **(** :ref:`String<class_string>` host, :ref:`Type<enum_ip_type>` ip_type=3 **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`resolve_hostname_queue_item<class_IP_resolve_hostname_queue_item>` **(** :ref:`String<class_string>` host, :ref:`Type<enum_ip_type>` ip_type=3 **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
@@ -99,19 +99,19 @@ Returns a queued hostname's IP address, given its queue "id". Returns an empty s
.. _class_IP_get_resolve_item_status:
- :ref:`int<class_int>` **get_resolve_item_status** **(** :ref:`int<class_int>` id **)** const
- :ref:`ResolverStatus<enum_ip_resolverstatus>` **get_resolve_item_status** **(** :ref:`int<class_int>` id **)** const
Returns a queued hostname's status as a RESOLVER_STATUS\_\* constant, given its queue "id".
.. _class_IP_resolve_hostname:
- :ref:`String<class_string>` **resolve_hostname** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=3 **)**
- :ref:`String<class_string>` **resolve_hostname** **(** :ref:`String<class_string>` host, :ref:`Type<enum_ip_type>` ip_type=3 **)**
Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the TYPE\_\* constant given as "ip_type".
.. _class_IP_resolve_hostname_queue_item:
- :ref:`int<class_int>` **resolve_hostname_queue_item** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=3 **)**
- :ref:`int<class_int>` **resolve_hostname_queue_item** **(** :ref:`String<class_string>` host, :ref:`Type<enum_ip_type>` ip_type=3 **)**
Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the TYPE\_\* constant given as "ip_type". Returns the queue ID if successful, or RESOLVER_INVALID_ID on error.

View File

@@ -21,7 +21,7 @@ Member Variables
.. _class_JSONParseResult_error:
- Error **error** - The error type if JSON source was not successfully parsed. See :ref:`@GlobalScope<class_@globalscope>` ERR\_\* constants.
- :ref:`Error<enum_@globalscope_error>` **error** - The error type if JSON source was not successfully parsed. See :ref:`@GlobalScope<class_@globalscope>` ERR\_\* constants.
.. _class_JSONParseResult_error_line:

View File

@@ -104,7 +104,7 @@ Member Variables
.. _class_LineEdit_secret_character:
- string **secret_character** - The character to use to mask secret input (defaults to "\*"). Only a single character can be used as the secret character.
- :ref:`String<class_string>` **secret_character** - The character to use to mask secret input (defaults to "\*"). Only a single character can be used as the secret character.
.. _class_LineEdit_text:

View File

@@ -22,9 +22,9 @@ Member Functions
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_MeshDataTool_clear>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`commit_to_surface<class_MeshDataTool_commit_to_surface>` **(** :ref:`ArrayMesh<class_arraymesh>` mesh **)** |
| :ref:`Error<enum_@globalscope_error>` | :ref:`commit_to_surface<class_MeshDataTool_commit_to_surface>` **(** :ref:`ArrayMesh<class_arraymesh>` mesh **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`create_from_surface<class_MeshDataTool_create_from_surface>` **(** :ref:`ArrayMesh<class_arraymesh>` mesh, :ref:`int<class_int>` surface **)** |
| :ref:`Error<enum_@globalscope_error>` | :ref:`create_from_surface<class_MeshDataTool_create_from_surface>` **(** :ref:`ArrayMesh<class_arraymesh>` mesh, :ref:`int<class_int>` surface **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_edge_count<class_MeshDataTool_get_edge_count>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -106,11 +106,11 @@ Member Function Description
.. _class_MeshDataTool_commit_to_surface:
- :ref:`int<class_int>` **commit_to_surface** **(** :ref:`ArrayMesh<class_arraymesh>` mesh **)**
- :ref:`Error<enum_@globalscope_error>` **commit_to_surface** **(** :ref:`ArrayMesh<class_arraymesh>` mesh **)**
.. _class_MeshDataTool_create_from_surface:
- :ref:`int<class_int>` **create_from_surface** **(** :ref:`ArrayMesh<class_arraymesh>` mesh, :ref:`int<class_int>` surface **)**
- :ref:`Error<enum_@globalscope_error>` **create_from_surface** **(** :ref:`ArrayMesh<class_arraymesh>` mesh, :ref:`int<class_int>` surface **)**
.. _class_MeshDataTool_get_edge_count:

View File

@@ -14,38 +14,30 @@ MultiplayerAPI
Brief Description
-----------------
High Level Multiplayer API.
Member Functions
----------------
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| void | :ref:`add_peer<class_MultiplayerAPI_add_peer>` **(** :ref:`int<class_int>` id **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_MultiplayerAPI_clear>` **(** **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| void | :ref:`connected_to_server<class_MultiplayerAPI_connected_to_server>` **(** **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| void | :ref:`connection_failed<class_MultiplayerAPI_connection_failed>` **(** **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| void | :ref:`del_peer<class_MultiplayerAPI_del_peer>` **(** :ref:`int<class_int>` id **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_network_connected_peers<class_MultiplayerAPI_get_network_connected_peers>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_network_unique_id<class_MultiplayerAPI_get_network_unique_id>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_rpc_sender_id<class_MultiplayerAPI_get_rpc_sender_id>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_network_peer<class_MultiplayerAPI_has_network_peer>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_network_server<class_MultiplayerAPI_is_network_server>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| void | :ref:`poll<class_MultiplayerAPI_poll>` **(** **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| void | :ref:`server_disconnected<class_MultiplayerAPI_server_disconnected>` **(** **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
| void | :ref:`set_root_node<class_MultiplayerAPI_set_root_node>` **(** :ref:`Node<class_node>` node **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------+
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_MultiplayerAPI_clear>` **(** **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_network_connected_peers<class_MultiplayerAPI_get_network_connected_peers>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_network_unique_id<class_MultiplayerAPI_get_network_unique_id>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_rpc_sender_id<class_MultiplayerAPI_get_rpc_sender_id>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_network_peer<class_MultiplayerAPI_has_network_peer>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_network_server<class_MultiplayerAPI_is_network_server>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`poll<class_MultiplayerAPI_poll>` **(** **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`send_bytes<class_MultiplayerAPI_send_bytes>` **(** :ref:`PoolByteArray<class_poolbytearray>` bytes, :ref:`int<class_int>` id=0 **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_root_node<class_MultiplayerAPI_set_root_node>` **(** :ref:`Node<class_node>` node **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -54,88 +46,123 @@ Signals
- **connected_to_server** **(** **)**
Emitted whenever this MultiplayerAPI's :ref:`network_peer<class_MultiplayerAPI_network_peer>` successfully connected to a server. Only emitted on clients.
.. _class_MultiplayerAPI_connection_failed:
- **connection_failed** **(** **)**
Emitted whenever this MultiplayerAPI's :ref:`network_peer<class_MultiplayerAPI_network_peer>` fails to establish a connection to a server. Only emitted on clients.
.. _class_MultiplayerAPI_network_peer_connected:
- **network_peer_connected** **(** :ref:`int<class_int>` id **)**
Emitted whenever this MultiplayerAPI's :ref:`network_peer<class_MultiplayerAPI_network_peer>` connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1).
.. _class_MultiplayerAPI_network_peer_disconnected:
- **network_peer_disconnected** **(** :ref:`int<class_int>` id **)**
Emitted whenever this MultiplayerAPI's :ref:`network_peer<class_MultiplayerAPI_network_peer>` disconnects from a peer. Clients get notified when other clients disconnect from the same server.
.. _class_MultiplayerAPI_network_peer_packet:
- **network_peer_packet** **(** :ref:`int<class_int>` id, :ref:`PoolByteArray<class_poolbytearray>` packet **)**
Emitted whenever this MultiplayerAPI's :ref:`network_peer<class_MultiplayerAPI_network_peer>` receive a ``packet`` with custom data (see :ref:`send_bytes<class_MultiplayerAPI_send_bytes>`). ID is the peer ID of the peer that sent the packet.
.. _class_MultiplayerAPI_server_disconnected:
- **server_disconnected** **(** **)**
Emitted whenever this MultiplayerAPI's :ref:`network_peer<class_MultiplayerAPI_network_peer>` disconnects from server. Only emitted on clients.
Member Variables
----------------
.. _class_MultiplayerAPI_network_peer:
- :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>` **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 MultiplayerAPI will become a network server (check with :ref:`is_network_server<class_MultiplayerAPI_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 MultiplayerAPI's signals.
.. _class_MultiplayerAPI_refuse_new_network_connections:
- :ref:`bool<class_bool>` **refuse_new_network_connections**
- :ref:`bool<class_bool>` **refuse_new_network_connections** - If ``true`` the MultiplayerAPI's :ref:`network_peer<class_MultiplayerAPI_network_peer>` refuses new incoming connections.
Description
-----------
This class implements most of the logic behind the high level multiplayer API.
By default, :ref:`SceneTree<class_scenetree>` has a reference to this class that is used to provide multiplayer capabilities (i.e. RPC/RSET) across the whole scene.
It is possible to override the MultiplayerAPI instance used by specific Nodes by setting the :ref:`Node.custom_multiplayer<class_Node_custom_multiplayer>` property, effectively allowing to run both client and server in the same scene.
Member Function Description
---------------------------
.. _class_MultiplayerAPI_add_peer:
- void **add_peer** **(** :ref:`int<class_int>` id **)**
.. _class_MultiplayerAPI_clear:
- void **clear** **(** **)**
.. _class_MultiplayerAPI_connected_to_server:
- void **connected_to_server** **(** **)**
.. _class_MultiplayerAPI_connection_failed:
- void **connection_failed** **(** **)**
.. _class_MultiplayerAPI_del_peer:
- void **del_peer** **(** :ref:`int<class_int>` id **)**
Clears the current MultiplayerAPI network state (you shouldn't call this unless you know what you are doing).
.. _class_MultiplayerAPI_get_network_connected_peers:
- :ref:`PoolIntArray<class_poolintarray>` **get_network_connected_peers** **(** **)** const
Returns the peer IDs of all connected peers of this MultiplayerAPI's :ref:`network_peer<class_MultiplayerAPI_network_peer>`.
.. _class_MultiplayerAPI_get_network_unique_id:
- :ref:`int<class_int>` **get_network_unique_id** **(** **)** const
Returns the unique peer ID of this MultiplayerAPI's :ref:`network_peer<class_MultiplayerAPI_network_peer>`.
.. _class_MultiplayerAPI_get_rpc_sender_id:
- :ref:`int<class_int>` **get_rpc_sender_id** **(** **)** const
Returns the sender's peer ID for the RPC currently being executed.
NOTE: If not inside an RPC this method will return 0.
.. _class_MultiplayerAPI_has_network_peer:
- :ref:`bool<class_bool>` **has_network_peer** **(** **)** const
Returns ``true`` if there is a :ref:`network_peer<class_MultiplayerAPI_network_peer>` set.
.. _class_MultiplayerAPI_is_network_server:
- :ref:`bool<class_bool>` **is_network_server** **(** **)** const
Returns ``true`` if this MultiplayerAPI's :ref:`network_peer<class_MultiplayerAPI_network_peer>` is in server mode (listening for connections).
.. _class_MultiplayerAPI_poll:
- void **poll** **(** **)**
.. _class_MultiplayerAPI_server_disconnected:
Method used for polling the MultiplayerAPI.
- void **server_disconnected** **(** **)**
You only need to worry about this if you are using :ref:`Node.custom_multiplayer<class_Node_custom_multiplayer>` override.
SceneTree will poll the default MultiplayerAPI for you.
.. _class_MultiplayerAPI_send_bytes:
- :ref:`Error<enum_@globalscope_error>` **send_bytes** **(** :ref:`PoolByteArray<class_poolbytearray>` bytes, :ref:`int<class_int>` id=0 **)**
Sends the given raw ``bytes`` to a specific peer identified by ``id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer<class_NetworkedMultiplayerPeer_set_target_peer>`). Default ID is ``0``, i.e. broadcast to all peers.
.. _class_MultiplayerAPI_set_root_node:
- void **set_root_node** **(** :ref:`Node<class_node>` node **)**
Sets the base root node to use for RPCs. Instead of an absolute path, a relative path will be used to find the node upon which the RPC should be executed.
This effectively allows to have different branches of the scene tree to be managed by different MultiplayerAPI, allowing for example to run both client and server in the same scene.

View File

@@ -19,13 +19,13 @@ A synchronization Mutex.
Member Functions
----------------
+------------------------+---------------------------------------------------+
| void | :ref:`lock<class_Mutex_lock>` **(** **)** |
+------------------------+---------------------------------------------------+
| :ref:`int<class_int>` | :ref:`try_lock<class_Mutex_try_lock>` **(** **)** |
+------------------------+---------------------------------------------------+
| void | :ref:`unlock<class_Mutex_unlock>` **(** **)** |
+------------------------+---------------------------------------------------+
+----------------------------------------+---------------------------------------------------+
| void | :ref:`lock<class_Mutex_lock>` **(** **)** |
+----------------------------------------+---------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`try_lock<class_Mutex_try_lock>` **(** **)** |
+----------------------------------------+---------------------------------------------------+
| void | :ref:`unlock<class_Mutex_unlock>` **(** **)** |
+----------------------------------------+---------------------------------------------------+
Description
-----------
@@ -43,7 +43,7 @@ Lock this ``Mutex``, blocks until it is unlocked by the current owner.
.. _class_Mutex_try_lock:
- :ref:`int<class_int>` **try_lock** **(** **)**
- :ref:`Error<enum_@globalscope_error>` **try_lock** **(** **)**
Try locking this ``Mutex``, does not block. Returns OK on success, ERR_BUSY otherwise.

View File

@@ -19,23 +19,45 @@ PacketPeer implementation using the ENet library.
Member Functions
----------------
+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`close_connection<class_NetworkedMultiplayerENet_close_connection>` **(** **)** |
+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`create_client<class_NetworkedMultiplayerENet_create_client>` **(** :ref:`String<class_string>` ip, :ref:`int<class_int>` port, :ref:`int<class_int>` in_bandwidth=0, :ref:`int<class_int>` out_bandwidth=0 **)** |
+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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 **)** |
+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bind_ip<class_NetworkedMultiplayerENet_set_bind_ip>` **(** :ref:`String<class_string>` ip **)** |
+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`close_connection<class_NetworkedMultiplayerENet_close_connection>` **(** :ref:`int<class_int>` wait_usec=100 **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`create_client<class_NetworkedMultiplayerENet_create_client>` **(** :ref:`String<class_string>` address, :ref:`int<class_int>` port, :ref:`int<class_int>` in_bandwidth=0, :ref:`int<class_int>` out_bandwidth=0, :ref:`int<class_int>` client_port=0 **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :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 **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect_peer<class_NetworkedMultiplayerENet_disconnect_peer>` **(** :ref:`int<class_int>` id, :ref:`bool<class_bool>` now=false **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_last_packet_channel<class_NetworkedMultiplayerENet_get_last_packet_channel>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_packet_channel<class_NetworkedMultiplayerENet_get_packet_channel>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_peer_address<class_NetworkedMultiplayerENet_get_peer_address>` **(** :ref:`int<class_int>` id **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_peer_port<class_NetworkedMultiplayerENet_get_peer_port>` **(** :ref:`int<class_int>` id **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bind_ip<class_NetworkedMultiplayerENet_set_bind_ip>` **(** :ref:`String<class_string>` ip **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_NetworkedMultiplayerENet_always_ordered:
- :ref:`bool<class_bool>` **always_ordered** - Always use ``TRANSFER_MODE_ORDERED`` in place of ``TRANSFER_MODE_UNRELIABLE``. This is the only way to use ordering with the RPC system.
.. _class_NetworkedMultiplayerENet_channel_count:
- :ref:`int<class_int>` **channel_count** - The number of channels to be used by ENet. Default: ``3``. Channels are used to separate different kinds of data. In realiable or ordered mode, for example, the packet delivery order is ensured on a per channel basis.
.. _class_NetworkedMultiplayerENet_compression_mode:
- :ref:`CompressionMode<enum_networkedmultiplayerenet_compressionmode>` **compression_mode** - The compression method used for network packets. Default is no compression. These have different tradeoffs of compression speed versus bandwidth, you may need to test which one works best for your use case if you use compression at all.
.. _class_NetworkedMultiplayerENet_transfer_channel:
- :ref:`int<class_int>` **transfer_channel** - Set the default channel to be used to transfer data. By default this value is ``-1`` which means that ENet will only use 2 channels, one for reliable and one for unreliable packets. Channel ``0`` is reserved, and cannot be used. Setting this member to any value between ``0`` and :ref:`channel_count<class_NetworkedMultiplayerENet_channel_count>` (excluded) will force ENet to use that channel for sending data.
Enums
-----
@@ -61,22 +83,52 @@ Member Function Description
.. _class_NetworkedMultiplayerENet_close_connection:
- void **close_connection** **(** **)**
- void **close_connection** **(** :ref:`int<class_int>` wait_usec=100 **)**
Closes the connection. Ignored if no connection is currently established. If this is a server it tries to notify all clients before forcibly disconnecting them. If this is a client it simply closes the connection to the server.
.. _class_NetworkedMultiplayerENet_create_client:
- :ref:`int<class_int>` **create_client** **(** :ref:`String<class_string>` ip, :ref:`int<class_int>` port, :ref:`int<class_int>` in_bandwidth=0, :ref:`int<class_int>` out_bandwidth=0 **)**
- :ref:`Error<enum_@globalscope_error>` **create_client** **(** :ref:`String<class_string>` address, :ref:`int<class_int>` port, :ref:`int<class_int>` in_bandwidth=0, :ref:`int<class_int>` out_bandwidth=0, :ref:`int<class_int>` client_port=0 **)**
Create client that connects to a server at address ``ip`` using specified ``port``. The given IP needs to be in IPv4 or IPv6 address format, for example: ``192.168.1.1``. The ``port`` is the port the server is listening on. The ``in_bandwidth`` and ``out_bandwidth`` parameters can be used to limit the incoming and outgoing bandwidth to the given number of bytes per second. The default of 0 means unlimited bandwidth. Note that ENet will strategically drop packets on specific sides of a connection between peers to ensure the peer's bandwidth is not overwhelmed. The bandwidth parameters also determine the window size of a connection which limits the amount of reliable packets that may be in transit at any given time. Returns ``OK`` if a client was created, ``ERR_ALREADY_IN_USE`` if this NetworkedMultiplayerEnet instance already has an open connection (in which case you need to call :ref:`close_connection<class_NetworkedMultiplayerENet_close_connection>` first) or ``ERR_CANT_CREATE`` if the client could not be created.
Create client that connects to a server at ``address`` using specified ``port``. The given address needs to be either a fully qualified domain nome (e.g. ``www.example.com``) or an IP address in IPv4 or IPv6 format (e.g. ``192.168.1.1``). The ``port`` is the port the server is listening on. The ``in_bandwidth`` and ``out_bandwidth`` parameters can be used to limit the incoming and outgoing bandwidth to the given number of bytes per second. The default of 0 means unlimited bandwidth. Note that ENet will strategically drop packets on specific sides of a connection between peers to ensure the peer's bandwidth is not overwhelmed. The bandwidth parameters also determine the window size of a connection which limits the amount of reliable packets that may be in transit at any given time. Returns ``OK`` if a client was created, ``ERR_ALREADY_IN_USE`` if this NetworkedMultiplayerEnet instance already has an open connection (in which case you need to call :ref:`close_connection<class_NetworkedMultiplayerENet_close_connection>` first) or ``ERR_CANT_CREATE`` if the client could not be created. If ``client_port`` is specified, the client will also listen to the given port, this is useful in some NAT traveral technique.
.. _class_NetworkedMultiplayerENet_create_server:
- :ref:`int<class_int>` **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:`Error<enum_@globalscope_error>` **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 **)**
Create server that listens to connections via ``port``. The port needs to be an available, unused port between 0 and 65535. Note that ports below 1024 are privileged and may require elevated permissions depending on the platform. To change the interface the server listens on, use :ref:`set_bind_ip<class_NetworkedMultiplayerENet_set_bind_ip>`. The default IP is the wildcard ``*``, which listens on all available interfaces. ``max_clients`` is the maximum number of clients that are allowed at once, any number up to 4096 may be used, although the achievable number of simultaneous clients may be far lower and depends on the application. For additional details on the bandwidth parameters, see :ref:`create_client<class_NetworkedMultiplayerENet_create_client>`. Returns ``OK`` if a server was created, ``ERR_ALREADY_IN_USE`` if this NetworkedMultiplayerEnet instance already has an open connection (in which case you need to call :ref:`close_connection<class_NetworkedMultiplayerENet_close_connection>` first) or ``ERR_CANT_CREATE`` if the server could not be created.
.. _class_NetworkedMultiplayerENet_disconnect_peer:
- void **disconnect_peer** **(** :ref:`int<class_int>` id, :ref:`bool<class_bool>` now=false **)**
Disconnect the given peer. If "now" is set to true, the connection will be closed immediately without flushing queued messages.
.. _class_NetworkedMultiplayerENet_get_last_packet_channel:
- :ref:`int<class_int>` **get_last_packet_channel** **(** **)** const
Returns the channel of the last packet fetched via :ref:`PacketPeer.get_packet<class_PacketPeer_get_packet>`
.. _class_NetworkedMultiplayerENet_get_packet_channel:
- :ref:`int<class_int>` **get_packet_channel** **(** **)** const
Returns the channel of the next packet that will be retrieved via :ref:`PacketPeer.get_packet_peer<class_PacketPeer_get_packet_peer>`
.. _class_NetworkedMultiplayerENet_get_peer_address:
- :ref:`String<class_string>` **get_peer_address** **(** :ref:`int<class_int>` id **)** const
Returns the IP address of the given peer.
.. _class_NetworkedMultiplayerENet_get_peer_port:
- :ref:`int<class_int>` **get_peer_port** **(** :ref:`int<class_int>` id **)** const
Returns the remote port of the given peer.
.. _class_NetworkedMultiplayerENet_set_bind_ip:
- void **set_bind_ip** **(** :ref:`String<class_string>` ip **)**

View File

@@ -21,17 +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 |
+------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`poll<class_NetworkedMultiplayerPeer_poll>` **(** **)** |
+------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_target_peer<class_NetworkedMultiplayerPeer_set_target_peer>` **(** :ref:`int<class_int>` id **)** |
+------------------------+-------------------------------------------------------------------------------------------------------------+
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`ConnectionStatus<enum_networkedmultiplayerpeer_connectionstatus>` | :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
-------
@@ -76,7 +76,7 @@ Member Variables
.. _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.
- :ref:`TransferMode<enum_networkedmultiplayerpeer_transfermode>` **transfer_mode** - The manner in which to send packets to the ``target_peer``. See :ref:`TransferMode<enum_@globalscope_transfermode>`.
Numeric Constants
@@ -115,9 +115,9 @@ Member Function Description
.. _class_NetworkedMultiplayerPeer_get_connection_status:
- :ref:`int<class_int>` **get_connection_status** **(** **)** const
- :ref:`ConnectionStatus<enum_networkedmultiplayerpeer_connectionstatus>` **get_connection_status** **(** **)** const
Returns the current state of the connection. See enum ConnectionStatus.
Returns the current state of the connection. See :ref:`ConnectionStatus<enum_@globalscope_connectionstatus>`.
.. _class_NetworkedMultiplayerPeer_get_packet_peer:
@@ -141,6 +141,8 @@ Waits up to 1 second to receive a new network event.
- void **set_target_peer** **(** :ref:`int<class_int>` id **)**
The peer to which packets will be sent. Default value: ``0``.
Sets the peer to which packets will be sent.
The ``id`` can be one of: ``TARGET_PEER_BROADCAST`` to send to all connected peers, ``TARGET_PEER_SERVER`` to send to the peer acting as server, a valid peer ID to send to that specific peer, a negative peer ID to send to all peers except that one. Default: ``TARGET_PEER_BROADCAST``

View File

@@ -142,7 +142,7 @@ Member Functions
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`rpc<class_Node_rpc>` **(** :ref:`String<class_string>` method **)** vararg |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rpc_config<class_Node_rpc_config>` **(** :ref:`String<class_string>` method, :ref:`int<class_int>` mode **)** |
| void | :ref:`rpc_config<class_Node_rpc_config>` **(** :ref:`String<class_string>` method, :ref:`RPCMode<enum_node_rpcmode>` mode **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`rpc_id<class_Node_rpc_id>` **(** :ref:`int<class_int>` peer_id, :ref:`String<class_string>` method **)** vararg |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -152,7 +152,7 @@ Member Functions
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rset<class_Node_rset>` **(** :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rset_config<class_Node_rset_config>` **(** :ref:`String<class_string>` property, :ref:`int<class_int>` mode **)** |
| void | :ref:`rset_config<class_Node_rset_config>` **(** :ref:`String<class_string>` property, :ref:`RPCMode<enum_node_rpcmode>` mode **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rset_id<class_Node_rset_id>` **(** :ref:`int<class_int>` peer_id, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -218,17 +218,17 @@ Emitted when the node is still active but about to exit the tree. This is the ri
Member Variables
----------------
.. _class_Node_custom_multiplayer_api:
.. _class_Node_custom_multiplayer:
- :ref:`MultiplayerAPI<class_multiplayerapi>` **custom_multiplayer_api**
- :ref:`MultiplayerAPI<class_multiplayerapi>` **custom_multiplayer** - The override to the default :ref:`MultiplayerAPI<class_multiplayerapi>`. Set to null to use the default SceneTree one.
.. _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_multiplayer_api:
.. _class_Node_multiplayer:
- :ref:`MultiplayerAPI<class_multiplayerapi>` **multiplayer_api**
- :ref:`MultiplayerAPI<class_multiplayerapi>` **multiplayer** - The :ref:`MultiplayerAPI<class_multiplayerapi>` instance associated with this node. Either the :ref:`custom_multiplayer<class_Node_custom_multiplayer>`, or the default SceneTree one (if inside tree).
.. _class_Node_name:
@@ -763,15 +763,15 @@ Sends a remote procedure call request for the given ``method`` to peers on the n
.. _class_Node_rpc_config:
- void **rpc_config** **(** :ref:`String<class_string>` method, :ref:`int<class_int>` mode **)**
- void **rpc_config** **(** :ref:`String<class_string>` method, :ref:`RPCMode<enum_node_rpcmode>` mode **)**
Changes the RPC mode for the given ``method`` to the given ``mode``. See enum RPCMode. An alternative is annotating methods and properties with the corresponding keywords (``remote``, ``sync``, ``master``, ``slave``). By default, methods are not exposed to networking (and RPCs). Also see :ref:`rset<class_Node_rset>` and :ref:`rset_config<class_Node_rset_config>` for properties.
Changes the RPC mode for the given ``method`` to the given ``mode``. See :ref:`RPCMode<enum_@globalscope_rpcmode>`. An alternative is annotating methods and properties with the corresponding keywords (``remote``, ``sync``, ``master``, ``slave``). By default, methods are not exposed to networking (and RPCs). Also see :ref:`rset<class_Node_rset>` and :ref:`rset_config<class_Node_rset_config>` for properties.
.. _class_Node_rpc_id:
- :ref:`Variant<class_variant>` **rpc_id** **(** :ref:`int<class_int>` peer_id, :ref:`String<class_string>` method **)** vararg
Sends a :ref:`rpc<class_Node_rpc>` to a specific peer identified by ``peer_id``. Returns an empty :ref:`Variant<class_variant>`.
Sends a :ref:`rpc<class_Node_rpc>` to a specific peer identified by ``peer_id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer<class_NetworkedMultiplayerPeer_set_target_peer>`). Returns an empty :ref:`Variant<class_variant>`.
.. _class_Node_rpc_unreliable:
@@ -783,7 +783,7 @@ Sends a :ref:`rpc<class_Node_rpc>` using an unreliable protocol. Returns an empt
- :ref:`Variant<class_variant>` **rpc_unreliable_id** **(** :ref:`int<class_int>` peer_id, :ref:`String<class_string>` method **)** vararg
Sends a :ref:`rpc<class_Node_rpc>` to a specific peer identified by ``peer_id`` using an unreliable protocol. Returns an empty :ref:`Variant<class_variant>`.
Sends a :ref:`rpc<class_Node_rpc>` to a specific peer identified by ``peer_id`` using an unreliable protocol (see :ref:`NetworkedMultiplayerPeer.set_target_peer<class_NetworkedMultiplayerPeer_set_target_peer>`). Returns an empty :ref:`Variant<class_variant>`.
.. _class_Node_rset:
@@ -793,15 +793,15 @@ Remotely changes a property's value on other peers (and locally). Behaviour depe
.. _class_Node_rset_config:
- void **rset_config** **(** :ref:`String<class_string>` property, :ref:`int<class_int>` mode **)**
- void **rset_config** **(** :ref:`String<class_string>` property, :ref:`RPCMode<enum_node_rpcmode>` mode **)**
Changes the RPC mode for the given ``property`` to the given ``mode``. See enum RPCMode. An alternative is annotating methods and properties with the corresponding keywords (``remote``, ``sync``, ``master``, ``slave``). By default, properties are not exposed to networking (and RPCs). Also see :ref:`rpc<class_Node_rpc>` and :ref:`rpc_config<class_Node_rpc_config>` for methods.
Changes the RPC mode for the given ``property`` to the given ``mode``. See :ref:`RPCMode<enum_@globalscope_rpcmode>`. An alternative is annotating methods and properties with the corresponding keywords (``remote``, ``sync``, ``master``, ``slave``). By default, properties are not exposed to networking (and RPCs). Also see :ref:`rpc<class_Node_rpc>` and :ref:`rpc_config<class_Node_rpc_config>` for methods.
.. _class_Node_rset_id:
- void **rset_id** **(** :ref:`int<class_int>` peer_id, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)**
Remotely changes the property's value on a specific peer identified by ``peer_id``.
Remotely changes the property's value on a specific peer identified by ``peer_id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer<class_NetworkedMultiplayerPeer_set_target_peer>`).
.. _class_Node_rset_unreliable:
@@ -813,7 +813,7 @@ Remotely changes the property's value on other peers (and locally) using an unre
- void **rset_unreliable_id** **(** :ref:`int<class_int>` peer_id, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)**
Remotely changes property's value on a specific peer identified by ``peer_id`` using an unreliable protocol.
Remotely changes property's value on a specific peer identified by ``peer_id`` using an unreliable protocol (see :ref:`NetworkedMultiplayerPeer.set_target_peer<class_NetworkedMultiplayerPeer_set_target_peer>`).
.. _class_Node_set_display_folded:
@@ -837,7 +837,7 @@ Enables or disables physics (i.e. fixed framerate) processing. When a node is be
- void **set_physics_process_internal** **(** :ref:`bool<class_bool>` enable **)**
Enables or disables internal physics for this node. Internal physics processing happens in isolation from the normal :ref:`method<class_Node_method>`_physics_process`` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or physics processing is disabled for scripting (:ref:`set_physics_process<class_Node_set_physics_process>`). Only useful for advanced uses to manipulate built-in nodes behaviour.
Enables or disables internal physics for this node. Internal physics processing happens in isolation from the normal :ref:`_physics_process<class_Node__physics_process>` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or physics processing is disabled for scripting (:ref:`set_physics_process<class_Node_set_physics_process>`). Only useful for advanced uses to manipulate built-in nodes behaviour.
.. _class_Node_set_process:
@@ -855,7 +855,7 @@ Enables or disables input processing. This is not required for GUI controls! Ena
- void **set_process_internal** **(** :ref:`bool<class_bool>` enable **)**
Enables or disabled internal processing for this node. Internal processing happens in isolation from the normal :ref:`method<class_Node_method>`_process`` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting (:ref:`set_process<class_Node_set_process>`). Only useful for advanced uses to manipulate built-in nodes behaviour.
Enables or disabled internal processing for this node. Internal processing happens in isolation from the normal :ref:`_process<class_Node__process>` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting (:ref:`set_process<class_Node_set_process>`). Only useful for advanced uses to manipulate built-in nodes behaviour.
.. _class_Node_set_process_unhandled_input:

View File

@@ -9,7 +9,7 @@ Node2D
**Inherits:** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Inherited By:** :ref:`RemoteTransform2D<class_remotetransform2d>`, :ref:`Joint2D<class_joint2d>`, :ref:`VisibilityNotifier2D<class_visibilitynotifier2d>`, :ref:`Navigation2D<class_navigation2d>`, :ref:`CollisionPolygon2D<class_collisionpolygon2d>`, :ref:`TouchScreenButton<class_touchscreenbutton>`, :ref:`Particles2D<class_particles2d>`, :ref:`AnimatedSprite<class_animatedsprite>`, :ref:`RayCast2D<class_raycast2d>`, :ref:`Light2D<class_light2d>`, :ref:`Path2D<class_path2d>`, :ref:`Line2D<class_line2d>`, :ref:`AudioStreamPlayer2D<class_audiostreamplayer2d>`, :ref:`CanvasModulate<class_canvasmodulate>`, :ref:`Sprite<class_sprite>`, :ref:`CollisionShape2D<class_collisionshape2d>`, :ref:`NavigationPolygonInstance<class_navigationpolygoninstance>`, :ref:`PathFollow2D<class_pathfollow2d>`, :ref:`ParallaxLayer<class_parallaxlayer>`, :ref:`Polygon2D<class_polygon2d>`, :ref:`Position2D<class_position2d>`, :ref:`LightOccluder2D<class_lightoccluder2d>`, :ref:`CollisionObject2D<class_collisionobject2d>`, :ref:`BackBufferCopy<class_backbuffercopy>`, :ref:`MeshInstance2D<class_meshinstance2d>`, :ref:`YSort<class_ysort>`, :ref:`TileMap<class_tilemap>`, :ref:`Camera2D<class_camera2d>`
**Inherited By:** :ref:`RemoteTransform2D<class_remotetransform2d>`, :ref:`Joint2D<class_joint2d>`, :ref:`Skeleton2D<class_skeleton2d>`, :ref:`VisibilityNotifier2D<class_visibilitynotifier2d>`, :ref:`Navigation2D<class_navigation2d>`, :ref:`CollisionPolygon2D<class_collisionpolygon2d>`, :ref:`TouchScreenButton<class_touchscreenbutton>`, :ref:`Particles2D<class_particles2d>`, :ref:`AnimatedSprite<class_animatedsprite>`, :ref:`RayCast2D<class_raycast2d>`, :ref:`Light2D<class_light2d>`, :ref:`Path2D<class_path2d>`, :ref:`Line2D<class_line2d>`, :ref:`AudioStreamPlayer2D<class_audiostreamplayer2d>`, :ref:`CanvasModulate<class_canvasmodulate>`, :ref:`Sprite<class_sprite>`, :ref:`CollisionShape2D<class_collisionshape2d>`, :ref:`NavigationPolygonInstance<class_navigationpolygoninstance>`, :ref:`PathFollow2D<class_pathfollow2d>`, :ref:`ParallaxLayer<class_parallaxlayer>`, :ref:`Polygon2D<class_polygon2d>`, :ref:`Position2D<class_position2d>`, :ref:`LightOccluder2D<class_lightoccluder2d>`, :ref:`CollisionObject2D<class_collisionobject2d>`, :ref:`BackBufferCopy<class_backbuffercopy>`, :ref:`MeshInstance2D<class_meshinstance2d>`, :ref:`YSort<class_ysort>`, :ref:`TileMap<class_tilemap>`, :ref:`Bone2D<class_bone2d>`, :ref:`Camera2D<class_camera2d>`
**Category:** Core

View File

@@ -40,7 +40,7 @@ Member Functions
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`can_translate_messages<class_Object_can_translate_messages>` **(** **)** const |
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`connect<class_Object_connect>` **(** :ref:`String<class_string>` signal, :ref:`Object<class_object>` target, :ref:`String<class_string>` method, :ref:`Array<class_array>` binds=[ ], :ref:`int<class_int>` flags=0 **)** |
| :ref:`Error<enum_@globalscope_error>` | :ref:`connect<class_Object_connect>` **(** :ref:`String<class_string>` signal, :ref:`Object<class_object>` target, :ref:`String<class_string>` method, :ref:`Array<class_array>` binds=[ ], :ref:`int<class_int>` flags=0 **)** |
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect<class_Object_disconnect>` **(** :ref:`String<class_string>` signal, :ref:`Object<class_object>` target, :ref:`String<class_string>` method **)** |
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -211,7 +211,7 @@ Returns ``true`` if the object can translate strings.
.. _class_Object_connect:
- :ref:`int<class_int>` **connect** **(** :ref:`String<class_string>` signal, :ref:`Object<class_object>` target, :ref:`String<class_string>` method, :ref:`Array<class_array>` binds=[ ], :ref:`int<class_int>` flags=0 **)**
- :ref:`Error<enum_@globalscope_error>` **connect** **(** :ref:`String<class_string>` signal, :ref:`Object<class_object>` target, :ref:`String<class_string>` method, :ref:`Array<class_array>` binds=[ ], :ref:`int<class_int>` flags=0 **)**
Connects a ``signal`` to a ``method`` on a ``target`` object. Pass optional ``binds`` to the call. Use ``flags`` to set deferred or one shot connections. See ``CONNECT_*`` constants. A ``signal`` can only be connected once to a ``method``. It will throw an error if already connected. To avoid this, first use :ref:`is_connected<class_Object_is_connected>` to check for existing connections.

View File

@@ -19,47 +19,47 @@ Button control that provides selectable options when pressed.
Member Functions
----------------
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_icon_item<class_OptionButton_add_icon_item>` **(** :ref:`Texture<class_texture>` texture, :ref:`String<class_string>` label, :ref:`int<class_int>` id **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_item<class_OptionButton_add_item>` **(** :ref:`String<class_string>` label, :ref:`int<class_int>` id=-1 **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_separator<class_OptionButton_add_separator>` **(** **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_OptionButton_clear>` **(** **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_item_count<class_OptionButton_get_item_count>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_item_icon<class_OptionButton_get_item_icon>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_item_id<class_OptionButton_get_item_id>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_item_metadata<class_OptionButton_get_item_metadata>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_item_text<class_OptionButton_get_item_text>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PopupMenu<class_popupmenu>` | :ref:`get_popup<class_OptionButton_get_popup>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_selected_id<class_OptionButton_get_selected_id>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_selected_metadata<class_OptionButton_get_selected_metadata>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_item_disabled<class_OptionButton_is_item_disabled>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_item<class_OptionButton_remove_item>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`select<class_OptionButton_select>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_disabled<class_OptionButton_set_item_disabled>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` disabled **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_icon<class_OptionButton_set_item_icon>` **(** :ref:`int<class_int>` idx, :ref:`Texture<class_texture>` texture **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_id<class_OptionButton_set_item_id>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` id **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_metadata<class_OptionButton_set_item_metadata>` **(** :ref:`int<class_int>` idx, :ref:`Variant<class_variant>` metadata **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_text<class_OptionButton_set_item_text>` **(** :ref:`int<class_int>` idx, :ref:`String<class_string>` text **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_icon_item<class_OptionButton_add_icon_item>` **(** :ref:`Texture<class_texture>` texture, :ref:`String<class_string>` label, :ref:`int<class_int>` id=-1 **)** |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_item<class_OptionButton_add_item>` **(** :ref:`String<class_string>` label, :ref:`int<class_int>` id=-1 **)** |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_separator<class_OptionButton_add_separator>` **(** **)** |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_OptionButton_clear>` **(** **)** |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_item_count<class_OptionButton_get_item_count>` **(** **)** const |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_item_icon<class_OptionButton_get_item_icon>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_item_id<class_OptionButton_get_item_id>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_item_metadata<class_OptionButton_get_item_metadata>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_item_text<class_OptionButton_get_item_text>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PopupMenu<class_popupmenu>` | :ref:`get_popup<class_OptionButton_get_popup>` **(** **)** const |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_selected_id<class_OptionButton_get_selected_id>` **(** **)** const |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_selected_metadata<class_OptionButton_get_selected_metadata>` **(** **)** const |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_item_disabled<class_OptionButton_is_item_disabled>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_item<class_OptionButton_remove_item>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`select<class_OptionButton_select>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_disabled<class_OptionButton_set_item_disabled>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` disabled **)** |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_icon<class_OptionButton_set_item_icon>` **(** :ref:`int<class_int>` idx, :ref:`Texture<class_texture>` texture **)** |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_id<class_OptionButton_set_item_id>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` id **)** |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_metadata<class_OptionButton_set_item_metadata>` **(** :ref:`int<class_int>` idx, :ref:`Variant<class_variant>` metadata **)** |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_text<class_OptionButton_set_item_text>` **(** :ref:`int<class_int>` idx, :ref:`String<class_string>` text **)** |
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -95,7 +95,7 @@ Member Function Description
.. _class_OptionButton_add_icon_item:
- void **add_icon_item** **(** :ref:`Texture<class_texture>` texture, :ref:`String<class_string>` label, :ref:`int<class_int>` id **)**
- void **add_icon_item** **(** :ref:`Texture<class_texture>` texture, :ref:`String<class_string>` label, :ref:`int<class_int>` id=-1 **)**
Add an item, with a "texture" icon, text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end.

View File

@@ -0,0 +1,57 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the OrientedPathFollow.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_OrientedPathFollow:
OrientedPathFollow
==================
**Inherits:** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Oriented point sampler for a :ref:`Path<class_path>`.
Member Variables
----------------
.. _class_OrientedPathFollow_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_OrientedPathFollow_h_offset:
- :ref:`float<class_float>` **h_offset** - The node's offset along the curve.
.. _class_OrientedPathFollow_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_OrientedPathFollow_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_OrientedPathFollow_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_OrientedPathFollow_v_offset:
- :ref:`float<class_float>` **v_offset** - The node's offset perpendicular to the curve.
Description
-----------
This node behaves like :ref:`PathFollow<class_pathfollow>`, except it uses its parent :ref:`Path<class_path>` up vector information to enforce orientation.
Make sure to check if the curve of this node's parent :ref:`Path<class_path>` has up vectors enabled. See :ref:`PathFollow<class_pathfollow>` and :ref:`Curve3D<class_curve3d>` for further information.

View File

@@ -70,7 +70,7 @@ Member Functions
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_power_seconds_left<class_OS_get_power_seconds_left>` **(** **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_power_state<class_OS_get_power_state>` **(** **)** |
| :ref:`PowerState<enum_os_powerstate>` | :ref:`get_power_state<class_OS_get_power_state>` **(** **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_process_id<class_OS_get_process_id>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -94,7 +94,7 @@ Member Functions
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_static_memory_usage<class_OS_get_static_memory_usage>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_system_dir<class_OS_get_system_dir>` **(** :ref:`int<class_int>` dir **)** const |
| :ref:`String<class_string>` | :ref:`get_system_dir<class_OS_get_system_dir>` **(** :ref:`SystemDir<enum_os_systemdir>` dir **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_system_time_secs<class_OS_get_system_time_secs>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -118,6 +118,8 @@ Member Functions
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_virtual_keyboard_height<class_OS_get_virtual_keyboard_height>` **(** **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_window_safe_area<class_OS_get_window_safe_area>` **(** **)** 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 |
@@ -140,13 +142,13 @@ Member Functions
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_window_always_on_top<class_OS_is_window_always_on_top>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`kill<class_OS_kill>` **(** :ref:`int<class_int>` pid **)** |
| :ref:`Error<enum_@globalscope_error>` | :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>` **(** **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`native_video_pause<class_OS_native_video_pause>` **(** **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`native_video_play<class_OS_native_video_play>` **(** :ref:`String<class_string>` path, :ref:`float<class_float>` volume, :ref:`String<class_string>` audio_track, :ref:`String<class_string>` subtitle_track **)** |
| :ref:`Error<enum_@globalscope_error>` | :ref:`native_video_play<class_OS_native_video_play>` **(** :ref:`String<class_string>` path, :ref:`float<class_float>` volume, :ref:`String<class_string>` audio_track, :ref:`String<class_string>` subtitle_track **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`native_video_stop<class_OS_native_video_stop>` **(** **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -166,7 +168,7 @@ Member Functions
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ime_position<class_OS_set_ime_position>` **(** :ref:`Vector2<class_vector2>` position **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`set_thread_name<class_OS_set_thread_name>` **(** :ref:`String<class_string>` name **)** |
| :ref:`Error<enum_@globalscope_error>` | :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 **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -174,7 +176,7 @@ Member Functions
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 **)** |
| :ref:`Error<enum_@globalscope_error>` | :ref:`shell_open<class_OS_shell_open>` **(** :ref:`String<class_string>` uri **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`show_virtual_keyboard<class_OS_show_virtual_keyboard>` **(** :ref:`String<class_string>` existing_text="" **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -204,7 +206,7 @@ Member Variables
.. _class_OS_screen_orientation:
- :ref:`ScreenOrientation<enum_os_screenorientation>` **screen_orientation** - The current screen orientation.
- _OS.ScreenOrientation **screen_orientation** - The current screen orientation.
.. _class_OS_vsync_enabled:
@@ -226,6 +228,10 @@ Member Variables
- :ref:`bool<class_bool>` **window_minimized** - If ``true`` the window is minimized.
.. _class_OS_window_per_pixel_transparency_enabled:
- :ref:`bool<class_bool>` **window_per_pixel_transparency_enabled**
.. _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.
@@ -494,7 +500,7 @@ Returns the time in seconds before the device runs out of battery.
.. _class_OS_get_power_state:
- :ref:`int<class_int>` **get_power_state** **(** **)**
- :ref:`PowerState<enum_os_powerstate>` **get_power_state** **(** **)**
Returns the current state of the device regarding battery and power. See ``POWERSTATE_*`` constants.
@@ -580,7 +586,7 @@ Returns the amount of static memory being used by the program in bytes.
.. _class_OS_get_system_dir:
- :ref:`String<class_string>` **get_system_dir** **(** :ref:`int<class_int>` dir **)** const
- :ref:`String<class_string>` **get_system_dir** **(** :ref:`SystemDir<enum_os_systemdir>` dir **)** const
Returns the actual path to commonly used folders across different platforms. Available locations are specified in OS.SystemDir.
@@ -660,6 +666,10 @@ If the project name is empty, ``user://`` falls back to ``res://``.
Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or it is currently hidden.
.. _class_OS_get_window_safe_area:
- :ref:`Rect2<class_rect2>` **get_window_safe_area** **(** **)** const
.. _class_OS_has_environment:
- :ref:`bool<class_bool>` **has_environment** **(** :ref:`String<class_string>` environment **)** const
@@ -732,7 +742,7 @@ Returns ``true`` if the window should always be on top of other windows.
.. _class_OS_kill:
- :ref:`int<class_int>` **kill** **(** :ref:`int<class_int>` pid **)**
- :ref:`Error<enum_@globalscope_error>` **kill** **(** :ref:`int<class_int>` pid **)**
Kill a process ID (this method can be used to kill processes that were not spawned by the game).
@@ -750,7 +760,7 @@ Pauses native video playback.
.. _class_OS_native_video_play:
- :ref:`int<class_int>` **native_video_play** **(** :ref:`String<class_string>` path, :ref:`float<class_float>` volume, :ref:`String<class_string>` audio_track, :ref:`String<class_string>` subtitle_track **)**
- :ref:`Error<enum_@globalscope_error>` **native_video_play** **(** :ref:`String<class_string>` path, :ref:`float<class_float>` volume, :ref:`String<class_string>` audio_track, :ref:`String<class_string>` subtitle_track **)**
Plays native video from the specified path, at the given volume and with audio and subtitle tracks.
@@ -808,7 +818,7 @@ Sets the game's icon.
.. _class_OS_set_thread_name:
- :ref:`int<class_int>` **set_thread_name** **(** :ref:`String<class_string>` name **)**
- :ref:`Error<enum_@globalscope_error>` **set_thread_name** **(** :ref:`String<class_string>` name **)**
Sets the name of the current thread.
@@ -832,7 +842,7 @@ Sets the window title to the specified string.
.. _class_OS_shell_open:
- :ref:`int<class_int>` **shell_open** **(** :ref:`String<class_string>` uri **)**
- :ref:`Error<enum_@globalscope_error>` **shell_open** **(** :ref:`String<class_string>` uri **)**
Requests the OS to open a resource with the most appropriate program. For example.

View File

@@ -19,11 +19,11 @@ Brief Description
Member Functions
----------------
+------------------------+---------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`pack<class_PackedDataContainer_pack>` **(** :ref:`Variant<class_variant>` value **)** |
+------------------------+---------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size<class_PackedDataContainer_size>` **(** **)** const |
+------------------------+---------------------------------------------------------------------------------------------+
+----------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`pack<class_PackedDataContainer_pack>` **(** :ref:`Variant<class_variant>` value **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size<class_PackedDataContainer_size>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -38,7 +38,7 @@ Member Function Description
.. _class_PackedDataContainer_pack:
- :ref:`int<class_int>` **pack** **(** :ref:`Variant<class_variant>` value **)**
- :ref:`Error<enum_@globalscope_error>` **pack** **(** :ref:`Variant<class_variant>` value **)**
.. _class_PackedDataContainer_size:

View File

@@ -19,15 +19,15 @@ An abstraction of a serialized scene.
Member Functions
----------------
+--------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`can_instance<class_PackedScene_can_instance>` **(** **)** const |
+--------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`SceneState<class_scenestate>` | :ref:`get_state<class_PackedScene_get_state>` **(** **)** |
+--------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`Node<class_node>` | :ref:`instance<class_PackedScene_instance>` **(** :ref:`int<class_int>` edit_state=0 **)** const |
+--------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`pack<class_PackedScene_pack>` **(** :ref:`Node<class_node>` path **)** |
+--------------------------------------+--------------------------------------------------------------------------------------------------+
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`can_instance<class_PackedScene_can_instance>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`SceneState<class_scenestate>` | :ref:`get_state<class_PackedScene_get_state>` **(** **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Node<class_node>` | :ref:`instance<class_PackedScene_instance>` **(** :ref:`GenEditState<enum_packedscene_geneditstate>` edit_state=0 **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`pack<class_PackedScene_pack>` **(** :ref:`Node<class_node>` path **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -84,13 +84,13 @@ Returns the ``SceneState`` representing the scene file contents.
.. _class_PackedScene_instance:
- :ref:`Node<class_node>` **instance** **(** :ref:`int<class_int>` edit_state=0 **)** const
- :ref:`Node<class_node>` **instance** **(** :ref:`GenEditState<enum_packedscene_geneditstate>` edit_state=0 **)** const
Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers the enum Object.NOTIFICATION_INSTANCED notification on the root node.
Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers the :ref:`NOTIFICATION_INSTANCED<enum_object_notification_instanced>` notification on the root node.
.. _class_PackedScene_pack:
- :ref:`int<class_int>` **pack** **(** :ref:`Node<class_node>` path **)**
- :ref:`Error<enum_@globalscope_error>` **pack** **(** :ref:`Node<class_node>` path **)**
Pack will ignore any sub-nodes not owned by given node. See :ref:`Node.set_owner<class_Node_set_owner>`.

View File

@@ -26,13 +26,13 @@ Member Functions
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :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:`Error<enum_@globalscope_error>` | :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:`Error<enum_@globalscope_error>` | :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 **)** |
| :ref:`Error<enum_@globalscope_error>` | :ref:`put_var<class_PacketPeer_put_var>` **(** :ref:`Variant<class_variant>` var **)** |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
Member Variables
@@ -65,7 +65,7 @@ Get a raw packet.
.. _class_PacketPeer_get_packet_error:
- :ref:`int<class_int>` **get_packet_error** **(** **)** const
- :ref:`Error<enum_@globalscope_error>` **get_packet_error** **(** **)** const
Return the error state of the last packet received (via :ref:`get_packet<class_PacketPeer_get_packet>` and :ref:`get_var<class_PacketPeer_get_var>`).
@@ -77,13 +77,13 @@ Get a Variant.
.. _class_PacketPeer_put_packet:
- :ref:`int<class_int>` **put_packet** **(** :ref:`PoolByteArray<class_poolbytearray>` buffer **)**
- :ref:`Error<enum_@globalscope_error>` **put_packet** **(** :ref:`PoolByteArray<class_poolbytearray>` buffer **)**
Send a raw packet.
.. _class_PacketPeer_put_var:
- :ref:`int<class_int>` **put_var** **(** :ref:`Variant<class_variant>` var **)**
- :ref:`Error<enum_@globalscope_error>` **put_var** **(** :ref:`Variant<class_variant>` var **)**
Send a Variant as a packet.

View File

@@ -19,21 +19,21 @@ UDP packet peer.
Member Functions
----------------
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`close<class_PacketPeerUDP_close>` **(** **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_packet_ip<class_PacketPeerUDP_get_packet_ip>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_packet_port<class_PacketPeerUDP_get_packet_port>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_listening<class_PacketPeerUDP_is_listening>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`listen<class_PacketPeerUDP_listen>` **(** :ref:`int<class_int>` port, :ref:`String<class_string>` bind_address="*", :ref:`int<class_int>` recv_buf_size=65536 **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`set_dest_address<class_PacketPeerUDP_set_dest_address>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`wait<class_PacketPeerUDP_wait>` **(** **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`close<class_PacketPeerUDP_close>` **(** **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_packet_ip<class_PacketPeerUDP_get_packet_ip>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_packet_port<class_PacketPeerUDP_get_packet_port>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_listening<class_PacketPeerUDP_is_listening>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`listen<class_PacketPeerUDP_listen>` **(** :ref:`int<class_int>` port, :ref:`String<class_string>` bind_address="*", :ref:`int<class_int>` recv_buf_size=65536 **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`set_dest_address<class_PacketPeerUDP_set_dest_address>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`wait<class_PacketPeerUDP_wait>` **(** **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -53,13 +53,13 @@ Close the UDP socket the ``PacketPeerUDP`` is currently listening on.
- :ref:`String<class_string>` **get_packet_ip** **(** **)** const
Return the IP of the remote peer that sent the last packet(that was received with :ref:`get_packet<class_PacketPeerUDP_get_packet>` or :ref:`get_var<class_PacketPeerUDP_get_var>`).
Return the IP of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet<class_PacketPeer_get_packet>` or :ref:`PacketPeer.get_var<class_PacketPeer_get_var>`).
.. _class_PacketPeerUDP_get_packet_port:
- :ref:`int<class_int>` **get_packet_port** **(** **)** const
Return the port of the remote peer that sent the last packet(that was received with :ref:`get_packet<class_PacketPeerUDP_get_packet>` or :ref:`get_var<class_PacketPeerUDP_get_var>`).
Return the port of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet<class_PacketPeer_get_packet>` or :ref:`PacketPeer.get_var<class_PacketPeer_get_var>`).
.. _class_PacketPeerUDP_is_listening:
@@ -69,7 +69,7 @@ Return whether this ``PacketPeerUDP`` is listening.
.. _class_PacketPeerUDP_listen:
- :ref:`int<class_int>` **listen** **(** :ref:`int<class_int>` port, :ref:`String<class_string>` bind_address="*", :ref:`int<class_int>` recv_buf_size=65536 **)**
- :ref:`Error<enum_@globalscope_error>` **listen** **(** :ref:`int<class_int>` port, :ref:`String<class_string>` bind_address="*", :ref:`int<class_int>` recv_buf_size=65536 **)**
Make this ``PacketPeerUDP`` listen on the "port" binding to "bind_address" with a buffer size "recv_buf_size".
@@ -81,13 +81,13 @@ If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc)
.. _class_PacketPeerUDP_set_dest_address:
- :ref:`int<class_int>` **set_dest_address** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port **)**
- :ref:`Error<enum_@globalscope_error>` **set_dest_address** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port **)**
Set the destination address and port for sending packets and variables, a hostname will be resolved using if valid.
.. _class_PacketPeerUDP_wait:
- :ref:`int<class_int>` **wait** **(** **)**
- :ref:`Error<enum_@globalscope_error>` **wait** **(** **)**
Wait for a packet to arrive on the listening port, see :ref:`listen<class_PacketPeerUDP_listen>`.

View File

@@ -14,13 +14,18 @@ PanoramaSky
Brief Description
-----------------
A type of :ref:`Sky<class_sky>` used to draw a background texture.
Member Variables
----------------
.. _class_PanoramaSky_panorama:
- :ref:`Texture<class_texture>` **panorama**
- :ref:`Texture<class_texture>` **panorama** - :ref:`Texture<class_texture>` to be applied to the PanoramaSky.
Description
-----------
A resource referenced in an :ref:`Environment<class_environment>` that is used to draw a background. The Panorama sky functions similar to skyboxes in other engines except it uses a equirectangular sky map instead of a cube map.

View File

@@ -16,6 +16,14 @@ Brief Description
Container for a :ref:`Curve3D<class_curve3d>`.
Signals
-------
.. _class_Path_curve_changed:
- **curve_changed** **(** **)**
Member Variables
----------------

View File

@@ -19,27 +19,27 @@ Brief Description
Member Functions
----------------
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`add_file<class_PCKPacker_add_file>` **(** :ref:`String<class_string>` pck_path, :ref:`String<class_string>` source_path **)** |
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`flush<class_PCKPacker_flush>` **(** :ref:`bool<class_bool>` verbose **)** |
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`pck_start<class_PCKPacker_pck_start>` **(** :ref:`String<class_string>` pck_name, :ref:`int<class_int>` alignment **)** |
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`add_file<class_PCKPacker_add_file>` **(** :ref:`String<class_string>` pck_path, :ref:`String<class_string>` source_path **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`flush<class_PCKPacker_flush>` **(** :ref:`bool<class_bool>` verbose **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`pck_start<class_PCKPacker_pck_start>` **(** :ref:`String<class_string>` pck_name, :ref:`int<class_int>` alignment **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_PCKPacker_add_file:
- :ref:`int<class_int>` **add_file** **(** :ref:`String<class_string>` pck_path, :ref:`String<class_string>` source_path **)**
- :ref:`Error<enum_@globalscope_error>` **add_file** **(** :ref:`String<class_string>` pck_path, :ref:`String<class_string>` source_path **)**
.. _class_PCKPacker_flush:
- :ref:`int<class_int>` **flush** **(** :ref:`bool<class_bool>` verbose **)**
- :ref:`Error<enum_@globalscope_error>` **flush** **(** :ref:`bool<class_bool>` verbose **)**
.. _class_PCKPacker_pck_start:
- :ref:`int<class_int>` **pck_start** **(** :ref:`String<class_string>` pck_name, :ref:`int<class_int>` alignment **)**
- :ref:`Error<enum_@globalscope_error>` **pck_start** **(** :ref:`String<class_string>` pck_name, :ref:`int<class_int>` alignment **)**

View File

@@ -19,9 +19,9 @@ Exposes performance related data.
Member Functions
----------------
+----------------------------+---------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_monitor<class_Performance_get_monitor>` **(** :ref:`int<class_int>` monitor **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------+
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_monitor<class_Performance_get_monitor>` **(** :ref:`Monitor<enum_performance_monitor>` monitor **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
Enums
-----
@@ -72,7 +72,7 @@ Member Function Description
.. _class_Performance_get_monitor:
- :ref:`float<class_float>` **get_monitor** **(** :ref:`int<class_int>` monitor **)** const
- :ref:`float<class_float>` **get_monitor** **(** :ref:`Monitor<enum_performance_monitor>` monitor **)** const
Returns the value of one of the available monitors. You should provide one of this class's constants as the argument, like this:

View File

@@ -0,0 +1,96 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the PhysicalBone.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_PhysicalBone:
PhysicalBone
============
**Inherits:** :ref:`PhysicsBody<class_physicsbody>` **<** :ref:`CollisionObject<class_collisionobject>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+--------------------------+------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_simulate_physics<class_PhysicalBone_get_simulate_physics>` **(** **)** |
+--------------------------+------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_simulating_physics<class_PhysicalBone_is_simulating_physics>` **(** **)** |
+--------------------------+------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_static_body<class_PhysicalBone_is_static_body>` **(** **)** |
+--------------------------+------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_PhysicalBone_body_offset:
- :ref:`Transform<class_transform>` **body_offset**
.. _class_PhysicalBone_bounce:
- :ref:`float<class_float>` **bounce**
.. _class_PhysicalBone_friction:
- :ref:`float<class_float>` **friction**
.. _class_PhysicalBone_gravity_scale:
- :ref:`float<class_float>` **gravity_scale**
.. _class_PhysicalBone_joint_offset:
- :ref:`Transform<class_transform>` **joint_offset**
.. _class_PhysicalBone_joint_type:
- :ref:`JointType<enum_physicalbone_jointtype>` **joint_type**
.. _class_PhysicalBone_mass:
- :ref:`float<class_float>` **mass**
.. _class_PhysicalBone_weight:
- :ref:`float<class_float>` **weight**
Enums
-----
.. _enum_PhysicalBone_JointType:
enum **JointType**
- **JOINT_TYPE_NONE** = **0**
- **JOINT_TYPE_PIN** = **1**
- **JOINT_TYPE_CONE** = **2**
- **JOINT_TYPE_HINGE** = **3**
- **JOINT_TYPE_SLIDER** = **4**
- **JOINT_TYPE_6DOF** = **5**
Member Function Description
---------------------------
.. _class_PhysicalBone_get_simulate_physics:
- :ref:`bool<class_bool>` **get_simulate_physics** **(** **)**
.. _class_PhysicalBone_is_simulating_physics:
- :ref:`bool<class_bool>` **is_simulating_physics** **(** **)**
.. _class_PhysicalBone_is_static_body:
- :ref:`bool<class_bool>` **is_static_body** **(** **)**

View File

@@ -21,191 +21,195 @@ Physics 2D Server.
Member Functions
----------------
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_add_shape<class_Physics2DServer_area_add_shape>` **(** :ref:`RID<class_rid>` area, :ref:`RID<class_rid>` shape, :ref:`Transform2D<class_transform2d>` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_attach_object_instance_id<class_Physics2DServer_area_attach_object_instance_id>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` id **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_clear_shapes<class_Physics2DServer_area_clear_shapes>` **(** :ref:`RID<class_rid>` area **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`area_create<class_Physics2DServer_area_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`area_get_object_instance_id<class_Physics2DServer_area_get_object_instance_id>` **(** :ref:`RID<class_rid>` area **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`area_get_param<class_Physics2DServer_area_get_param>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` param **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`area_get_shape<class_Physics2DServer_area_get_shape>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`area_get_shape_count<class_Physics2DServer_area_get_shape_count>` **(** :ref:`RID<class_rid>` area **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`area_get_shape_transform<class_Physics2DServer_area_get_shape_transform>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`area_get_space<class_Physics2DServer_area_get_space>` **(** :ref:`RID<class_rid>` area **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`area_get_space_override_mode<class_Physics2DServer_area_get_space_override_mode>` **(** :ref:`RID<class_rid>` area **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`area_get_transform<class_Physics2DServer_area_get_transform>` **(** :ref:`RID<class_rid>` area **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_remove_shape<class_Physics2DServer_area_remove_shape>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_collision_layer<class_Physics2DServer_area_set_collision_layer>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` layer **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_collision_mask<class_Physics2DServer_area_set_collision_mask>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mask **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_monitor_callback<class_Physics2DServer_area_set_monitor_callback>` **(** :ref:`RID<class_rid>` area, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_param<class_Physics2DServer_area_set_param>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` param, :ref:`Variant<class_variant>` value **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_shape<class_Physics2DServer_area_set_shape>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx, :ref:`RID<class_rid>` shape **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_shape_disabled<class_Physics2DServer_area_set_shape_disabled>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disable **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_shape_transform<class_Physics2DServer_area_set_shape_transform>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_transform2d>` transform **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_space<class_Physics2DServer_area_set_space>` **(** :ref:`RID<class_rid>` area, :ref:`RID<class_rid>` space **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_space_override_mode<class_Physics2DServer_area_set_space_override_mode>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mode **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_transform<class_Physics2DServer_area_set_transform>` **(** :ref:`RID<class_rid>` area, :ref:`Transform2D<class_transform2d>` transform **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_add_collision_exception<class_Physics2DServer_body_add_collision_exception>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` excepted_body **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_add_force<class_Physics2DServer_body_add_force>` **(** :ref:`RID<class_rid>` body, :ref:`Vector2<class_vector2>` offset, :ref:`Vector2<class_vector2>` force **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_add_shape<class_Physics2DServer_body_add_shape>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` shape, :ref:`Transform2D<class_transform2d>` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_apply_impulse<class_Physics2DServer_body_apply_impulse>` **(** :ref:`RID<class_rid>` body, :ref:`Vector2<class_vector2>` position, :ref:`Vector2<class_vector2>` impulse **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_attach_object_instance_id<class_Physics2DServer_body_attach_object_instance_id>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` id **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_clear_shapes<class_Physics2DServer_body_clear_shapes>` **(** :ref:`RID<class_rid>` body **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`body_create<class_Physics2DServer_body_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_collision_layer<class_Physics2DServer_body_get_collision_layer>` **(** :ref:`RID<class_rid>` body **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_collision_mask<class_Physics2DServer_body_get_collision_mask>` **(** :ref:`RID<class_rid>` body **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_continuous_collision_detection_mode<class_Physics2DServer_body_get_continuous_collision_detection_mode>` **(** :ref:`RID<class_rid>` body **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Physics2DDirectBodyState<class_physics2ddirectbodystate>` | :ref:`body_get_direct_state<class_Physics2DServer_body_get_direct_state>` **(** :ref:`RID<class_rid>` body **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_max_contacts_reported<class_Physics2DServer_body_get_max_contacts_reported>` **(** :ref:`RID<class_rid>` body **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_mode<class_Physics2DServer_body_get_mode>` **(** :ref:`RID<class_rid>` body **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_object_instance_id<class_Physics2DServer_body_get_object_instance_id>` **(** :ref:`RID<class_rid>` body **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`body_get_param<class_Physics2DServer_body_get_param>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` param **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`body_get_shape<class_Physics2DServer_body_get_shape>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_shape_count<class_Physics2DServer_body_get_shape_count>` **(** :ref:`RID<class_rid>` body **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`body_get_shape_metadata<class_Physics2DServer_body_get_shape_metadata>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`body_get_shape_transform<class_Physics2DServer_body_get_shape_transform>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`body_get_space<class_Physics2DServer_body_get_space>` **(** :ref:`RID<class_rid>` body **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`body_get_state<class_Physics2DServer_body_get_state>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` state **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`body_is_omitting_force_integration<class_Physics2DServer_body_is_omitting_force_integration>` **(** :ref:`RID<class_rid>` body **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_remove_collision_exception<class_Physics2DServer_body_remove_collision_exception>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` excepted_body **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_remove_shape<class_Physics2DServer_body_remove_shape>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_axis_velocity<class_Physics2DServer_body_set_axis_velocity>` **(** :ref:`RID<class_rid>` body, :ref:`Vector2<class_vector2>` axis_velocity **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_collision_layer<class_Physics2DServer_body_set_collision_layer>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` layer **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_collision_mask<class_Physics2DServer_body_set_collision_mask>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mask **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_continuous_collision_detection_mode<class_Physics2DServer_body_set_continuous_collision_detection_mode>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mode **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_force_integration_callback<class_Physics2DServer_body_set_force_integration_callback>` **(** :ref:`RID<class_rid>` body, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` userdata=null **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_max_contacts_reported<class_Physics2DServer_body_set_max_contacts_reported>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` amount **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_mode<class_Physics2DServer_body_set_mode>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mode **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_omit_force_integration<class_Physics2DServer_body_set_omit_force_integration>` **(** :ref:`RID<class_rid>` body, :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_param<class_Physics2DServer_body_set_param>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_shape<class_Physics2DServer_body_set_shape>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx, :ref:`RID<class_rid>` shape **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_shape_as_one_way_collision<class_Physics2DServer_body_set_shape_as_one_way_collision>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_shape_disabled<class_Physics2DServer_body_set_shape_disabled>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disable **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_shape_metadata<class_Physics2DServer_body_set_shape_metadata>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx, :ref:`Variant<class_variant>` metadata **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_shape_transform<class_Physics2DServer_body_set_shape_transform>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_transform2d>` transform **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_space<class_Physics2DServer_body_set_space>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` space **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_state<class_Physics2DServer_body_set_state>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` state, :ref:`Variant<class_variant>` value **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`body_test_motion<class_Physics2DServer_body_test_motion>` **(** :ref:`RID<class_rid>` body, :ref:`Transform2D<class_transform2d>` from, :ref:`Vector2<class_vector2>` motion, :ref:`bool<class_bool>` infinite_inertia, :ref:`float<class_float>` margin=0.08, :ref:`Physics2DTestMotionResult<class_physics2dtestmotionresult>` result=null **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`capsule_shape_create<class_Physics2DServer_capsule_shape_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`circle_shape_create<class_Physics2DServer_circle_shape_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`concave_polygon_shape_create<class_Physics2DServer_concave_polygon_shape_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`convex_polygon_shape_create<class_Physics2DServer_convex_polygon_shape_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`damped_spring_joint_create<class_Physics2DServer_damped_spring_joint_create>` **(** :ref:`Vector2<class_vector2>` anchor_a, :ref:`Vector2<class_vector2>` anchor_b, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`damped_string_joint_get_param<class_Physics2DServer_damped_string_joint_get_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`damped_string_joint_set_param<class_Physics2DServer_damped_string_joint_set_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`free_rid<class_Physics2DServer_free_rid>` **(** :ref:`RID<class_rid>` rid **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_process_info<class_Physics2DServer_get_process_info>` **(** :ref:`int<class_int>` process_info **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`groove_joint_create<class_Physics2DServer_groove_joint_create>` **(** :ref:`Vector2<class_vector2>` groove1_a, :ref:`Vector2<class_vector2>` groove2_a, :ref:`Vector2<class_vector2>` anchor_b, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`joint_get_param<class_Physics2DServer_joint_get_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`joint_get_type<class_Physics2DServer_joint_get_type>` **(** :ref:`RID<class_rid>` joint **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`joint_set_param<class_Physics2DServer_joint_set_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`line_shape_create<class_Physics2DServer_line_shape_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`pin_joint_create<class_Physics2DServer_pin_joint_create>` **(** :ref:`Vector2<class_vector2>` anchor, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`ray_shape_create<class_Physics2DServer_ray_shape_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`rectangle_shape_create<class_Physics2DServer_rectangle_shape_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`segment_shape_create<class_Physics2DServer_segment_shape_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_active<class_Physics2DServer_set_active>` **(** :ref:`bool<class_bool>` active **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`shape_get_data<class_Physics2DServer_shape_get_data>` **(** :ref:`RID<class_rid>` shape **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`shape_get_type<class_Physics2DServer_shape_get_type>` **(** :ref:`RID<class_rid>` shape **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`shape_set_data<class_Physics2DServer_shape_set_data>` **(** :ref:`RID<class_rid>` shape, :ref:`Variant<class_variant>` data **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`space_create<class_Physics2DServer_space_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Physics2DDirectSpaceState<class_physics2ddirectspacestate>` | :ref:`space_get_direct_state<class_Physics2DServer_space_get_direct_state>` **(** :ref:`RID<class_rid>` space **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`space_get_param<class_Physics2DServer_space_get_param>` **(** :ref:`RID<class_rid>` space, :ref:`int<class_int>` param **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`space_is_active<class_Physics2DServer_space_is_active>` **(** :ref:`RID<class_rid>` space **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`space_set_active<class_Physics2DServer_space_set_active>` **(** :ref:`RID<class_rid>` space, :ref:`bool<class_bool>` active **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`space_set_param<class_Physics2DServer_space_set_param>` **(** :ref:`RID<class_rid>` space, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_add_shape<class_Physics2DServer_area_add_shape>` **(** :ref:`RID<class_rid>` area, :ref:`RID<class_rid>` shape, :ref:`Transform2D<class_transform2d>` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_attach_object_instance_id<class_Physics2DServer_area_attach_object_instance_id>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` id **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_clear_shapes<class_Physics2DServer_area_clear_shapes>` **(** :ref:`RID<class_rid>` area **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`area_create<class_Physics2DServer_area_create>` **(** **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`area_get_object_instance_id<class_Physics2DServer_area_get_object_instance_id>` **(** :ref:`RID<class_rid>` area **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`area_get_param<class_Physics2DServer_area_get_param>` **(** :ref:`RID<class_rid>` area, :ref:`AreaParameter<enum_physics2dserver_areaparameter>` param **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`area_get_shape<class_Physics2DServer_area_get_shape>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`area_get_shape_count<class_Physics2DServer_area_get_shape_count>` **(** :ref:`RID<class_rid>` area **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`area_get_shape_transform<class_Physics2DServer_area_get_shape_transform>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`area_get_space<class_Physics2DServer_area_get_space>` **(** :ref:`RID<class_rid>` area **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AreaSpaceOverrideMode<enum_physics2dserver_areaspaceoverridemode>` | :ref:`area_get_space_override_mode<class_Physics2DServer_area_get_space_override_mode>` **(** :ref:`RID<class_rid>` area **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`area_get_transform<class_Physics2DServer_area_get_transform>` **(** :ref:`RID<class_rid>` area **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_remove_shape<class_Physics2DServer_area_remove_shape>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_area_monitor_callback<class_Physics2DServer_area_set_area_monitor_callback>` **(** :ref:`RID<class_rid>` area, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_collision_layer<class_Physics2DServer_area_set_collision_layer>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` layer **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_collision_mask<class_Physics2DServer_area_set_collision_mask>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mask **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_monitor_callback<class_Physics2DServer_area_set_monitor_callback>` **(** :ref:`RID<class_rid>` area, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_monitorable<class_Physics2DServer_area_set_monitorable>` **(** :ref:`RID<class_rid>` area, :ref:`bool<class_bool>` monitorable **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_param<class_Physics2DServer_area_set_param>` **(** :ref:`RID<class_rid>` area, :ref:`AreaParameter<enum_physics2dserver_areaparameter>` param, :ref:`Variant<class_variant>` value **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_shape<class_Physics2DServer_area_set_shape>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx, :ref:`RID<class_rid>` shape **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_shape_disabled<class_Physics2DServer_area_set_shape_disabled>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disable **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_shape_transform<class_Physics2DServer_area_set_shape_transform>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_transform2d>` transform **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_space<class_Physics2DServer_area_set_space>` **(** :ref:`RID<class_rid>` area, :ref:`RID<class_rid>` space **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_space_override_mode<class_Physics2DServer_area_set_space_override_mode>` **(** :ref:`RID<class_rid>` area, :ref:`AreaSpaceOverrideMode<enum_physics2dserver_areaspaceoverridemode>` mode **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_transform<class_Physics2DServer_area_set_transform>` **(** :ref:`RID<class_rid>` area, :ref:`Transform2D<class_transform2d>` transform **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_add_collision_exception<class_Physics2DServer_body_add_collision_exception>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` excepted_body **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_add_force<class_Physics2DServer_body_add_force>` **(** :ref:`RID<class_rid>` body, :ref:`Vector2<class_vector2>` offset, :ref:`Vector2<class_vector2>` force **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_add_shape<class_Physics2DServer_body_add_shape>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` shape, :ref:`Transform2D<class_transform2d>` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_apply_impulse<class_Physics2DServer_body_apply_impulse>` **(** :ref:`RID<class_rid>` body, :ref:`Vector2<class_vector2>` position, :ref:`Vector2<class_vector2>` impulse **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_attach_object_instance_id<class_Physics2DServer_body_attach_object_instance_id>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` id **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_clear_shapes<class_Physics2DServer_body_clear_shapes>` **(** :ref:`RID<class_rid>` body **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`body_create<class_Physics2DServer_body_create>` **(** **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_collision_layer<class_Physics2DServer_body_get_collision_layer>` **(** :ref:`RID<class_rid>` body **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_collision_mask<class_Physics2DServer_body_get_collision_mask>` **(** :ref:`RID<class_rid>` body **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`CCDMode<enum_physics2dserver_ccdmode>` | :ref:`body_get_continuous_collision_detection_mode<class_Physics2DServer_body_get_continuous_collision_detection_mode>` **(** :ref:`RID<class_rid>` body **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Physics2DDirectBodyState<class_physics2ddirectbodystate>` | :ref:`body_get_direct_state<class_Physics2DServer_body_get_direct_state>` **(** :ref:`RID<class_rid>` body **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_max_contacts_reported<class_Physics2DServer_body_get_max_contacts_reported>` **(** :ref:`RID<class_rid>` body **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BodyMode<enum_physics2dserver_bodymode>` | :ref:`body_get_mode<class_Physics2DServer_body_get_mode>` **(** :ref:`RID<class_rid>` body **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_object_instance_id<class_Physics2DServer_body_get_object_instance_id>` **(** :ref:`RID<class_rid>` body **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`body_get_param<class_Physics2DServer_body_get_param>` **(** :ref:`RID<class_rid>` body, :ref:`BodyParameter<enum_physics2dserver_bodyparameter>` param **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`body_get_shape<class_Physics2DServer_body_get_shape>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_shape_count<class_Physics2DServer_body_get_shape_count>` **(** :ref:`RID<class_rid>` body **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`body_get_shape_metadata<class_Physics2DServer_body_get_shape_metadata>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`body_get_shape_transform<class_Physics2DServer_body_get_shape_transform>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`body_get_space<class_Physics2DServer_body_get_space>` **(** :ref:`RID<class_rid>` body **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`body_get_state<class_Physics2DServer_body_get_state>` **(** :ref:`RID<class_rid>` body, :ref:`BodyState<enum_physics2dserver_bodystate>` state **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`body_is_omitting_force_integration<class_Physics2DServer_body_is_omitting_force_integration>` **(** :ref:`RID<class_rid>` body **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_remove_collision_exception<class_Physics2DServer_body_remove_collision_exception>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` excepted_body **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_remove_shape<class_Physics2DServer_body_remove_shape>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_axis_velocity<class_Physics2DServer_body_set_axis_velocity>` **(** :ref:`RID<class_rid>` body, :ref:`Vector2<class_vector2>` axis_velocity **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_collision_layer<class_Physics2DServer_body_set_collision_layer>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` layer **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_collision_mask<class_Physics2DServer_body_set_collision_mask>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mask **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_continuous_collision_detection_mode<class_Physics2DServer_body_set_continuous_collision_detection_mode>` **(** :ref:`RID<class_rid>` body, :ref:`CCDMode<enum_physics2dserver_ccdmode>` mode **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_force_integration_callback<class_Physics2DServer_body_set_force_integration_callback>` **(** :ref:`RID<class_rid>` body, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` userdata=null **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_max_contacts_reported<class_Physics2DServer_body_set_max_contacts_reported>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` amount **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_mode<class_Physics2DServer_body_set_mode>` **(** :ref:`RID<class_rid>` body, :ref:`BodyMode<enum_physics2dserver_bodymode>` mode **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_omit_force_integration<class_Physics2DServer_body_set_omit_force_integration>` **(** :ref:`RID<class_rid>` body, :ref:`bool<class_bool>` enable **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_param<class_Physics2DServer_body_set_param>` **(** :ref:`RID<class_rid>` body, :ref:`BodyParameter<enum_physics2dserver_bodyparameter>` param, :ref:`float<class_float>` value **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_shape<class_Physics2DServer_body_set_shape>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx, :ref:`RID<class_rid>` shape **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_shape_as_one_way_collision<class_Physics2DServer_body_set_shape_as_one_way_collision>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` enable **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_shape_disabled<class_Physics2DServer_body_set_shape_disabled>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disable **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_shape_metadata<class_Physics2DServer_body_set_shape_metadata>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx, :ref:`Variant<class_variant>` metadata **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_shape_transform<class_Physics2DServer_body_set_shape_transform>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_transform2d>` transform **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_space<class_Physics2DServer_body_set_space>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` space **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_state<class_Physics2DServer_body_set_state>` **(** :ref:`RID<class_rid>` body, :ref:`BodyState<enum_physics2dserver_bodystate>` state, :ref:`Variant<class_variant>` value **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`body_test_motion<class_Physics2DServer_body_test_motion>` **(** :ref:`RID<class_rid>` body, :ref:`Transform2D<class_transform2d>` from, :ref:`Vector2<class_vector2>` motion, :ref:`bool<class_bool>` infinite_inertia, :ref:`float<class_float>` margin=0.08, :ref:`Physics2DTestMotionResult<class_physics2dtestmotionresult>` result=null **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`capsule_shape_create<class_Physics2DServer_capsule_shape_create>` **(** **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`circle_shape_create<class_Physics2DServer_circle_shape_create>` **(** **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`concave_polygon_shape_create<class_Physics2DServer_concave_polygon_shape_create>` **(** **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`convex_polygon_shape_create<class_Physics2DServer_convex_polygon_shape_create>` **(** **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`damped_spring_joint_create<class_Physics2DServer_damped_spring_joint_create>` **(** :ref:`Vector2<class_vector2>` anchor_a, :ref:`Vector2<class_vector2>` anchor_b, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`damped_string_joint_get_param<class_Physics2DServer_damped_string_joint_get_param>` **(** :ref:`RID<class_rid>` joint, :ref:`DampedStringParam<enum_physics2dserver_dampedstringparam>` param **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`damped_string_joint_set_param<class_Physics2DServer_damped_string_joint_set_param>` **(** :ref:`RID<class_rid>` joint, :ref:`DampedStringParam<enum_physics2dserver_dampedstringparam>` param, :ref:`float<class_float>` value **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`free_rid<class_Physics2DServer_free_rid>` **(** :ref:`RID<class_rid>` rid **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_process_info<class_Physics2DServer_get_process_info>` **(** :ref:`ProcessInfo<enum_physics2dserver_processinfo>` process_info **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`groove_joint_create<class_Physics2DServer_groove_joint_create>` **(** :ref:`Vector2<class_vector2>` groove1_a, :ref:`Vector2<class_vector2>` groove2_a, :ref:`Vector2<class_vector2>` anchor_b, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`joint_get_param<class_Physics2DServer_joint_get_param>` **(** :ref:`RID<class_rid>` joint, :ref:`JointParam<enum_physics2dserver_jointparam>` param **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`JointType<enum_physics2dserver_jointtype>` | :ref:`joint_get_type<class_Physics2DServer_joint_get_type>` **(** :ref:`RID<class_rid>` joint **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`joint_set_param<class_Physics2DServer_joint_set_param>` **(** :ref:`RID<class_rid>` joint, :ref:`JointParam<enum_physics2dserver_jointparam>` param, :ref:`float<class_float>` value **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`line_shape_create<class_Physics2DServer_line_shape_create>` **(** **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`pin_joint_create<class_Physics2DServer_pin_joint_create>` **(** :ref:`Vector2<class_vector2>` anchor, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`ray_shape_create<class_Physics2DServer_ray_shape_create>` **(** **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`rectangle_shape_create<class_Physics2DServer_rectangle_shape_create>` **(** **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`segment_shape_create<class_Physics2DServer_segment_shape_create>` **(** **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_active<class_Physics2DServer_set_active>` **(** :ref:`bool<class_bool>` active **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`shape_get_data<class_Physics2DServer_shape_get_data>` **(** :ref:`RID<class_rid>` shape **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ShapeType<enum_physics2dserver_shapetype>` | :ref:`shape_get_type<class_Physics2DServer_shape_get_type>` **(** :ref:`RID<class_rid>` shape **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`shape_set_data<class_Physics2DServer_shape_set_data>` **(** :ref:`RID<class_rid>` shape, :ref:`Variant<class_variant>` data **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`space_create<class_Physics2DServer_space_create>` **(** **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Physics2DDirectSpaceState<class_physics2ddirectspacestate>` | :ref:`space_get_direct_state<class_Physics2DServer_space_get_direct_state>` **(** :ref:`RID<class_rid>` space **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`space_get_param<class_Physics2DServer_space_get_param>` **(** :ref:`RID<class_rid>` space, :ref:`SpaceParameter<enum_physics2dserver_spaceparameter>` param **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`space_is_active<class_Physics2DServer_space_is_active>` **(** :ref:`RID<class_rid>` space **)** const |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`space_set_active<class_Physics2DServer_space_set_active>` **(** :ref:`RID<class_rid>` space, :ref:`bool<class_bool>` active **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`space_set_param<class_Physics2DServer_space_set_param>` **(** :ref:`RID<class_rid>` space, :ref:`SpaceParameter<enum_physics2dserver_spaceparameter>` param, :ref:`float<class_float>` value **)** |
+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Enums
-----
@@ -379,7 +383,7 @@ Gets the instance ID of the object the area is assigned to.
.. _class_Physics2DServer_area_get_param:
- :ref:`Variant<class_variant>` **area_get_param** **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` param **)** const
- :ref:`Variant<class_variant>` **area_get_param** **(** :ref:`RID<class_rid>` area, :ref:`AreaParameter<enum_physics2dserver_areaparameter>` param **)** const
Returns an area parameter value. A list of available parameters is on the AREA_PARAM\_\* constants.
@@ -409,7 +413,7 @@ Returns the space assigned to the area.
.. _class_Physics2DServer_area_get_space_override_mode:
- :ref:`int<class_int>` **area_get_space_override_mode** **(** :ref:`RID<class_rid>` area **)** const
- :ref:`AreaSpaceOverrideMode<enum_physics2dserver_areaspaceoverridemode>` **area_get_space_override_mode** **(** :ref:`RID<class_rid>` area **)** const
Returns the space override mode for the area.
@@ -425,6 +429,10 @@ Returns the transform matrix for an area.
Removes a shape from an area. It does not delete the shape, so it can be reassigned later.
.. _class_Physics2DServer_area_set_area_monitor_callback:
- void **area_set_area_monitor_callback** **(** :ref:`RID<class_rid>` area, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method **)**
.. _class_Physics2DServer_area_set_collision_layer:
- void **area_set_collision_layer** **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` layer **)**
@@ -453,9 +461,13 @@ Sets the function to call when any body/area enters or exits the area. This call
5: The shape index of the area where the object entered/exited.
.. _class_Physics2DServer_area_set_monitorable:
- void **area_set_monitorable** **(** :ref:`RID<class_rid>` area, :ref:`bool<class_bool>` monitorable **)**
.. _class_Physics2DServer_area_set_param:
- void **area_set_param** **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` param, :ref:`Variant<class_variant>` value **)**
- void **area_set_param** **(** :ref:`RID<class_rid>` area, :ref:`AreaParameter<enum_physics2dserver_areaparameter>` param, :ref:`Variant<class_variant>` value **)**
Sets the value for an area parameter. A list of available parameters is on the AREA_PARAM\_\* constants.
@@ -485,7 +497,7 @@ Assigns a space to the area.
.. _class_Physics2DServer_area_set_space_override_mode:
- void **area_set_space_override_mode** **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mode **)**
- void **area_set_space_override_mode** **(** :ref:`RID<class_rid>` area, :ref:`AreaSpaceOverrideMode<enum_physics2dserver_areaspaceoverridemode>` mode **)**
Sets the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE\_\*.
@@ -551,7 +563,7 @@ Returns the physics layer or layers a body can collide with.
.. _class_Physics2DServer_body_get_continuous_collision_detection_mode:
- :ref:`int<class_int>` **body_get_continuous_collision_detection_mode** **(** :ref:`RID<class_rid>` body **)** const
- :ref:`CCDMode<enum_physics2dserver_ccdmode>` **body_get_continuous_collision_detection_mode** **(** :ref:`RID<class_rid>` body **)** const
Returns the continuous collision detection mode.
@@ -569,7 +581,7 @@ Returns the maximum contacts that can be reported. See :ref:`body_set_max_contac
.. _class_Physics2DServer_body_get_mode:
- :ref:`int<class_int>` **body_get_mode** **(** :ref:`RID<class_rid>` body **)** const
- :ref:`BodyMode<enum_physics2dserver_bodymode>` **body_get_mode** **(** :ref:`RID<class_rid>` body **)** const
Returns the body mode.
@@ -581,7 +593,7 @@ Gets the instance ID of the object the area is assigned to.
.. _class_Physics2DServer_body_get_param:
- :ref:`float<class_float>` **body_get_param** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` param **)** const
- :ref:`float<class_float>` **body_get_param** **(** :ref:`RID<class_rid>` body, :ref:`BodyParameter<enum_physics2dserver_bodyparameter>` param **)** const
Returns the value of a body parameter. A list of available parameters is on the BODY_PARAM\_\* constants.
@@ -617,7 +629,7 @@ Returns the :ref:`RID<class_rid>` of the space assigned to a body.
.. _class_Physics2DServer_body_get_state:
- :ref:`Variant<class_variant>` **body_get_state** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` state **)** const
- :ref:`Variant<class_variant>` **body_get_state** **(** :ref:`RID<class_rid>` body, :ref:`BodyState<enum_physics2dserver_bodystate>` state **)** const
Returns a body state.
@@ -659,7 +671,7 @@ Sets the physics layer or layers a body can collide with.
.. _class_Physics2DServer_body_set_continuous_collision_detection_mode:
- void **body_set_continuous_collision_detection_mode** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mode **)**
- void **body_set_continuous_collision_detection_mode** **(** :ref:`RID<class_rid>` body, :ref:`CCDMode<enum_physics2dserver_ccdmode>` mode **)**
Sets the continuous collision detection mode from any of the CCD_MODE\_\* constants.
@@ -669,7 +681,7 @@ Continuous collision detection tries to predict where a moving body will collide
- void **body_set_force_integration_callback** **(** :ref:`RID<class_rid>` body, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` userdata=null **)**
Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force integration<class_Physics2DServer_body_set_omit_force integration>`).
Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force_integration<class_Physics2DServer_body_set_omit_force_integration>`).
.. _class_Physics2DServer_body_set_max_contacts_reported:
@@ -679,7 +691,7 @@ Sets the maximum contacts to report. Bodies can keep a log of the contacts with
.. _class_Physics2DServer_body_set_mode:
- void **body_set_mode** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mode **)**
- void **body_set_mode** **(** :ref:`RID<class_rid>` body, :ref:`BodyMode<enum_physics2dserver_bodymode>` mode **)**
Sets the body mode, from one of the constants BODY_MODE\*.
@@ -691,7 +703,7 @@ Sets whether a body uses a callback function to calculate its own physics (see :
.. _class_Physics2DServer_body_set_param:
- void **body_set_param** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
- void **body_set_param** **(** :ref:`RID<class_rid>` body, :ref:`BodyParameter<enum_physics2dserver_bodyparameter>` param, :ref:`float<class_float>` value **)**
Sets a body parameter. A list of available parameters is on the BODY_PARAM\_\* constants.
@@ -729,11 +741,11 @@ Sets the transform matrix for a body shape.
- void **body_set_space** **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` space **)**
Assigns a space to the body (see :ref:`create_space<class_Physics2DServer_create_space>`).
Assigns a space to the body (see :ref:`space_create<class_Physics2DServer_space_create>`).
.. _class_Physics2DServer_body_set_state:
- void **body_set_state** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` state, :ref:`Variant<class_variant>` value **)**
- void **body_set_state** **(** :ref:`RID<class_rid>` body, :ref:`BodyState<enum_physics2dserver_bodystate>` state, :ref:`Variant<class_variant>` value **)**
Sets a body state (see BODY_STATE\* constants).
@@ -767,13 +779,13 @@ Creates a damped spring joint between two bodies. If not specified, the second b
.. _class_Physics2DServer_damped_string_joint_get_param:
- :ref:`float<class_float>` **damped_string_joint_get_param** **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param **)** const
- :ref:`float<class_float>` **damped_string_joint_get_param** **(** :ref:`RID<class_rid>` joint, :ref:`DampedStringParam<enum_physics2dserver_dampedstringparam>` param **)** const
Returns the value of a damped spring joint parameter.
.. _class_Physics2DServer_damped_string_joint_set_param:
- void **damped_string_joint_set_param** **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
- void **damped_string_joint_set_param** **(** :ref:`RID<class_rid>` joint, :ref:`DampedStringParam<enum_physics2dserver_dampedstringparam>` param, :ref:`float<class_float>` value **)**
Sets a damped spring joint parameter. Parameters are explained in the DAMPED_STRING\* constants.
@@ -785,7 +797,7 @@ Destroys any of the objects created by Physics2DServer. If the :ref:`RID<class_r
.. _class_Physics2DServer_get_process_info:
- :ref:`int<class_int>` **get_process_info** **(** :ref:`int<class_int>` process_info **)**
- :ref:`int<class_int>` **get_process_info** **(** :ref:`ProcessInfo<enum_physics2dserver_processinfo>` process_info **)**
Returns information about the current state of the 2D physics engine. The states are listed under the INFO\_\* constants.
@@ -797,19 +809,19 @@ Creates a groove joint between two bodies. If not specified, the bodyies are ass
.. _class_Physics2DServer_joint_get_param:
- :ref:`float<class_float>` **joint_get_param** **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param **)** const
- :ref:`float<class_float>` **joint_get_param** **(** :ref:`RID<class_rid>` joint, :ref:`JointParam<enum_physics2dserver_jointparam>` param **)** const
Returns the value of a joint parameter.
.. _class_Physics2DServer_joint_get_type:
- :ref:`int<class_int>` **joint_get_type** **(** :ref:`RID<class_rid>` joint **)** const
- :ref:`JointType<enum_physics2dserver_jointtype>` **joint_get_type** **(** :ref:`RID<class_rid>` joint **)** const
Returns the type of a joint (see JOINT\_\* constants).
.. _class_Physics2DServer_joint_set_param:
- void **joint_set_param** **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
- void **joint_set_param** **(** :ref:`RID<class_rid>` joint, :ref:`JointParam<enum_physics2dserver_jointparam>` param, :ref:`float<class_float>` value **)**
Sets a joint parameter. Parameters are explained in the JOINT_PARAM\* constants.
@@ -849,7 +861,7 @@ Returns the shape data.
.. _class_Physics2DServer_shape_get_type:
- :ref:`int<class_int>` **shape_get_type** **(** :ref:`RID<class_rid>` shape **)** const
- :ref:`ShapeType<enum_physics2dserver_shapetype>` **shape_get_type** **(** :ref:`RID<class_rid>` shape **)** const
Returns the type of shape (see SHAPE\_\* constants).
@@ -873,7 +885,7 @@ Returns the state of a space, a :ref:`Physics2DDirectSpaceState<class_physics2dd
.. _class_Physics2DServer_space_get_param:
- :ref:`float<class_float>` **space_get_param** **(** :ref:`RID<class_rid>` space, :ref:`int<class_int>` param **)** const
- :ref:`float<class_float>` **space_get_param** **(** :ref:`RID<class_rid>` space, :ref:`SpaceParameter<enum_physics2dserver_spaceparameter>` param **)** const
Returns the value of a space parameter.
@@ -891,7 +903,7 @@ Marks a space as active. It will not have an effect, unless it is assigned to an
.. _class_Physics2DServer_space_set_param:
- void **space_set_param** **(** :ref:`RID<class_rid>` space, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
- void **space_set_param** **(** :ref:`RID<class_rid>` space, :ref:`SpaceParameter<enum_physics2dserver_spaceparameter>` param, :ref:`float<class_float>` value **)**
Sets the value for a space parameter. A list of available parameters is on the SPACE_PARAM\_\* constants.

View File

@@ -9,7 +9,7 @@ PhysicsBody
**Inherits:** :ref:`CollisionObject<class_collisionobject>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Inherited By:** :ref:`StaticBody<class_staticbody>`, :ref:`KinematicBody<class_kinematicbody>`, :ref:`RigidBody<class_rigidbody>`
**Inherited By:** :ref:`PhysicalBone<class_physicalbone>`, :ref:`StaticBody<class_staticbody>`, :ref:`KinematicBody<class_kinematicbody>`, :ref:`RigidBody<class_rigidbody>`
**Category:** Core

View File

@@ -21,217 +21,221 @@ Server interface for low level physics access.
Member Functions
----------------
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_add_shape<class_PhysicsServer_area_add_shape>` **(** :ref:`RID<class_rid>` area, :ref:`RID<class_rid>` shape, :ref:`Transform<class_transform>` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_attach_object_instance_id<class_PhysicsServer_area_attach_object_instance_id>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` id **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_clear_shapes<class_PhysicsServer_area_clear_shapes>` **(** :ref:`RID<class_rid>` area **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`area_create<class_PhysicsServer_area_create>` **(** **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`area_get_object_instance_id<class_PhysicsServer_area_get_object_instance_id>` **(** :ref:`RID<class_rid>` area **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`area_get_param<class_PhysicsServer_area_get_param>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` param **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`area_get_shape<class_PhysicsServer_area_get_shape>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`area_get_shape_count<class_PhysicsServer_area_get_shape_count>` **(** :ref:`RID<class_rid>` area **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`area_get_shape_transform<class_PhysicsServer_area_get_shape_transform>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`area_get_space<class_PhysicsServer_area_get_space>` **(** :ref:`RID<class_rid>` area **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`area_get_space_override_mode<class_PhysicsServer_area_get_space_override_mode>` **(** :ref:`RID<class_rid>` area **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`area_get_transform<class_PhysicsServer_area_get_transform>` **(** :ref:`RID<class_rid>` area **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`area_is_ray_pickable<class_PhysicsServer_area_is_ray_pickable>` **(** :ref:`RID<class_rid>` area **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_remove_shape<class_PhysicsServer_area_remove_shape>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_collision_layer<class_PhysicsServer_area_set_collision_layer>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` layer **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_collision_mask<class_PhysicsServer_area_set_collision_mask>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mask **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_monitor_callback<class_PhysicsServer_area_set_monitor_callback>` **(** :ref:`RID<class_rid>` area, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_param<class_PhysicsServer_area_set_param>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` param, :ref:`Variant<class_variant>` value **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_ray_pickable<class_PhysicsServer_area_set_ray_pickable>` **(** :ref:`RID<class_rid>` area, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_shape<class_PhysicsServer_area_set_shape>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx, :ref:`RID<class_rid>` shape **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_shape_transform<class_PhysicsServer_area_set_shape_transform>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx, :ref:`Transform<class_transform>` transform **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_space<class_PhysicsServer_area_set_space>` **(** :ref:`RID<class_rid>` area, :ref:`RID<class_rid>` space **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_space_override_mode<class_PhysicsServer_area_set_space_override_mode>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mode **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_transform<class_PhysicsServer_area_set_transform>` **(** :ref:`RID<class_rid>` area, :ref:`Transform<class_transform>` transform **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_add_collision_exception<class_PhysicsServer_body_add_collision_exception>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` excepted_body **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_add_shape<class_PhysicsServer_body_add_shape>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` shape, :ref:`Transform<class_transform>` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_apply_impulse<class_PhysicsServer_body_apply_impulse>` **(** :ref:`RID<class_rid>` body, :ref:`Vector3<class_vector3>` position, :ref:`Vector3<class_vector3>` impulse **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_apply_torque_impulse<class_PhysicsServer_body_apply_torque_impulse>` **(** :ref:`RID<class_rid>` body, :ref:`Vector3<class_vector3>` impulse **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_attach_object_instance_id<class_PhysicsServer_body_attach_object_instance_id>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` id **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_clear_shapes<class_PhysicsServer_body_clear_shapes>` **(** :ref:`RID<class_rid>` body **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`body_create<class_PhysicsServer_body_create>` **(** :ref:`int<class_int>` mode=2, :ref:`bool<class_bool>` init_sleeping=false **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_collision_layer<class_PhysicsServer_body_get_collision_layer>` **(** :ref:`RID<class_rid>` body **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_collision_mask<class_PhysicsServer_body_get_collision_mask>` **(** :ref:`RID<class_rid>` body **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PhysicsDirectBodyState<class_physicsdirectbodystate>` | :ref:`body_get_direct_state<class_PhysicsServer_body_get_direct_state>` **(** :ref:`RID<class_rid>` body **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`body_get_kinematic_safe_margin<class_PhysicsServer_body_get_kinematic_safe_margin>` **(** :ref:`RID<class_rid>` body **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_max_contacts_reported<class_PhysicsServer_body_get_max_contacts_reported>` **(** :ref:`RID<class_rid>` body **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_mode<class_PhysicsServer_body_get_mode>` **(** :ref:`RID<class_rid>` body **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_object_instance_id<class_PhysicsServer_body_get_object_instance_id>` **(** :ref:`RID<class_rid>` body **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`body_get_param<class_PhysicsServer_body_get_param>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` param **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`body_get_shape<class_PhysicsServer_body_get_shape>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_shape_count<class_PhysicsServer_body_get_shape_count>` **(** :ref:`RID<class_rid>` body **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`body_get_shape_transform<class_PhysicsServer_body_get_shape_transform>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`body_get_space<class_PhysicsServer_body_get_space>` **(** :ref:`RID<class_rid>` body **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`body_get_state<class_PhysicsServer_body_get_state>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` state **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`body_is_axis_locked<class_PhysicsServer_body_is_axis_locked>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` axis **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`body_is_continuous_collision_detection_enabled<class_PhysicsServer_body_is_continuous_collision_detection_enabled>` **(** :ref:`RID<class_rid>` body **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`body_is_omitting_force_integration<class_PhysicsServer_body_is_omitting_force_integration>` **(** :ref:`RID<class_rid>` body **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`body_is_ray_pickable<class_PhysicsServer_body_is_ray_pickable>` **(** :ref:`RID<class_rid>` body **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_remove_collision_exception<class_PhysicsServer_body_remove_collision_exception>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` excepted_body **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_remove_shape<class_PhysicsServer_body_remove_shape>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_axis_lock<class_PhysicsServer_body_set_axis_lock>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` axis, :ref:`bool<class_bool>` lock **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_axis_velocity<class_PhysicsServer_body_set_axis_velocity>` **(** :ref:`RID<class_rid>` body, :ref:`Vector3<class_vector3>` axis_velocity **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_collision_layer<class_PhysicsServer_body_set_collision_layer>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` layer **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_collision_mask<class_PhysicsServer_body_set_collision_mask>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mask **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_enable_continuous_collision_detection<class_PhysicsServer_body_set_enable_continuous_collision_detection>` **(** :ref:`RID<class_rid>` body, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_force_integration_callback<class_PhysicsServer_body_set_force_integration_callback>` **(** :ref:`RID<class_rid>` body, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` userdata=null **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_kinematic_safe_margin<class_PhysicsServer_body_set_kinematic_safe_margin>` **(** :ref:`RID<class_rid>` body, :ref:`float<class_float>` margin **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_max_contacts_reported<class_PhysicsServer_body_set_max_contacts_reported>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` amount **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_mode<class_PhysicsServer_body_set_mode>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mode **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_omit_force_integration<class_PhysicsServer_body_set_omit_force_integration>` **(** :ref:`RID<class_rid>` body, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_param<class_PhysicsServer_body_set_param>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_ray_pickable<class_PhysicsServer_body_set_ray_pickable>` **(** :ref:`RID<class_rid>` body, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_shape<class_PhysicsServer_body_set_shape>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx, :ref:`RID<class_rid>` shape **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_shape_transform<class_PhysicsServer_body_set_shape_transform>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx, :ref:`Transform<class_transform>` transform **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_space<class_PhysicsServer_body_set_space>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` space **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_state<class_PhysicsServer_body_set_state>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` state, :ref:`Variant<class_variant>` value **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`cone_twist_joint_get_param<class_PhysicsServer_cone_twist_joint_get_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`cone_twist_joint_set_param<class_PhysicsServer_cone_twist_joint_set_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`free_rid<class_PhysicsServer_free_rid>` **(** :ref:`RID<class_rid>` rid **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`generic_6dof_joint_get_flag<class_PhysicsServer_generic_6dof_joint_get_flag>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` axis, :ref:`int<class_int>` flag **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`generic_6dof_joint_get_param<class_PhysicsServer_generic_6dof_joint_get_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` axis, :ref:`int<class_int>` param **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`generic_6dof_joint_set_flag<class_PhysicsServer_generic_6dof_joint_set_flag>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` axis, :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`generic_6dof_joint_set_param<class_PhysicsServer_generic_6dof_joint_set_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` axis, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_process_info<class_PhysicsServer_get_process_info>` **(** :ref:`int<class_int>` process_info **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`hinge_joint_get_flag<class_PhysicsServer_hinge_joint_get_flag>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` flag **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`hinge_joint_get_param<class_PhysicsServer_hinge_joint_get_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`hinge_joint_set_flag<class_PhysicsServer_hinge_joint_set_flag>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`hinge_joint_set_param<class_PhysicsServer_hinge_joint_set_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`joint_create_cone_twist<class_PhysicsServer_joint_create_cone_twist>` **(** :ref:`RID<class_rid>` body_A, :ref:`Transform<class_transform>` local_ref_A, :ref:`RID<class_rid>` body_B, :ref:`Transform<class_transform>` local_ref_B **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`joint_create_generic_6dof<class_PhysicsServer_joint_create_generic_6dof>` **(** :ref:`RID<class_rid>` body_A, :ref:`Transform<class_transform>` local_ref_A, :ref:`RID<class_rid>` body_B, :ref:`Transform<class_transform>` local_ref_B **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`joint_create_hinge<class_PhysicsServer_joint_create_hinge>` **(** :ref:`RID<class_rid>` body_A, :ref:`Transform<class_transform>` hinge_A, :ref:`RID<class_rid>` body_B, :ref:`Transform<class_transform>` hinge_B **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`joint_create_pin<class_PhysicsServer_joint_create_pin>` **(** :ref:`RID<class_rid>` body_A, :ref:`Vector3<class_vector3>` local_A, :ref:`RID<class_rid>` body_B, :ref:`Vector3<class_vector3>` local_B **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`joint_create_slider<class_PhysicsServer_joint_create_slider>` **(** :ref:`RID<class_rid>` body_A, :ref:`Transform<class_transform>` local_ref_A, :ref:`RID<class_rid>` body_B, :ref:`Transform<class_transform>` local_ref_B **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`joint_get_solver_priority<class_PhysicsServer_joint_get_solver_priority>` **(** :ref:`RID<class_rid>` joint **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`joint_get_type<class_PhysicsServer_joint_get_type>` **(** :ref:`RID<class_rid>` joint **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`joint_set_solver_priority<class_PhysicsServer_joint_set_solver_priority>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` priority **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`pin_joint_get_local_a<class_PhysicsServer_pin_joint_get_local_a>` **(** :ref:`RID<class_rid>` joint **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`pin_joint_get_local_b<class_PhysicsServer_pin_joint_get_local_b>` **(** :ref:`RID<class_rid>` joint **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`pin_joint_get_param<class_PhysicsServer_pin_joint_get_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`pin_joint_set_local_a<class_PhysicsServer_pin_joint_set_local_a>` **(** :ref:`RID<class_rid>` joint, :ref:`Vector3<class_vector3>` local_A **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`pin_joint_set_local_b<class_PhysicsServer_pin_joint_set_local_b>` **(** :ref:`RID<class_rid>` joint, :ref:`Vector3<class_vector3>` local_B **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`pin_joint_set_param<class_PhysicsServer_pin_joint_set_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_active<class_PhysicsServer_set_active>` **(** :ref:`bool<class_bool>` active **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`shape_create<class_PhysicsServer_shape_create>` **(** :ref:`int<class_int>` type **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`shape_get_data<class_PhysicsServer_shape_get_data>` **(** :ref:`RID<class_rid>` shape **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`shape_get_type<class_PhysicsServer_shape_get_type>` **(** :ref:`RID<class_rid>` shape **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`shape_set_data<class_PhysicsServer_shape_set_data>` **(** :ref:`RID<class_rid>` shape, :ref:`Variant<class_variant>` data **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`slider_joint_get_param<class_PhysicsServer_slider_joint_get_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`slider_joint_set_param<class_PhysicsServer_slider_joint_set_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`space_create<class_PhysicsServer_space_create>` **(** **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>` | :ref:`space_get_direct_state<class_PhysicsServer_space_get_direct_state>` **(** :ref:`RID<class_rid>` space **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`space_get_param<class_PhysicsServer_space_get_param>` **(** :ref:`RID<class_rid>` space, :ref:`int<class_int>` param **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`space_is_active<class_PhysicsServer_space_is_active>` **(** :ref:`RID<class_rid>` space **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`space_set_active<class_PhysicsServer_space_set_active>` **(** :ref:`RID<class_rid>` space, :ref:`bool<class_bool>` active **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`space_set_param<class_PhysicsServer_space_set_param>` **(** :ref:`RID<class_rid>` space, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_add_shape<class_PhysicsServer_area_add_shape>` **(** :ref:`RID<class_rid>` area, :ref:`RID<class_rid>` shape, :ref:`Transform<class_transform>` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_attach_object_instance_id<class_PhysicsServer_area_attach_object_instance_id>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` id **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_clear_shapes<class_PhysicsServer_area_clear_shapes>` **(** :ref:`RID<class_rid>` area **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`area_create<class_PhysicsServer_area_create>` **(** **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`area_get_object_instance_id<class_PhysicsServer_area_get_object_instance_id>` **(** :ref:`RID<class_rid>` area **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`area_get_param<class_PhysicsServer_area_get_param>` **(** :ref:`RID<class_rid>` area, :ref:`AreaParameter<enum_physicsserver_areaparameter>` param **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`area_get_shape<class_PhysicsServer_area_get_shape>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`area_get_shape_count<class_PhysicsServer_area_get_shape_count>` **(** :ref:`RID<class_rid>` area **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`area_get_shape_transform<class_PhysicsServer_area_get_shape_transform>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`area_get_space<class_PhysicsServer_area_get_space>` **(** :ref:`RID<class_rid>` area **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AreaSpaceOverrideMode<enum_physicsserver_areaspaceoverridemode>` | :ref:`area_get_space_override_mode<class_PhysicsServer_area_get_space_override_mode>` **(** :ref:`RID<class_rid>` area **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`area_get_transform<class_PhysicsServer_area_get_transform>` **(** :ref:`RID<class_rid>` area **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`area_is_ray_pickable<class_PhysicsServer_area_is_ray_pickable>` **(** :ref:`RID<class_rid>` area **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_remove_shape<class_PhysicsServer_area_remove_shape>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_area_monitor_callback<class_PhysicsServer_area_set_area_monitor_callback>` **(** :ref:`RID<class_rid>` area, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_collision_layer<class_PhysicsServer_area_set_collision_layer>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` layer **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_collision_mask<class_PhysicsServer_area_set_collision_mask>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mask **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_monitor_callback<class_PhysicsServer_area_set_monitor_callback>` **(** :ref:`RID<class_rid>` area, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_monitorable<class_PhysicsServer_area_set_monitorable>` **(** :ref:`RID<class_rid>` area, :ref:`bool<class_bool>` monitorable **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_param<class_PhysicsServer_area_set_param>` **(** :ref:`RID<class_rid>` area, :ref:`AreaParameter<enum_physicsserver_areaparameter>` param, :ref:`Variant<class_variant>` value **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_ray_pickable<class_PhysicsServer_area_set_ray_pickable>` **(** :ref:`RID<class_rid>` area, :ref:`bool<class_bool>` enable **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_shape<class_PhysicsServer_area_set_shape>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx, :ref:`RID<class_rid>` shape **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_shape_transform<class_PhysicsServer_area_set_shape_transform>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx, :ref:`Transform<class_transform>` transform **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_space<class_PhysicsServer_area_set_space>` **(** :ref:`RID<class_rid>` area, :ref:`RID<class_rid>` space **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_space_override_mode<class_PhysicsServer_area_set_space_override_mode>` **(** :ref:`RID<class_rid>` area, :ref:`AreaSpaceOverrideMode<enum_physicsserver_areaspaceoverridemode>` mode **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_transform<class_PhysicsServer_area_set_transform>` **(** :ref:`RID<class_rid>` area, :ref:`Transform<class_transform>` transform **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_add_collision_exception<class_PhysicsServer_body_add_collision_exception>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` excepted_body **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_add_shape<class_PhysicsServer_body_add_shape>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` shape, :ref:`Transform<class_transform>` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_apply_impulse<class_PhysicsServer_body_apply_impulse>` **(** :ref:`RID<class_rid>` body, :ref:`Vector3<class_vector3>` position, :ref:`Vector3<class_vector3>` impulse **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_apply_torque_impulse<class_PhysicsServer_body_apply_torque_impulse>` **(** :ref:`RID<class_rid>` body, :ref:`Vector3<class_vector3>` impulse **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_attach_object_instance_id<class_PhysicsServer_body_attach_object_instance_id>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` id **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_clear_shapes<class_PhysicsServer_body_clear_shapes>` **(** :ref:`RID<class_rid>` body **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`body_create<class_PhysicsServer_body_create>` **(** :ref:`BodyMode<enum_physicsserver_bodymode>` mode=2, :ref:`bool<class_bool>` init_sleeping=false **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_collision_layer<class_PhysicsServer_body_get_collision_layer>` **(** :ref:`RID<class_rid>` body **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_collision_mask<class_PhysicsServer_body_get_collision_mask>` **(** :ref:`RID<class_rid>` body **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PhysicsDirectBodyState<class_physicsdirectbodystate>` | :ref:`body_get_direct_state<class_PhysicsServer_body_get_direct_state>` **(** :ref:`RID<class_rid>` body **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`body_get_kinematic_safe_margin<class_PhysicsServer_body_get_kinematic_safe_margin>` **(** :ref:`RID<class_rid>` body **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_max_contacts_reported<class_PhysicsServer_body_get_max_contacts_reported>` **(** :ref:`RID<class_rid>` body **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BodyMode<enum_physicsserver_bodymode>` | :ref:`body_get_mode<class_PhysicsServer_body_get_mode>` **(** :ref:`RID<class_rid>` body **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_object_instance_id<class_PhysicsServer_body_get_object_instance_id>` **(** :ref:`RID<class_rid>` body **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`body_get_param<class_PhysicsServer_body_get_param>` **(** :ref:`RID<class_rid>` body, :ref:`BodyParameter<enum_physicsserver_bodyparameter>` param **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`body_get_shape<class_PhysicsServer_body_get_shape>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_shape_count<class_PhysicsServer_body_get_shape_count>` **(** :ref:`RID<class_rid>` body **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`body_get_shape_transform<class_PhysicsServer_body_get_shape_transform>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`body_get_space<class_PhysicsServer_body_get_space>` **(** :ref:`RID<class_rid>` body **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`body_get_state<class_PhysicsServer_body_get_state>` **(** :ref:`RID<class_rid>` body, :ref:`BodyState<enum_physicsserver_bodystate>` state **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`body_is_axis_locked<class_PhysicsServer_body_is_axis_locked>` **(** :ref:`RID<class_rid>` body, :ref:`BodyAxis<enum_physicsserver_bodyaxis>` axis **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`body_is_continuous_collision_detection_enabled<class_PhysicsServer_body_is_continuous_collision_detection_enabled>` **(** :ref:`RID<class_rid>` body **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`body_is_omitting_force_integration<class_PhysicsServer_body_is_omitting_force_integration>` **(** :ref:`RID<class_rid>` body **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`body_is_ray_pickable<class_PhysicsServer_body_is_ray_pickable>` **(** :ref:`RID<class_rid>` body **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_remove_collision_exception<class_PhysicsServer_body_remove_collision_exception>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` excepted_body **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_remove_shape<class_PhysicsServer_body_remove_shape>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_axis_lock<class_PhysicsServer_body_set_axis_lock>` **(** :ref:`RID<class_rid>` body, :ref:`BodyAxis<enum_physicsserver_bodyaxis>` axis, :ref:`bool<class_bool>` lock **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_axis_velocity<class_PhysicsServer_body_set_axis_velocity>` **(** :ref:`RID<class_rid>` body, :ref:`Vector3<class_vector3>` axis_velocity **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_collision_layer<class_PhysicsServer_body_set_collision_layer>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` layer **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_collision_mask<class_PhysicsServer_body_set_collision_mask>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mask **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_enable_continuous_collision_detection<class_PhysicsServer_body_set_enable_continuous_collision_detection>` **(** :ref:`RID<class_rid>` body, :ref:`bool<class_bool>` enable **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_force_integration_callback<class_PhysicsServer_body_set_force_integration_callback>` **(** :ref:`RID<class_rid>` body, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` userdata=null **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_kinematic_safe_margin<class_PhysicsServer_body_set_kinematic_safe_margin>` **(** :ref:`RID<class_rid>` body, :ref:`float<class_float>` margin **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_max_contacts_reported<class_PhysicsServer_body_set_max_contacts_reported>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` amount **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_mode<class_PhysicsServer_body_set_mode>` **(** :ref:`RID<class_rid>` body, :ref:`BodyMode<enum_physicsserver_bodymode>` mode **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_omit_force_integration<class_PhysicsServer_body_set_omit_force_integration>` **(** :ref:`RID<class_rid>` body, :ref:`bool<class_bool>` enable **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_param<class_PhysicsServer_body_set_param>` **(** :ref:`RID<class_rid>` body, :ref:`BodyParameter<enum_physicsserver_bodyparameter>` param, :ref:`float<class_float>` value **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_ray_pickable<class_PhysicsServer_body_set_ray_pickable>` **(** :ref:`RID<class_rid>` body, :ref:`bool<class_bool>` enable **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_shape<class_PhysicsServer_body_set_shape>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx, :ref:`RID<class_rid>` shape **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_shape_transform<class_PhysicsServer_body_set_shape_transform>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx, :ref:`Transform<class_transform>` transform **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_space<class_PhysicsServer_body_set_space>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` space **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_state<class_PhysicsServer_body_set_state>` **(** :ref:`RID<class_rid>` body, :ref:`BodyState<enum_physicsserver_bodystate>` state, :ref:`Variant<class_variant>` value **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`cone_twist_joint_get_param<class_PhysicsServer_cone_twist_joint_get_param>` **(** :ref:`RID<class_rid>` joint, :ref:`ConeTwistJointParam<enum_physicsserver_conetwistjointparam>` param **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`cone_twist_joint_set_param<class_PhysicsServer_cone_twist_joint_set_param>` **(** :ref:`RID<class_rid>` joint, :ref:`ConeTwistJointParam<enum_physicsserver_conetwistjointparam>` param, :ref:`float<class_float>` value **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`free_rid<class_PhysicsServer_free_rid>` **(** :ref:`RID<class_rid>` rid **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`generic_6dof_joint_get_flag<class_PhysicsServer_generic_6dof_joint_get_flag>` **(** :ref:`RID<class_rid>` joint, :ref:`Axis<enum_vector3_axis>` axis, :ref:`G6DOFJointAxisFlag<enum_physicsserver_g6dofjointaxisflag>` flag **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`generic_6dof_joint_get_param<class_PhysicsServer_generic_6dof_joint_get_param>` **(** :ref:`RID<class_rid>` joint, :ref:`Axis<enum_vector3_axis>` axis, :ref:`G6DOFJointAxisParam<enum_physicsserver_g6dofjointaxisparam>` param **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`generic_6dof_joint_set_flag<class_PhysicsServer_generic_6dof_joint_set_flag>` **(** :ref:`RID<class_rid>` joint, :ref:`Axis<enum_vector3_axis>` axis, :ref:`G6DOFJointAxisFlag<enum_physicsserver_g6dofjointaxisflag>` flag, :ref:`bool<class_bool>` enable **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`generic_6dof_joint_set_param<class_PhysicsServer_generic_6dof_joint_set_param>` **(** :ref:`RID<class_rid>` joint, :ref:`Axis<enum_vector3_axis>` axis, :ref:`G6DOFJointAxisParam<enum_physicsserver_g6dofjointaxisparam>` param, :ref:`float<class_float>` value **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_process_info<class_PhysicsServer_get_process_info>` **(** :ref:`ProcessInfo<enum_physicsserver_processinfo>` process_info **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`hinge_joint_get_flag<class_PhysicsServer_hinge_joint_get_flag>` **(** :ref:`RID<class_rid>` joint, :ref:`HingeJointFlag<enum_physicsserver_hingejointflag>` flag **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`hinge_joint_get_param<class_PhysicsServer_hinge_joint_get_param>` **(** :ref:`RID<class_rid>` joint, :ref:`HingeJointParam<enum_physicsserver_hingejointparam>` param **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`hinge_joint_set_flag<class_PhysicsServer_hinge_joint_set_flag>` **(** :ref:`RID<class_rid>` joint, :ref:`HingeJointFlag<enum_physicsserver_hingejointflag>` flag, :ref:`bool<class_bool>` enabled **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`hinge_joint_set_param<class_PhysicsServer_hinge_joint_set_param>` **(** :ref:`RID<class_rid>` joint, :ref:`HingeJointParam<enum_physicsserver_hingejointparam>` param, :ref:`float<class_float>` value **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`joint_create_cone_twist<class_PhysicsServer_joint_create_cone_twist>` **(** :ref:`RID<class_rid>` body_A, :ref:`Transform<class_transform>` local_ref_A, :ref:`RID<class_rid>` body_B, :ref:`Transform<class_transform>` local_ref_B **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`joint_create_generic_6dof<class_PhysicsServer_joint_create_generic_6dof>` **(** :ref:`RID<class_rid>` body_A, :ref:`Transform<class_transform>` local_ref_A, :ref:`RID<class_rid>` body_B, :ref:`Transform<class_transform>` local_ref_B **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`joint_create_hinge<class_PhysicsServer_joint_create_hinge>` **(** :ref:`RID<class_rid>` body_A, :ref:`Transform<class_transform>` hinge_A, :ref:`RID<class_rid>` body_B, :ref:`Transform<class_transform>` hinge_B **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`joint_create_pin<class_PhysicsServer_joint_create_pin>` **(** :ref:`RID<class_rid>` body_A, :ref:`Vector3<class_vector3>` local_A, :ref:`RID<class_rid>` body_B, :ref:`Vector3<class_vector3>` local_B **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`joint_create_slider<class_PhysicsServer_joint_create_slider>` **(** :ref:`RID<class_rid>` body_A, :ref:`Transform<class_transform>` local_ref_A, :ref:`RID<class_rid>` body_B, :ref:`Transform<class_transform>` local_ref_B **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`joint_get_solver_priority<class_PhysicsServer_joint_get_solver_priority>` **(** :ref:`RID<class_rid>` joint **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`JointType<enum_physicsserver_jointtype>` | :ref:`joint_get_type<class_PhysicsServer_joint_get_type>` **(** :ref:`RID<class_rid>` joint **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`joint_set_solver_priority<class_PhysicsServer_joint_set_solver_priority>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` priority **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`pin_joint_get_local_a<class_PhysicsServer_pin_joint_get_local_a>` **(** :ref:`RID<class_rid>` joint **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`pin_joint_get_local_b<class_PhysicsServer_pin_joint_get_local_b>` **(** :ref:`RID<class_rid>` joint **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`pin_joint_get_param<class_PhysicsServer_pin_joint_get_param>` **(** :ref:`RID<class_rid>` joint, :ref:`PinJointParam<enum_physicsserver_pinjointparam>` param **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`pin_joint_set_local_a<class_PhysicsServer_pin_joint_set_local_a>` **(** :ref:`RID<class_rid>` joint, :ref:`Vector3<class_vector3>` local_A **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`pin_joint_set_local_b<class_PhysicsServer_pin_joint_set_local_b>` **(** :ref:`RID<class_rid>` joint, :ref:`Vector3<class_vector3>` local_B **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`pin_joint_set_param<class_PhysicsServer_pin_joint_set_param>` **(** :ref:`RID<class_rid>` joint, :ref:`PinJointParam<enum_physicsserver_pinjointparam>` param, :ref:`float<class_float>` value **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_active<class_PhysicsServer_set_active>` **(** :ref:`bool<class_bool>` active **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`shape_create<class_PhysicsServer_shape_create>` **(** :ref:`ShapeType<enum_physicsserver_shapetype>` type **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`shape_get_data<class_PhysicsServer_shape_get_data>` **(** :ref:`RID<class_rid>` shape **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ShapeType<enum_physicsserver_shapetype>` | :ref:`shape_get_type<class_PhysicsServer_shape_get_type>` **(** :ref:`RID<class_rid>` shape **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`shape_set_data<class_PhysicsServer_shape_set_data>` **(** :ref:`RID<class_rid>` shape, :ref:`Variant<class_variant>` data **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`slider_joint_get_param<class_PhysicsServer_slider_joint_get_param>` **(** :ref:`RID<class_rid>` joint, :ref:`SliderJointParam<enum_physicsserver_sliderjointparam>` param **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`slider_joint_set_param<class_PhysicsServer_slider_joint_set_param>` **(** :ref:`RID<class_rid>` joint, :ref:`SliderJointParam<enum_physicsserver_sliderjointparam>` param, :ref:`float<class_float>` value **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`space_create<class_PhysicsServer_space_create>` **(** **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>` | :ref:`space_get_direct_state<class_PhysicsServer_space_get_direct_state>` **(** :ref:`RID<class_rid>` space **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`space_get_param<class_PhysicsServer_space_get_param>` **(** :ref:`RID<class_rid>` space, :ref:`SpaceParameter<enum_physicsserver_spaceparameter>` param **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`space_is_active<class_PhysicsServer_space_is_active>` **(** :ref:`RID<class_rid>` space **)** const |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`space_set_active<class_PhysicsServer_space_set_active>` **(** :ref:`RID<class_rid>` space, :ref:`bool<class_bool>` active **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`space_set_param<class_PhysicsServer_space_set_param>` **(** :ref:`RID<class_rid>` space, :ref:`SpaceParameter<enum_physicsserver_spaceparameter>` param, :ref:`float<class_float>` value **)** |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Enums
-----
@@ -505,7 +509,7 @@ Gets the instance ID of the object the area is assigned to.
.. _class_PhysicsServer_area_get_param:
- :ref:`Variant<class_variant>` **area_get_param** **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` param **)** const
- :ref:`Variant<class_variant>` **area_get_param** **(** :ref:`RID<class_rid>` area, :ref:`AreaParameter<enum_physicsserver_areaparameter>` param **)** const
Returns an area parameter value. A list of available parameters is on the AREA_PARAM\_\* constants.
@@ -535,7 +539,7 @@ Returns the space assigned to the area.
.. _class_PhysicsServer_area_get_space_override_mode:
- :ref:`int<class_int>` **area_get_space_override_mode** **(** :ref:`RID<class_rid>` area **)** const
- :ref:`AreaSpaceOverrideMode<enum_physicsserver_areaspaceoverridemode>` **area_get_space_override_mode** **(** :ref:`RID<class_rid>` area **)** const
Returns the space override mode for the area.
@@ -557,6 +561,10 @@ If ``true`` area collides with rays.
Removes a shape from an area. It does not delete the shape, so it can be reassigned later.
.. _class_PhysicsServer_area_set_area_monitor_callback:
- void **area_set_area_monitor_callback** **(** :ref:`RID<class_rid>` area, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method **)**
.. _class_PhysicsServer_area_set_collision_layer:
- void **area_set_collision_layer** **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` layer **)**
@@ -585,9 +593,13 @@ Sets the function to call when any body/area enters or exits the area. This call
5: The shape index of the area where the object entered/exited.
.. _class_PhysicsServer_area_set_monitorable:
- void **area_set_monitorable** **(** :ref:`RID<class_rid>` area, :ref:`bool<class_bool>` monitorable **)**
.. _class_PhysicsServer_area_set_param:
- void **area_set_param** **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` param, :ref:`Variant<class_variant>` value **)**
- void **area_set_param** **(** :ref:`RID<class_rid>` area, :ref:`AreaParameter<enum_physicsserver_areaparameter>` param, :ref:`Variant<class_variant>` value **)**
Sets the value for an area parameter. A list of available parameters is on the AREA_PARAM\_\* constants.
@@ -617,7 +629,7 @@ Assigns a space to the area.
.. _class_PhysicsServer_area_set_space_override_mode:
- void **area_set_space_override_mode** **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mode **)**
- void **area_set_space_override_mode** **(** :ref:`RID<class_rid>` area, :ref:`AreaSpaceOverrideMode<enum_physicsserver_areaspaceoverridemode>` mode **)**
Sets the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE\_\*.
@@ -665,7 +677,7 @@ Removes all shapes from a body.
.. _class_PhysicsServer_body_create:
- :ref:`RID<class_rid>` **body_create** **(** :ref:`int<class_int>` mode=2, :ref:`bool<class_bool>` init_sleeping=false **)**
- :ref:`RID<class_rid>` **body_create** **(** :ref:`BodyMode<enum_physicsserver_bodymode>` mode=2, :ref:`bool<class_bool>` init_sleeping=false **)**
Creates a physics body. The first parameter can be any value from constants BODY_MODE\*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time.
@@ -701,7 +713,7 @@ Returns the maximum contacts that can be reported. See :ref:`body_set_max_contac
.. _class_PhysicsServer_body_get_mode:
- :ref:`int<class_int>` **body_get_mode** **(** :ref:`RID<class_rid>` body **)** const
- :ref:`BodyMode<enum_physicsserver_bodymode>` **body_get_mode** **(** :ref:`RID<class_rid>` body **)** const
Returns the body mode.
@@ -713,7 +725,7 @@ Gets the instance ID of the object the area is assigned to.
.. _class_PhysicsServer_body_get_param:
- :ref:`float<class_float>` **body_get_param** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` param **)** const
- :ref:`float<class_float>` **body_get_param** **(** :ref:`RID<class_rid>` body, :ref:`BodyParameter<enum_physicsserver_bodyparameter>` param **)** const
Returns the value of a body parameter. A list of available parameters is on the BODY_PARAM\_\* constants.
@@ -743,13 +755,13 @@ Returns the :ref:`RID<class_rid>` of the space assigned to a body.
.. _class_PhysicsServer_body_get_state:
- :ref:`Variant<class_variant>` **body_get_state** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` state **)** const
- :ref:`Variant<class_variant>` **body_get_state** **(** :ref:`RID<class_rid>` body, :ref:`BodyState<enum_physicsserver_bodystate>` state **)** const
Returns a body state.
.. _class_PhysicsServer_body_is_axis_locked:
- :ref:`bool<class_bool>` **body_is_axis_locked** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` axis **)** const
- :ref:`bool<class_bool>` **body_is_axis_locked** **(** :ref:`RID<class_rid>` body, :ref:`BodyAxis<enum_physicsserver_bodyaxis>` axis **)** const
.. _class_PhysicsServer_body_is_continuous_collision_detection_enabled:
@@ -785,7 +797,7 @@ Removes a shape from a body. The shape is not deleted, so it can be reused after
.. _class_PhysicsServer_body_set_axis_lock:
- void **body_set_axis_lock** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` axis, :ref:`bool<class_bool>` lock **)**
- void **body_set_axis_lock** **(** :ref:`RID<class_rid>` body, :ref:`BodyAxis<enum_physicsserver_bodyaxis>` axis, :ref:`bool<class_bool>` lock **)**
.. _class_PhysicsServer_body_set_axis_velocity:
@@ -817,7 +829,7 @@ Continuous collision detection tries to predict where a moving body will collide
- void **body_set_force_integration_callback** **(** :ref:`RID<class_rid>` body, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` userdata=null **)**
Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force integration<class_PhysicsServer_body_set_omit_force integration>`).
Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force_integration<class_PhysicsServer_body_set_omit_force_integration>`).
.. _class_PhysicsServer_body_set_kinematic_safe_margin:
@@ -831,7 +843,7 @@ Sets the maximum contacts to report. Bodies can keep a log of the contacts with
.. _class_PhysicsServer_body_set_mode:
- void **body_set_mode** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mode **)**
- void **body_set_mode** **(** :ref:`RID<class_rid>` body, :ref:`BodyMode<enum_physicsserver_bodymode>` mode **)**
Sets the body mode, from one of the constants BODY_MODE\*.
@@ -843,7 +855,7 @@ Sets whether a body uses a callback function to calculate its own physics (see :
.. _class_PhysicsServer_body_set_param:
- void **body_set_param** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
- void **body_set_param** **(** :ref:`RID<class_rid>` body, :ref:`BodyParameter<enum_physicsserver_bodyparameter>` param, :ref:`float<class_float>` value **)**
Sets a body parameter. A list of available parameters is on the BODY_PARAM\_\* constants.
@@ -873,19 +885,19 @@ Assigns a space to the body (see :ref:`create_space<class_PhysicsServer_create_s
.. _class_PhysicsServer_body_set_state:
- void **body_set_state** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` state, :ref:`Variant<class_variant>` value **)**
- void **body_set_state** **(** :ref:`RID<class_rid>` body, :ref:`BodyState<enum_physicsserver_bodystate>` state, :ref:`Variant<class_variant>` value **)**
Sets a body state (see BODY_STATE\* constants).
.. _class_PhysicsServer_cone_twist_joint_get_param:
- :ref:`float<class_float>` **cone_twist_joint_get_param** **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param **)** const
- :ref:`float<class_float>` **cone_twist_joint_get_param** **(** :ref:`RID<class_rid>` joint, :ref:`ConeTwistJointParam<enum_physicsserver_conetwistjointparam>` param **)** const
Gets a cone_twist_joint parameter (see CONE_TWIST_JOINT\* constants).
.. _class_PhysicsServer_cone_twist_joint_set_param:
- void **cone_twist_joint_set_param** **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
- void **cone_twist_joint_set_param** **(** :ref:`RID<class_rid>` joint, :ref:`ConeTwistJointParam<enum_physicsserver_conetwistjointparam>` param, :ref:`float<class_float>` value **)**
Sets a cone_twist_joint parameter (see CONE_TWIST_JOINT\* constants).
@@ -897,55 +909,55 @@ Destroys any of the objects created by PhysicsServer. If the :ref:`RID<class_rid
.. _class_PhysicsServer_generic_6dof_joint_get_flag:
- :ref:`bool<class_bool>` **generic_6dof_joint_get_flag** **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` axis, :ref:`int<class_int>` flag **)**
- :ref:`bool<class_bool>` **generic_6dof_joint_get_flag** **(** :ref:`RID<class_rid>` joint, :ref:`Axis<enum_vector3_axis>` axis, :ref:`G6DOFJointAxisFlag<enum_physicsserver_g6dofjointaxisflag>` flag **)**
Gets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG\* constants).
.. _class_PhysicsServer_generic_6dof_joint_get_param:
- :ref:`float<class_float>` **generic_6dof_joint_get_param** **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` axis, :ref:`int<class_int>` param **)**
- :ref:`float<class_float>` **generic_6dof_joint_get_param** **(** :ref:`RID<class_rid>` joint, :ref:`Axis<enum_vector3_axis>` axis, :ref:`G6DOFJointAxisParam<enum_physicsserver_g6dofjointaxisparam>` param **)**
Gets a generic_6_DOF_joint parameter (see G6DOF_JOINT\* constants without the G6DOF_JOINT_FLAG\*).
.. _class_PhysicsServer_generic_6dof_joint_set_flag:
- void **generic_6dof_joint_set_flag** **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` axis, :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enable **)**
- void **generic_6dof_joint_set_flag** **(** :ref:`RID<class_rid>` joint, :ref:`Axis<enum_vector3_axis>` axis, :ref:`G6DOFJointAxisFlag<enum_physicsserver_g6dofjointaxisflag>` flag, :ref:`bool<class_bool>` enable **)**
Sets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG\* constants).
.. _class_PhysicsServer_generic_6dof_joint_set_param:
- void **generic_6dof_joint_set_param** **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` axis, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
- void **generic_6dof_joint_set_param** **(** :ref:`RID<class_rid>` joint, :ref:`Axis<enum_vector3_axis>` axis, :ref:`G6DOFJointAxisParam<enum_physicsserver_g6dofjointaxisparam>` param, :ref:`float<class_float>` value **)**
Sets a generic_6_DOF_joint parameter (see G6DOF_JOINT\* constants without the G6DOF_JOINT_FLAG\*).
.. _class_PhysicsServer_get_process_info:
- :ref:`int<class_int>` **get_process_info** **(** :ref:`int<class_int>` process_info **)**
- :ref:`int<class_int>` **get_process_info** **(** :ref:`ProcessInfo<enum_physicsserver_processinfo>` process_info **)**
Returns an Info defined by the ProcessInfo input given.
.. _class_PhysicsServer_hinge_joint_get_flag:
- :ref:`bool<class_bool>` **hinge_joint_get_flag** **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` flag **)** const
- :ref:`bool<class_bool>` **hinge_joint_get_flag** **(** :ref:`RID<class_rid>` joint, :ref:`HingeJointFlag<enum_physicsserver_hingejointflag>` flag **)** const
Gets a hinge_joint flag (see HINGE_JOINT_FLAG\* constants).
.. _class_PhysicsServer_hinge_joint_get_param:
- :ref:`float<class_float>` **hinge_joint_get_param** **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param **)** const
- :ref:`float<class_float>` **hinge_joint_get_param** **(** :ref:`RID<class_rid>` joint, :ref:`HingeJointParam<enum_physicsserver_hingejointparam>` param **)** const
Gets a hinge_joint parameter (see HINGE_JOINT\* constants without the HINGE_JOINT_FLAG\*).
.. _class_PhysicsServer_hinge_joint_set_flag:
- void **hinge_joint_set_flag** **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enabled **)**
- void **hinge_joint_set_flag** **(** :ref:`RID<class_rid>` joint, :ref:`HingeJointFlag<enum_physicsserver_hingejointflag>` flag, :ref:`bool<class_bool>` enabled **)**
Sets a hinge_joint flag (see HINGE_JOINT_FLAG\* constants).
.. _class_PhysicsServer_hinge_joint_set_param:
- void **hinge_joint_set_param** **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
- void **hinge_joint_set_param** **(** :ref:`RID<class_rid>` joint, :ref:`HingeJointParam<enum_physicsserver_hingejointparam>` param, :ref:`float<class_float>` value **)**
Sets a hinge_joint parameter (see HINGE_JOINT\* constants without the HINGE_JOINT_FLAG\*).
@@ -987,7 +999,7 @@ Gets the priority value of the Joint.
.. _class_PhysicsServer_joint_get_type:
- :ref:`int<class_int>` **joint_get_type** **(** :ref:`RID<class_rid>` joint **)** const
- :ref:`JointType<enum_physicsserver_jointtype>` **joint_get_type** **(** :ref:`RID<class_rid>` joint **)** const
Returns the type of the Joint.
@@ -1011,7 +1023,7 @@ Returns position of the joint in the local space of body b of the joint.
.. _class_PhysicsServer_pin_joint_get_param:
- :ref:`float<class_float>` **pin_joint_get_param** **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param **)** const
- :ref:`float<class_float>` **pin_joint_get_param** **(** :ref:`RID<class_rid>` joint, :ref:`PinJointParam<enum_physicsserver_pinjointparam>` param **)** const
Gets a pin_joint parameter (see PIN_JOINT\* constants).
@@ -1029,7 +1041,7 @@ Sets position of the joint in the local space of body b of the joint.
.. _class_PhysicsServer_pin_joint_set_param:
- void **pin_joint_set_param** **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
- void **pin_joint_set_param** **(** :ref:`RID<class_rid>` joint, :ref:`PinJointParam<enum_physicsserver_pinjointparam>` param, :ref:`float<class_float>` value **)**
Sets a pin_joint parameter (see PIN_JOINT\* constants).
@@ -1041,7 +1053,7 @@ Activates or deactivates the 3D physics engine.
.. _class_PhysicsServer_shape_create:
- :ref:`RID<class_rid>` **shape_create** **(** :ref:`int<class_int>` type **)**
- :ref:`RID<class_rid>` **shape_create** **(** :ref:`ShapeType<enum_physicsserver_shapetype>` type **)**
Creates a shape of type SHAPE\_\*. Does not assign it to a body or an area. To do so, you must use :ref:`area_set_shape<class_PhysicsServer_area_set_shape>` or :ref:`body_set_shape<class_PhysicsServer_body_set_shape>`.
@@ -1053,7 +1065,7 @@ Returns the shape data.
.. _class_PhysicsServer_shape_get_type:
- :ref:`int<class_int>` **shape_get_type** **(** :ref:`RID<class_rid>` shape **)** const
- :ref:`ShapeType<enum_physicsserver_shapetype>` **shape_get_type** **(** :ref:`RID<class_rid>` shape **)** const
Returns the type of shape (see SHAPE\_\* constants).
@@ -1065,13 +1077,13 @@ Sets the shape data that defines its shape and size. The data to be passed depen
.. _class_PhysicsServer_slider_joint_get_param:
- :ref:`float<class_float>` **slider_joint_get_param** **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param **)** const
- :ref:`float<class_float>` **slider_joint_get_param** **(** :ref:`RID<class_rid>` joint, :ref:`SliderJointParam<enum_physicsserver_sliderjointparam>` param **)** const
Gets a slider_joint parameter (see SLIDER_JOINT\* constants).
.. _class_PhysicsServer_slider_joint_set_param:
- void **slider_joint_set_param** **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
- void **slider_joint_set_param** **(** :ref:`RID<class_rid>` joint, :ref:`SliderJointParam<enum_physicsserver_sliderjointparam>` param, :ref:`float<class_float>` value **)**
Gets a slider_joint parameter (see SLIDER_JOINT\* constants).
@@ -1089,7 +1101,7 @@ Returns the state of a space, a :ref:`PhysicsDirectSpaceState<class_physicsdirec
.. _class_PhysicsServer_space_get_param:
- :ref:`float<class_float>` **space_get_param** **(** :ref:`RID<class_rid>` space, :ref:`int<class_int>` param **)** const
- :ref:`float<class_float>` **space_get_param** **(** :ref:`RID<class_rid>` space, :ref:`SpaceParameter<enum_physicsserver_spaceparameter>` param **)** const
Returns the value of a space parameter.
@@ -1107,7 +1119,7 @@ Marks a space as active. It will not have an effect, unless it is assigned to an
.. _class_PhysicsServer_space_set_param:
- void **space_set_param** **(** :ref:`RID<class_rid>` space, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
- void **space_set_param** **(** :ref:`RID<class_rid>` space, :ref:`SpaceParameter<enum_physicsserver_spaceparameter>` param, :ref:`float<class_float>` value **)**
Sets the value for a space parameter. A list of available parameters is on the SPACE_PARAM\_\* constants.

View File

@@ -81,7 +81,7 @@ Member Function Description
- :ref:`Plane<class_plane>` **Plane** **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b, :ref:`float<class_float>` c, :ref:`float<class_float>` d **)**
Creates a plane from the three parameters "a", "b", "c" and "d".
Creates a plane from the four parameters "a", "b", "c" and "d".
.. _class_Plane_Plane:

View File

@@ -16,6 +16,27 @@ Brief Description
A 2D polygon.
Member Functions
----------------
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_bone<class_Polygon2D_add_bone>` **(** :ref:`NodePath<class_nodepath>` path, :ref:`PoolRealArray<class_poolrealarray>` weights **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_bones<class_Polygon2D_clear_bones>` **(** **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_bone<class_Polygon2D_erase_bone>` **(** :ref:`int<class_int>` index **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bone_count<class_Polygon2D_get_bone_count>` **(** **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`get_bone_path<class_Polygon2D_get_bone_path>` **(** :ref:`int<class_int>` index **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolRealArray<class_poolrealarray>` | :ref:`get_bone_weights<class_Polygon2D_get_bone_weights>` **(** :ref:`int<class_int>` index **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bone_path<class_Polygon2D_set_bone_path>` **(** :ref:`int<class_int>` index, :ref:`NodePath<class_nodepath>` path **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bone_weights<class_Polygon2D_set_bone_weights>` **(** :ref:`int<class_int>` index, :ref:`PoolRealArray<class_poolrealarray>` weights **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -23,6 +44,10 @@ Member Variables
- :ref:`bool<class_bool>` **antialiased** - If ``true`` polygon edges will be anti-aliased. Default value: ``false``.
.. _class_Polygon2D_bones:
- :ref:`Array<class_array>` **bones**
.. _class_Polygon2D_color:
- :ref:`Color<class_color>` **color** - The polygon's fill color. If ``texture`` is defined, it will be multiplied by this color. It will also be the default color for vertices not set in ``vertex_colors``.
@@ -43,6 +68,10 @@ Member Variables
- :ref:`PoolVector2Array<class_poolvector2array>` **polygon** - The polygon's list of vertices. The final point will be connected to the first.
.. _class_Polygon2D_skeleton:
- :ref:`NodePath<class_nodepath>` **skeleton**
.. _class_Polygon2D_splits:
- :ref:`PoolIntArray<class_poolintarray>` **splits**
@@ -81,3 +110,39 @@ 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_add_bone:
- void **add_bone** **(** :ref:`NodePath<class_nodepath>` path, :ref:`PoolRealArray<class_poolrealarray>` weights **)**
.. _class_Polygon2D_clear_bones:
- void **clear_bones** **(** **)**
.. _class_Polygon2D_erase_bone:
- void **erase_bone** **(** :ref:`int<class_int>` index **)**
.. _class_Polygon2D_get_bone_count:
- :ref:`int<class_int>` **get_bone_count** **(** **)** const
.. _class_Polygon2D_get_bone_path:
- :ref:`NodePath<class_nodepath>` **get_bone_path** **(** :ref:`int<class_int>` index **)** const
.. _class_Polygon2D_get_bone_weights:
- :ref:`PoolRealArray<class_poolrealarray>` **get_bone_weights** **(** :ref:`int<class_int>` index **)** const
.. _class_Polygon2D_set_bone_path:
- void **set_bone_path** **(** :ref:`int<class_int>` index, :ref:`NodePath<class_nodepath>` path **)**
.. _class_Polygon2D_set_bone_weights:
- void **set_bone_weights** **(** :ref:`int<class_int>` index, :ref:`PoolRealArray<class_poolrealarray>` weights **)**

View File

@@ -28,6 +28,14 @@ Member Functions
Member Variables
----------------
.. _class_PrimitiveMesh_custom_aabb:
- :ref:`AABB<class_aabb>` **custom_aabb**
.. _class_PrimitiveMesh_flip_faces:
- :ref:`bool<class_bool>` **flip_faces**
.. _class_PrimitiveMesh_material:
- :ref:`Material<class_material>` **material** - The current :ref:`Material<class_material>` of the primitive mesh.

View File

@@ -14,74 +14,74 @@ ProceduralSky
Brief Description
-----------------
Type of :ref:`Sky<class_sky>` that is generated procedurally based on user input parameters.
Member Variables
----------------
.. _class_ProceduralSky_ground_bottom_color:
- :ref:`Color<class_color>` **ground_bottom_color**
- :ref:`Color<class_color>` **ground_bottom_color** - Color of the ground at the bottom.
.. _class_ProceduralSky_ground_curve:
- :ref:`float<class_float>` **ground_curve**
- :ref:`float<class_float>` **ground_curve** - How quickly the :ref:`ground_horizon_color<class_ProceduralSky_ground_horizon_color>` fades into the :ref:`ground_bottom_color<class_ProceduralSky_ground_bottom_color>`.
.. _class_ProceduralSky_ground_energy:
- :ref:`float<class_float>` **ground_energy**
- :ref:`float<class_float>` **ground_energy** - Amount of energy contribution from the ground.
.. _class_ProceduralSky_ground_horizon_color:
- :ref:`Color<class_color>` **ground_horizon_color**
- :ref:`Color<class_color>` **ground_horizon_color** - Color of the ground at the horizon.
.. _class_ProceduralSky_sky_curve:
- :ref:`float<class_float>` **sky_curve**
- :ref:`float<class_float>` **sky_curve** - How quickly the :ref:`sky_horizon_color<class_ProceduralSky_sky_horizon_color>` fades into the :ref:`sky_top_color<class_ProceduralSky_sky_top_color>`.
.. _class_ProceduralSky_sky_energy:
- :ref:`float<class_float>` **sky_energy**
- :ref:`float<class_float>` **sky_energy** - Amount of energy contribution from the sky.
.. _class_ProceduralSky_sky_horizon_color:
- :ref:`Color<class_color>` **sky_horizon_color**
- :ref:`Color<class_color>` **sky_horizon_color** - Color of the sky at the horizon.
.. _class_ProceduralSky_sky_top_color:
- :ref:`Color<class_color>` **sky_top_color**
- :ref:`Color<class_color>` **sky_top_color** - Color of the sky at the top.
.. _class_ProceduralSky_sun_angle_max:
- :ref:`float<class_float>` **sun_angle_max**
- :ref:`float<class_float>` **sun_angle_max** - Distance from center of sun where it fades out completely.
.. _class_ProceduralSky_sun_angle_min:
- :ref:`float<class_float>` **sun_angle_min**
- :ref:`float<class_float>` **sun_angle_min** - Distance from sun where it goes from solid to starting to fade.
.. _class_ProceduralSky_sun_color:
- :ref:`Color<class_color>` **sun_color**
- :ref:`Color<class_color>` **sun_color** - Color of the sun.
.. _class_ProceduralSky_sun_curve:
- :ref:`float<class_float>` **sun_curve**
- :ref:`float<class_float>` **sun_curve** - How quickly the sun fades away between :ref:`sun_angle_min<class_ProceduralSky_sun_angle_min>` and :ref:`sun_angle_max<class_ProceduralSky_sun_angle_max>`
.. _class_ProceduralSky_sun_energy:
- :ref:`float<class_float>` **sun_energy**
- :ref:`float<class_float>` **sun_energy** - Amount of energy contribution from the sun.
.. _class_ProceduralSky_sun_latitude:
- :ref:`float<class_float>` **sun_latitude**
- :ref:`float<class_float>` **sun_latitude** - The suns height using polar coordinates.
.. _class_ProceduralSky_sun_longitude:
- :ref:`float<class_float>` **sun_longitude**
- :ref:`float<class_float>` **sun_longitude** - The direction of the sun using polar coordinates.
.. _class_ProceduralSky_texture_size:
- :ref:`TextureSize<enum_proceduralsky_texturesize>` **texture_size**
- :ref:`TextureSize<enum_proceduralsky_texturesize>` **texture_size** - Size of :ref:`Texture<class_texture>` that the ProceduralSky will generate.
Enums
@@ -99,3 +99,10 @@ enum **TextureSize**
- **TEXTURE_SIZE_MAX** = **5**
Description
-----------
ProceduralSky provides a way to create an effective background quickly by defining procedural parameters for the sun, the sky and the ground. The sky and ground are very similar, they are defined by a color at the horizon, another color, and finally an easing curve to interpolate between these two colors. Similarly the sun is described by a position in the sky, a color, and an easing curve. However, the sun also defines a minimum and maximum angle, these two values define at what distance the easing curve begins and ends from the sun, and thus end up defining the size of the sun in the sky.
The ProceduralSky is updated on the CPU after the parameters change and stored in a texture and then displayed as a background in the scene. This makes it relatively unsuitable for realtime updates during gameplay. But with a small texture size it is still feasible to update relatively frequently becuase it is updated on a background thread when multi-threading is available.

View File

@@ -19,37 +19,37 @@ Contains global variables accessible from everywhere.
Member Functions
----------------
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_property_info<class_ProjectSettings_add_property_info>` **(** :ref:`Dictionary<class_dictionary>` hint **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_ProjectSettings_clear>` **(** :ref:`String<class_string>` name **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_order<class_ProjectSettings_get_order>` **(** :ref:`String<class_string>` name **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_setting<class_ProjectSettings_get_setting>` **(** :ref:`String<class_string>` name **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`globalize_path<class_ProjectSettings_globalize_path>` **(** :ref:`String<class_string>` path **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_setting<class_ProjectSettings_has_setting>` **(** :ref:`String<class_string>` name **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`load_resource_pack<class_ProjectSettings_load_resource_pack>` **(** :ref:`String<class_string>` pack **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`localize_path<class_ProjectSettings_localize_path>` **(** :ref:`String<class_string>` path **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`property_can_revert<class_ProjectSettings_property_can_revert>` **(** :ref:`String<class_string>` name **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`property_get_revert<class_ProjectSettings_property_get_revert>` **(** :ref:`String<class_string>` name **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`save<class_ProjectSettings_save>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`save_custom<class_ProjectSettings_save_custom>` **(** :ref:`String<class_string>` file **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_initial_value<class_ProjectSettings_set_initial_value>` **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` value **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_order<class_ProjectSettings_set_order>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` position **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_setting<class_ProjectSettings_set_setting>` **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` value **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_property_info<class_ProjectSettings_add_property_info>` **(** :ref:`Dictionary<class_dictionary>` hint **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_ProjectSettings_clear>` **(** :ref:`String<class_string>` name **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_order<class_ProjectSettings_get_order>` **(** :ref:`String<class_string>` name **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_setting<class_ProjectSettings_get_setting>` **(** :ref:`String<class_string>` name **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`globalize_path<class_ProjectSettings_globalize_path>` **(** :ref:`String<class_string>` path **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_setting<class_ProjectSettings_has_setting>` **(** :ref:`String<class_string>` name **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`load_resource_pack<class_ProjectSettings_load_resource_pack>` **(** :ref:`String<class_string>` pack **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`localize_path<class_ProjectSettings_localize_path>` **(** :ref:`String<class_string>` path **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`property_can_revert<class_ProjectSettings_property_can_revert>` **(** :ref:`String<class_string>` name **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`property_get_revert<class_ProjectSettings_property_get_revert>` **(** :ref:`String<class_string>` name **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`save<class_ProjectSettings_save>` **(** **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`save_custom<class_ProjectSettings_save_custom>` **(** :ref:`String<class_string>` file **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_initial_value<class_ProjectSettings_set_initial_value>` **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` value **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_order<class_ProjectSettings_set_order>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` position **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_setting<class_ProjectSettings_set_setting>` **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` value **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -128,11 +128,11 @@ Convert a path to a localized path (res:// path).
.. _class_ProjectSettings_save:
- :ref:`int<class_int>` **save** **(** **)**
- :ref:`Error<enum_@globalscope_error>` **save** **(** **)**
.. _class_ProjectSettings_save_custom:
- :ref:`int<class_int>` **save_custom** **(** :ref:`String<class_string>` file **)**
- :ref:`Error<enum_@globalscope_error>` **save_custom** **(** :ref:`String<class_string>` file **)**
.. _class_ProjectSettings_set_initial_value:

View File

@@ -18,16 +18,20 @@ Member Functions
----------------
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Quat<class_quat>` | :ref:`Quat<class_Quat_Quat>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y, :ref:`float<class_float>` z, :ref:`float<class_float>` w **)** |
| :ref:`Quat<class_quat>` | :ref:`Quat<class_Quat_Quat>` **(** :ref:`Basis<class_basis>` from **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Quat<class_quat>` | :ref:`Quat<class_Quat_Quat>` **(** :ref:`Vector3<class_vector3>` euler **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Quat<class_quat>` | :ref:`Quat<class_Quat_Quat>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` angle **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Quat<class_quat>` | :ref:`Quat<class_Quat_Quat>` **(** :ref:`Basis<class_basis>` from **)** |
| :ref:`Quat<class_quat>` | :ref:`Quat<class_Quat_Quat>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y, :ref:`float<class_float>` z, :ref:`float<class_float>` w **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Quat<class_quat>` | :ref:`cubic_slerp<class_Quat_cubic_slerp>` **(** :ref:`Quat<class_quat>` b, :ref:`Quat<class_quat>` pre_a, :ref:`Quat<class_quat>` post_b, :ref:`float<class_float>` t **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`dot<class_Quat_dot>` **(** :ref:`Quat<class_quat>` b **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_euler<class_Quat_get_euler>` **(** **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Quat<class_quat>` | :ref:`inverse<class_Quat_inverse>` **(** **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_normalized<class_Quat_is_normalized>` **(** **)** |
@@ -38,6 +42,10 @@ Member Functions
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Quat<class_quat>` | :ref:`normalized<class_Quat_normalized>` **(** **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_axis_angle<class_Quat_set_axis_angle>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` angle **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_euler<class_Quat_set_euler>` **(** :ref:`Vector3<class_vector3>` euler **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Quat<class_quat>` | :ref:`slerp<class_Quat_slerp>` **(** :ref:`Quat<class_quat>` b, :ref:`float<class_float>` t **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Quat<class_quat>` | :ref:`slerpni<class_Quat_slerpni>` **(** :ref:`Quat<class_quat>` b, :ref:`float<class_float>` t **)** |
@@ -68,22 +76,28 @@ Member Variables
Description
-----------
A 4-dimensional vector representing a rotation.
A unit quaternion used for representing 3D rotations.
The vector represents a 4 dimensional complex number where multiplication of the basis elements is not commutative (multiplying i with j gives a different result than multiplying j with i).
It is similar to :ref:`Basis<class_basis>`, which implements matrix representation of rotations, and can be parametrized using both an axis-angle pair or Euler angles. But due to its compactness and the way it is stored in memory, certain operations (obtaining axis-angle and performing SLERP, in particular) are more efficient and robust against floating point errors.
Multiplying quaternions reproduces rotation sequences. However quaternions need to be often renormalized, or else they suffer from precision issues.
It can be used to perform SLERP (spherical-linear interpolation) between two rotations.
Quaternions need to be (re)normalized.
Member Function Description
---------------------------
.. _class_Quat_Quat:
- :ref:`Quat<class_quat>` **Quat** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y, :ref:`float<class_float>` z, :ref:`float<class_float>` w **)**
- :ref:`Quat<class_quat>` **Quat** **(** :ref:`Basis<class_basis>` from **)**
Returns a quaternion defined by these values.
Returns the rotation matrix corresponding to the given quaternion.
.. _class_Quat_Quat:
- :ref:`Quat<class_quat>` **Quat** **(** :ref:`Vector3<class_vector3>` euler **)**
Returns a quaternion that will perform a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X-angle, Y-angle, Z-angle).
.. _class_Quat_Quat:
@@ -93,9 +107,9 @@ Returns a quaternion that will rotate around the given axis by the specified ang
.. _class_Quat_Quat:
- :ref:`Quat<class_quat>` **Quat** **(** :ref:`Basis<class_basis>` from **)**
- :ref:`Quat<class_quat>` **Quat** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y, :ref:`float<class_float>` z, :ref:`float<class_float>` w **)**
Returns the rotation matrix corresponding to the given quaternion.
Returns a quaternion defined by these values.
.. _class_Quat_cubic_slerp:
@@ -109,6 +123,12 @@ Performs a cubic spherical-linear interpolation with another quaternion.
Returns the dot product of two quaternions.
.. _class_Quat_get_euler:
- :ref:`Vector3<class_vector3>` **get_euler** **(** **)**
Return Euler angles (in the YXZ convention: first Z, then X, and Y last) corresponding to the rotation represented by the unit quaternion. Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle).
.. _class_Quat_inverse:
- :ref:`Quat<class_quat>` **inverse** **(** **)**
@@ -139,6 +159,18 @@ Returns the length of the quaternion, squared.
Returns a copy of the quaternion, normalized to unit length.
.. _class_Quat_set_axis_angle:
- void **set_axis_angle** **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` angle **)**
Set the quaternion to a rotation which rotates around axis by the specified angle, in radians. The axis must be a normalized vector.
.. _class_Quat_set_euler:
- void **set_euler** **(** :ref:`Vector3<class_vector3>` euler **)**
Set the quaternion to a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X-angle, Y-angle, Z-angle).
.. _class_Quat_slerp:
- :ref:`Quat<class_quat>` **slerp** **(** :ref:`Quat<class_quat>` b, :ref:`float<class_float>` t **)**

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