Sync classref with current source

This commit is contained in:
Rémi Verschelde
2019-07-15 20:48:41 +02:00
parent fa77d5735f
commit c267e81350
135 changed files with 3506 additions and 2640 deletions

View File

@@ -30,7 +30,7 @@ Properties
+-----------------------------------------+---------------------------------------------------------------+-----------------+
| :ref:`int<class_int>` | :ref:`frame<class_AnimatedSprite_property_frame>` | 0 |
+-----------------------------------------+---------------------------------------------------------------+-----------------+
| :ref:`SpriteFrames<class_SpriteFrames>` | :ref:`frames<class_AnimatedSprite_property_frames>` | null |
| :ref:`SpriteFrames<class_SpriteFrames>` | :ref:`frames<class_AnimatedSprite_property_frames>` | |
+-----------------------------------------+---------------------------------------------------------------+-----------------+
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_AnimatedSprite_property_offset>` | Vector2( 0, 0 ) |
+-----------------------------------------+---------------------------------------------------------------+-----------------+
@@ -147,13 +147,11 @@ The displayed animation frame's index.
- :ref:`SpriteFrames<class_SpriteFrames>` **frames**
+-----------+--------------------------+
| *Default* | null |
+-----------+--------------------------+
| *Setter* | set_sprite_frames(value) |
+-----------+--------------------------+
| *Getter* | get_sprite_frames() |
+-----------+--------------------------+
+----------+--------------------------+
| *Setter* | set_sprite_frames(value) |
+----------+--------------------------+
| *Getter* | get_sprite_frames() |
+----------+--------------------------+
The :ref:`SpriteFrames<class_SpriteFrames>` resource containing the animation(s).

View File

@@ -24,7 +24,7 @@ Properties
+-----------------------------------------+-------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`frame<class_AnimatedSprite3D_property_frame>` | 0 |
+-----------------------------------------+-------------------------------------------------------------+-----------+
| :ref:`SpriteFrames<class_SpriteFrames>` | :ref:`frames<class_AnimatedSprite3D_property_frames>` | null |
| :ref:`SpriteFrames<class_SpriteFrames>` | :ref:`frames<class_AnimatedSprite3D_property_frames>` | |
+-----------------------------------------+-------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`playing<class_AnimatedSprite3D_property_playing>` | false |
+-----------------------------------------+-------------------------------------------------------------+-----------+
@@ -89,13 +89,11 @@ The displayed animation frame's index.
- :ref:`SpriteFrames<class_SpriteFrames>` **frames**
+-----------+--------------------------+
| *Default* | null |
+-----------+--------------------------+
| *Setter* | set_sprite_frames(value) |
+-----------+--------------------------+
| *Getter* | get_sprite_frames() |
+-----------+--------------------------+
+----------+--------------------------+
| *Setter* | set_sprite_frames(value) |
+----------+--------------------------+
| *Getter* | get_sprite_frames() |
+----------+--------------------------+
The :ref:`SpriteFrames<class_SpriteFrames>` resource containing the animation(s).

View File

@@ -153,6 +153,19 @@ Properties
| :ref:`float<class_float>` | :ref:`xfade_time<class_AnimationNodeTransition_property_xfade_time>` | 0.0 |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
Methods
-------
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_input_caption<class_AnimationNodeTransition_method_get_input_caption>` **(** :ref:`int<class_int>` input **)** const |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_input_set_as_auto_advance<class_AnimationNodeTransition_method_is_input_set_as_auto_advance>` **(** :ref:`int<class_int>` input **)** const |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_input_as_auto_advance<class_AnimationNodeTransition_method_set_input_as_auto_advance>` **(** :ref:`int<class_int>` input, :ref:`bool<class_bool>` enable **)** |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_input_caption<class_AnimationNodeTransition_method_set_input_caption>` **(** :ref:`int<class_int>` input, :ref:`String<class_String>` caption **)** |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Property Descriptions
---------------------
@@ -820,3 +833,22 @@ Property Descriptions
| *Getter* | get_cross_fade_time() |
+-----------+----------------------------+
Method Descriptions
-------------------
.. _class_AnimationNodeTransition_method_get_input_caption:
- :ref:`String<class_String>` **get_input_caption** **(** :ref:`int<class_int>` input **)** const
.. _class_AnimationNodeTransition_method_is_input_set_as_auto_advance:
- :ref:`bool<class_bool>` **is_input_set_as_auto_advance** **(** :ref:`int<class_int>` input **)** const
.. _class_AnimationNodeTransition_method_set_input_as_auto_advance:
- void **set_input_as_auto_advance** **(** :ref:`int<class_int>` input, :ref:`bool<class_bool>` enable **)**
.. _class_AnimationNodeTransition_method_set_input_caption:
- void **set_input_caption** **(** :ref:`int<class_int>` input, :ref:`String<class_String>` caption **)**

View File

@@ -28,7 +28,7 @@ Properties
+----------------------------------------------------------------------+--------------------------------------------------------------------------+--------------+
| :ref:`NodePath<class_NodePath>` | :ref:`root_motion_track<class_AnimationTree_property_root_motion_track>` | NodePath("") |
+----------------------------------------------------------------------+--------------------------------------------------------------------------+--------------+
| :ref:`AnimationNode<class_AnimationNode>` | :ref:`tree_root<class_AnimationTree_property_tree_root>` | null |
| :ref:`AnimationNode<class_AnimationNode>` | :ref:`tree_root<class_AnimationTree_property_tree_root>` | |
+----------------------------------------------------------------------+--------------------------------------------------------------------------+--------------+
Methods
@@ -123,13 +123,11 @@ Property Descriptions
- :ref:`AnimationNode<class_AnimationNode>` **tree_root**
+-----------+----------------------+
| *Default* | null |
+-----------+----------------------+
| *Setter* | set_tree_root(value) |
+-----------+----------------------+
| *Getter* | get_tree_root() |
+-----------+----------------------+
+----------+----------------------+
| *Setter* | set_tree_root(value) |
+----------+----------------------+
| *Getter* | get_tree_root() |
+----------+----------------------+
Method Descriptions
-------------------

View File

@@ -19,11 +19,11 @@ The AR/VR server.
Properties
----------
+-------------------------------------------+-----------------------------------------------------------------------+------+
| :ref:`ARVRInterface<class_ARVRInterface>` | :ref:`primary_interface<class_ARVRServer_property_primary_interface>` | null |
+-------------------------------------------+-----------------------------------------------------------------------+------+
| :ref:`float<class_float>` | :ref:`world_scale<class_ARVRServer_property_world_scale>` | 1.0 |
+-------------------------------------------+-----------------------------------------------------------------------+------+
+-------------------------------------------+-----------------------------------------------------------------------+-----+
| :ref:`ARVRInterface<class_ARVRInterface>` | :ref:`primary_interface<class_ARVRServer_property_primary_interface>` | |
+-------------------------------------------+-----------------------------------------------------------------------+-----+
| :ref:`float<class_float>` | :ref:`world_scale<class_ARVRServer_property_world_scale>` | 1.0 |
+-------------------------------------------+-----------------------------------------------------------------------+-----+
Methods
-------
@@ -140,13 +140,11 @@ Property Descriptions
- :ref:`ARVRInterface<class_ARVRInterface>` **primary_interface**
+-----------+------------------------------+
| *Default* | null |
+-----------+------------------------------+
| *Setter* | set_primary_interface(value) |
+-----------+------------------------------+
| *Getter* | get_primary_interface() |
+-----------+------------------------------+
+----------+------------------------------+
| *Setter* | set_primary_interface(value) |
+----------+------------------------------+
| *Getter* | get_primary_interface() |
+----------+------------------------------+
.. _class_ARVRServer_property_world_scale:

View File

@@ -20,7 +20,7 @@ Properties
----------
+-------------------------------+-------------------------------------------------------------+---------------------+
| :ref:`Texture<class_Texture>` | :ref:`atlas<class_AtlasTexture_property_atlas>` | null |
| :ref:`Texture<class_Texture>` | :ref:`atlas<class_AtlasTexture_property_atlas>` | |
+-------------------------------+-------------------------------------------------------------+---------------------+
| :ref:`bool<class_bool>` | :ref:`filter_clip<class_AtlasTexture_property_filter_clip>` | false |
+-------------------------------+-------------------------------------------------------------+---------------------+
@@ -43,13 +43,11 @@ Property Descriptions
- :ref:`Texture<class_Texture>` **atlas**
+-----------+------------------+
| *Default* | null |
+-----------+------------------+
| *Setter* | set_atlas(value) |
+-----------+------------------+
| *Getter* | get_atlas() |
+-----------+------------------+
+----------+------------------+
| *Setter* | set_atlas(value) |
+----------+------------------+
| *Getter* | get_atlas() |
+----------+------------------+
The texture that contains the atlas. Can be any :ref:`Texture<class_Texture>` subtype.

View File

@@ -75,6 +75,35 @@ Properties
| :ref:`float<class_float>` | :ref:`wet<class_AudioEffectChorus_property_wet>` | 0.5 |
+---------------------------+------------------------------------------------------------------------------+--------+
Methods
-------
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_voice_cutoff_hz<class_AudioEffectChorus_method_get_voice_cutoff_hz>` **(** :ref:`int<class_int>` voice_idx **)** const |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_voice_delay_ms<class_AudioEffectChorus_method_get_voice_delay_ms>` **(** :ref:`int<class_int>` voice_idx **)** const |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_voice_depth_ms<class_AudioEffectChorus_method_get_voice_depth_ms>` **(** :ref:`int<class_int>` voice_idx **)** const |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_voice_level_db<class_AudioEffectChorus_method_get_voice_level_db>` **(** :ref:`int<class_int>` voice_idx **)** const |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_voice_pan<class_AudioEffectChorus_method_get_voice_pan>` **(** :ref:`int<class_int>` voice_idx **)** const |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_voice_rate_hz<class_AudioEffectChorus_method_get_voice_rate_hz>` **(** :ref:`int<class_int>` voice_idx **)** const |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_voice_cutoff_hz<class_AudioEffectChorus_method_set_voice_cutoff_hz>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_voice_delay_ms<class_AudioEffectChorus_method_set_voice_delay_ms>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_voice_depth_ms<class_AudioEffectChorus_method_set_voice_depth_ms>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_voice_level_db<class_AudioEffectChorus_method_set_voice_level_db>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_voice_pan<class_AudioEffectChorus_method_set_voice_pan>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_voice_rate_hz<class_AudioEffectChorus_method_set_voice_rate_hz>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -437,3 +466,54 @@ The amount of voices in the effect.
The effect's processed signal.
Method Descriptions
-------------------
.. _class_AudioEffectChorus_method_get_voice_cutoff_hz:
- :ref:`float<class_float>` **get_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx **)** const
.. _class_AudioEffectChorus_method_get_voice_delay_ms:
- :ref:`float<class_float>` **get_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx **)** const
.. _class_AudioEffectChorus_method_get_voice_depth_ms:
- :ref:`float<class_float>` **get_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx **)** const
.. _class_AudioEffectChorus_method_get_voice_level_db:
- :ref:`float<class_float>` **get_voice_level_db** **(** :ref:`int<class_int>` voice_idx **)** const
.. _class_AudioEffectChorus_method_get_voice_pan:
- :ref:`float<class_float>` **get_voice_pan** **(** :ref:`int<class_int>` voice_idx **)** const
.. _class_AudioEffectChorus_method_get_voice_rate_hz:
- :ref:`float<class_float>` **get_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx **)** const
.. _class_AudioEffectChorus_method_set_voice_cutoff_hz:
- void **set_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)**
.. _class_AudioEffectChorus_method_set_voice_delay_ms:
- void **set_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)**
.. _class_AudioEffectChorus_method_set_voice_depth_ms:
- void **set_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)**
.. _class_AudioEffectChorus_method_set_voice_level_db:
- void **set_voice_level_db** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)**
.. _class_AudioEffectChorus_method_set_voice_pan:
- void **set_voice_pan** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)**
.. _class_AudioEffectChorus_method_set_voice_rate_hz:
- void **set_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)**

View File

@@ -30,7 +30,7 @@ Properties
+----------------------------------------------------+----------------------------------------------------------------------+----------+
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer_property_playing>` | false |
+----------------------------------------------------+----------------------------------------------------------------------+----------+
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer_property_stream>` | null |
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer_property_stream>` | |
+----------------------------------------------------+----------------------------------------------------------------------+----------+
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer_property_stream_paused>` | false |
+----------------------------------------------------+----------------------------------------------------------------------+----------+
@@ -165,13 +165,11 @@ If ``true``, audio is playing.
- :ref:`AudioStream<class_AudioStream>` **stream**
+-----------+-------------------+
| *Default* | null |
+-----------+-------------------+
| *Setter* | set_stream(value) |
+-----------+-------------------+
| *Getter* | get_stream() |
+-----------+-------------------+
+----------+-------------------+
| *Setter* | set_stream(value) |
+----------+-------------------+
| *Getter* | get_stream() |
+----------+-------------------+
The :ref:`AudioStream<class_AudioStream>` object to be played.

View File

@@ -34,7 +34,7 @@ Properties
+---------------------------------------+------------------------------------------------------------------------+----------+
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer2D_property_playing>` | false |
+---------------------------------------+------------------------------------------------------------------------+----------+
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer2D_property_stream>` | null |
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer2D_property_stream>` | |
+---------------------------------------+------------------------------------------------------------------------+----------+
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer2D_property_stream_paused>` | false |
+---------------------------------------+------------------------------------------------------------------------+----------+
@@ -178,13 +178,11 @@ If ``true``, audio is playing.
- :ref:`AudioStream<class_AudioStream>` **stream**
+-----------+-------------------+
| *Default* | null |
+-----------+-------------------+
| *Setter* | set_stream(value) |
+-----------+-------------------+
| *Getter* | get_stream() |
+-----------+-------------------+
+----------+-------------------+
| *Setter* | set_stream(value) |
+----------+-------------------+
| *Getter* | get_stream() |
+----------+-------------------+
The :ref:`AudioStream<class_AudioStream>` object to be played.

View File

@@ -50,7 +50,7 @@ Properties
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer3D_property_playing>` | false |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer3D_property_stream>` | null |
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer3D_property_stream>` | |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer3D_property_stream_paused>` | false |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
@@ -359,13 +359,11 @@ If ``true``, audio is playing.
- :ref:`AudioStream<class_AudioStream>` **stream**
+-----------+-------------------+
| *Default* | null |
+-----------+-------------------+
| *Setter* | set_stream(value) |
+-----------+-------------------+
| *Getter* | get_stream() |
+-----------+-------------------+
+----------+-------------------+
| *Setter* | set_stream(value) |
+----------+-------------------+
| *Getter* | get_stream() |
+----------+-------------------+
The :ref:`AudioStream<class_AudioStream>` object to be played.

View File

@@ -19,11 +19,11 @@ Plays audio with random pitch shifting.
Properties
----------
+---------------------------------------+-------------------------------------------------------------------------+------+
| :ref:`AudioStream<class_AudioStream>` | :ref:`audio_stream<class_AudioStreamRandomPitch_property_audio_stream>` | null |
+---------------------------------------+-------------------------------------------------------------------------+------+
| :ref:`float<class_float>` | :ref:`random_pitch<class_AudioStreamRandomPitch_property_random_pitch>` | 1.1 |
+---------------------------------------+-------------------------------------------------------------------------+------+
+---------------------------------------+-------------------------------------------------------------------------+-----+
| :ref:`AudioStream<class_AudioStream>` | :ref:`audio_stream<class_AudioStreamRandomPitch_property_audio_stream>` | |
+---------------------------------------+-------------------------------------------------------------------------+-----+
| :ref:`float<class_float>` | :ref:`random_pitch<class_AudioStreamRandomPitch_property_random_pitch>` | 1.1 |
+---------------------------------------+-------------------------------------------------------------------------+-----+
Description
-----------
@@ -37,13 +37,11 @@ Property Descriptions
- :ref:`AudioStream<class_AudioStream>` **audio_stream**
+-----------+-------------------------+
| *Default* | null |
+-----------+-------------------------+
| *Setter* | set_audio_stream(value) |
+-----------+-------------------------+
| *Getter* | get_audio_stream() |
+-----------+-------------------------+
+----------+-------------------------+
| *Setter* | set_audio_stream(value) |
+----------+-------------------------+
| *Getter* | get_audio_stream() |
+----------+-------------------------+
The current :ref:`AudioStream<class_AudioStream>`.

View File

@@ -40,7 +40,7 @@ Properties
+----------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`String<class_String>` | :ref:`image_path<class_BakedLightmap_property_image_path>` | "." |
+----------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`BakedLightmapData<class_BakedLightmapData>` | :ref:`light_data<class_BakedLightmap_property_light_data>` | null |
| :ref:`BakedLightmapData<class_BakedLightmapData>` | :ref:`light_data<class_BakedLightmap_property_light_data>` | |
+----------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------+
Methods
@@ -146,6 +146,8 @@ Grid subdivision size for lightmapper calculation. The default value will work f
| *Getter* | get_bake_default_texels_per_unit() |
+-----------+-----------------------------------------+
If a :ref:`Mesh.lightmap_size_hint<class_Mesh_property_lightmap_size_hint>` isn't specified, the lightmap baker will dynamically set the lightmap size using this value. This value is measured in texels per world unit. The maximum lightmap texture size is 4096x4096.
.. _class_BakedLightmap_property_bake_energy:
- :ref:`float<class_float>` **bake_energy**
@@ -158,6 +160,8 @@ Grid subdivision size for lightmapper calculation. The default value will work f
| *Getter* | get_energy() |
+-----------+-------------------+
Multiplies the light sources' intensity by this value. For instance, if the value is set to 2, lights will be twice as bright. If the value is set to 0.5, lights will be half as bright.
.. _class_BakedLightmap_property_bake_extents:
- :ref:`Vector3<class_Vector3>` **bake_extents**
@@ -212,6 +216,8 @@ Lightmapping mode. See :ref:`BakeMode<enum_BakedLightmap_BakeMode>`.
| *Getter* | get_propagation() |
+-----------+------------------------+
Defines how far the light will travel before it is no longer effective. The higher the number, the farther the light will travel. For instance, if the value is set to 2, the light will go twice as far. If the value is set to 0.5, the light will only go half as far.
.. _class_BakedLightmap_property_bake_quality:
- :ref:`BakeQuality<enum_BakedLightmap_BakeQuality>` **bake_quality**
@@ -258,13 +264,11 @@ The location where lightmaps will be saved.
- :ref:`BakedLightmapData<class_BakedLightmapData>` **light_data**
+-----------+-----------------------+
| *Default* | null |
+-----------+-----------------------+
| *Setter* | set_light_data(value) |
+-----------+-----------------------+
| *Getter* | get_light_data() |
+-----------+-----------------------+
+----------+-----------------------+
| *Setter* | set_light_data(value) |
+----------+-----------------------+
| *Getter* | get_light_data() |
+----------+-----------------------+
The calculated light data.
@@ -275,7 +279,11 @@ Method Descriptions
- :ref:`BakeError<enum_BakedLightmap_BakeError>` **bake** **(** :ref:`Node<class_Node>` from_node=null, :ref:`bool<class_bool>` create_visual_debug=false **)**
Bakes the lightmaps within the currently edited scene.
.. _class_BakedLightmap_method_debug_bake:
- void **debug_bake** **(** **)**
Executes a dry run bake of lightmaps within the currently edited scene.

View File

@@ -30,13 +30,13 @@ Properties
+-----------------------------------------------+-----------------------------------------------------------------------------+-------+
| :ref:`FocusMode<enum_Control_FocusMode>` | :ref:`enabled_focus_mode<class_BaseButton_property_enabled_focus_mode>` | 2 |
+-----------------------------------------------+-----------------------------------------------------------------------------+-------+
| :ref:`ButtonGroup<class_ButtonGroup>` | :ref:`group<class_BaseButton_property_group>` | null |
| :ref:`ButtonGroup<class_ButtonGroup>` | :ref:`group<class_BaseButton_property_group>` | |
+-----------------------------------------------+-----------------------------------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`keep_pressed_outside<class_BaseButton_property_keep_pressed_outside>` | false |
+-----------------------------------------------+-----------------------------------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`pressed<class_BaseButton_property_pressed>` | false |
+-----------------------------------------------+-----------------------------------------------------------------------------+-------+
| :ref:`ShortCut<class_ShortCut>` | :ref:`shortcut<class_BaseButton_property_shortcut>` | null |
| :ref:`ShortCut<class_ShortCut>` | :ref:`shortcut<class_BaseButton_property_shortcut>` | |
+-----------------------------------------------+-----------------------------------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`shortcut_in_tooltip<class_BaseButton_property_shortcut_in_tooltip>` | true |
+-----------------------------------------------+-----------------------------------------------------------------------------+-------+
@@ -192,13 +192,11 @@ Focus access mode to use when switching between enabled/disabled (see :ref:`Cont
- :ref:`ButtonGroup<class_ButtonGroup>` **group**
+-----------+-------------------------+
| *Default* | null |
+-----------+-------------------------+
| *Setter* | set_button_group(value) |
+-----------+-------------------------+
| *Getter* | get_button_group() |
+-----------+-------------------------+
+----------+-------------------------+
| *Setter* | set_button_group(value) |
+----------+-------------------------+
| *Getter* | get_button_group() |
+----------+-------------------------+
:ref:`ButtonGroup<class_ButtonGroup>` associated to the button.
@@ -234,13 +232,11 @@ If ``true``, the button's state is pressed. Means the button is pressed down or
- :ref:`ShortCut<class_ShortCut>` **shortcut**
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_shortcut(value) |
+-----------+---------------------+
| *Getter* | get_shortcut() |
+-----------+---------------------+
+----------+---------------------+
| *Setter* | set_shortcut(value) |
+----------+---------------------+
| *Getter* | get_shortcut() |
+----------+---------------------+
:ref:`ShortCut<class_ShortCut>` associated to the button.

View File

@@ -24,7 +24,7 @@ Properties
+-------------------------------------+-----------------------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`distance_field<class_BitmapFont_property_distance_field>` | false |
+-------------------------------------+-----------------------------------------------------------------+-------+
| :ref:`BitmapFont<class_BitmapFont>` | :ref:`fallback<class_BitmapFont_property_fallback>` | null |
| :ref:`BitmapFont<class_BitmapFont>` | :ref:`fallback<class_BitmapFont_property_fallback>` | |
+-------------------------------------+-----------------------------------------------------------------+-------+
| :ref:`float<class_float>` | :ref:`height<class_BitmapFont_property_height>` | 1.0 |
+-------------------------------------+-----------------------------------------------------------------+-------+
@@ -92,13 +92,11 @@ If ``true``, distance field hint is enabled.
- :ref:`BitmapFont<class_BitmapFont>` **fallback**
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_fallback(value) |
+-----------+---------------------+
| *Getter* | get_fallback() |
+-----------+---------------------+
+----------+---------------------+
| *Setter* | set_fallback(value) |
+----------+---------------------+
| *Getter* | get_fallback() |
+----------+---------------------+
The fallback font.

View File

@@ -28,7 +28,7 @@ Properties
+-----------------------------------------+---------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`flat<class_Button_property_flat>` | false |
+-----------------------------------------+---------------------------------------------------+-------+
| :ref:`Texture<class_Texture>` | :ref:`icon<class_Button_property_icon>` | null |
| :ref:`Texture<class_Texture>` | :ref:`icon<class_Button_property_icon>` | |
+-----------------------------------------+---------------------------------------------------+-------+
| :ref:`String<class_String>` | :ref:`text<class_Button_property_text>` | "" |
+-----------------------------------------+---------------------------------------------------+-------+
@@ -36,29 +36,29 @@ Properties
Theme Properties
----------------
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.941176, 0.941176, 0.941176, 1 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`int<class_int>` | hseparation | 2 |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed | |
+---------------------------------+---------------------+------------------------------------------+
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled | |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+---------------------+------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.88, 0.88, 0.88, 1 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover | |
+---------------------------------+---------------------+------------------------------+
| :ref:`int<class_int>` | hseparation | 2 |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed | |
+---------------------------------+---------------------+------------------------------+
Enumerations
------------
@@ -133,13 +133,11 @@ Flat buttons don't display decoration.
- :ref:`Texture<class_Texture>` **icon**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_button_icon(value) |
+-----------+------------------------+
| *Getter* | get_button_icon() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_button_icon(value) |
+----------+------------------------+
| *Getter* | get_button_icon() |
+----------+------------------------+
Button's icon, if text is present the icon will be placed before the text.

View File

@@ -28,7 +28,7 @@ Properties
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
| :ref:`DopplerTracking<enum_Camera_DopplerTracking>` | :ref:`doppler_tracking<class_Camera_property_doppler_tracking>` | 0 |
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
| :ref:`Environment<class_Environment>` | :ref:`environment<class_Camera_property_environment>` | null |
| :ref:`Environment<class_Environment>` | :ref:`environment<class_Camera_property_environment>` | |
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
| :ref:`float<class_float>` | :ref:`far<class_Camera_property_far>` | 100.0 |
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
@@ -187,13 +187,11 @@ If not :ref:`DOPPLER_TRACKING_DISABLED<class_Camera_constant_DOPPLER_TRACKING_DI
- :ref:`Environment<class_Environment>` **environment**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_environment(value) |
+-----------+------------------------+
| *Getter* | get_environment() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_environment(value) |
+----------+------------------------+
| *Getter* | get_environment() |
+----------+------------------------+
The :ref:`Environment<class_Environment>` to use for this camera.

View File

@@ -74,21 +74,29 @@ Properties
Methods
-------
+-------------------------------+---------------------------------------------------------------------------------------------------+
| void | :ref:`align<class_Camera2D_method_align>` **(** **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------+
| void | :ref:`clear_current<class_Camera2D_method_clear_current>` **(** **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------+
| void | :ref:`force_update_scroll<class_Camera2D_method_force_update_scroll>` **(** **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_camera_position<class_Camera2D_method_get_camera_position>` **(** **)** const |
+-------------------------------+---------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_camera_screen_center<class_Camera2D_method_get_camera_screen_center>` **(** **)** const |
+-------------------------------+---------------------------------------------------------------------------------------------------+
| void | :ref:`make_current<class_Camera2D_method_make_current>` **(** **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------+
| void | :ref:`reset_smoothing<class_Camera2D_method_reset_smoothing>` **(** **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------+
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`align<class_Camera2D_method_align>` **(** **)** |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_current<class_Camera2D_method_clear_current>` **(** **)** |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`force_update_scroll<class_Camera2D_method_force_update_scroll>` **(** **)** |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_camera_position<class_Camera2D_method_get_camera_position>` **(** **)** const |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_camera_screen_center<class_Camera2D_method_get_camera_screen_center>` **(** **)** const |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_drag_margin<class_Camera2D_method_get_drag_margin>` **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin **)** const |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_limit<class_Camera2D_method_get_limit>` **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin **)** const |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`make_current<class_Camera2D_method_make_current>` **(** **)** |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`reset_smoothing<class_Camera2D_method_reset_smoothing>` **(** **)** |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_drag_margin<class_Camera2D_method_set_drag_margin>` **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`float<class_float>` drag_margin **)** |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_limit<class_Camera2D_method_set_limit>` **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`int<class_int>` limit **)** |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
@@ -504,6 +512,14 @@ Returns the camera position.
Returns the location of the ``Camera2D``'s screen-center, relative to the origin.
.. _class_Camera2D_method_get_drag_margin:
- :ref:`float<class_float>` **get_drag_margin** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin **)** const
.. _class_Camera2D_method_get_limit:
- :ref:`int<class_int>` **get_limit** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin **)** const
.. _class_Camera2D_method_make_current:
- void **make_current** **(** **)**
@@ -518,3 +534,11 @@ Sets the camera's position immediately to its current smoothing destination.
This has no effect if smoothing is disabled.
.. _class_Camera2D_method_set_drag_margin:
- void **set_drag_margin** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`float<class_float>` drag_margin **)**
.. _class_Camera2D_method_set_limit:
- void **set_limit** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`int<class_int>` limit **)**

View File

@@ -24,7 +24,7 @@ Properties
+---------------------------------+---------------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>` | :ref:`light_mask<class_CanvasItem_property_light_mask>` | 1 |
+---------------------------------+---------------------------------------------------------------------------+---------------------+
| :ref:`Material<class_Material>` | :ref:`material<class_CanvasItem_property_material>` | null |
| :ref:`Material<class_Material>` | :ref:`material<class_CanvasItem_property_material>` | |
+---------------------------------+---------------------------------------------------------------------------+---------------------+
| :ref:`Color<class_Color>` | :ref:`modulate<class_CanvasItem_property_modulate>` | Color( 1, 1, 1, 1 ) |
+---------------------------------+---------------------------------------------------------------------------+---------------------+
@@ -69,7 +69,7 @@ Methods
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_primitive<class_CanvasItem_method_draw_primitive>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs, :ref:`Texture<class_Texture>` texture=null, :ref:`float<class_float>` width=1.0, :ref:`Texture<class_Texture>` normal_map=null **)** |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_rect<class_CanvasItem_method_draw_rect>` **(** :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` filled=true **)** |
| void | :ref:`draw_rect<class_CanvasItem_method_draw_rect>` **(** :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` filled=true, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_set_transform<class_CanvasItem_method_draw_set_transform>` **(** :ref:`Vector2<class_Vector2>` position, :ref:`float<class_float>` rotation, :ref:`Vector2<class_Vector2>` scale **)** |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -256,13 +256,11 @@ The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D<clas
- :ref:`Material<class_Material>` **material**
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_material(value) |
+-----------+---------------------+
| *Getter* | get_material() |
+-----------+---------------------+
+----------+---------------------+
| *Setter* | set_material(value) |
+----------+---------------------+
| *Getter* | get_material() |
+----------+---------------------+
The material applied to textures on this ``CanvasItem``.
@@ -421,9 +419,11 @@ Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for
.. _class_CanvasItem_method_draw_rect:
- void **draw_rect** **(** :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` filled=true **)**
- void **draw_rect** **(** :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` filled=true, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
Draws a colored rectangle.
Draws a rectangle. If ``filled`` is ``true``, the rectangle will be filled with the ``color`` specified. If ``filled`` is ``false``, the rectangle will be drawn as a stroke with the ``color`` and ``width`` specified. If ``antialiased`` is ``true``, the lines will be antialiased.
**Note:** ``width`` and ``antialiased`` are only effective if ``filled`` is ``false``.
.. _class_CanvasItem_method_draw_set_transform:

View File

@@ -19,43 +19,43 @@ Binary choice user interface widget.
Theme Properties
----------------
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`int<class_int>` | check_vadjust | 0 |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | checked | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.941176, 0.941176, 0.941176, 1 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_hover_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover_pressed | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`int<class_int>` | hseparation | 4 |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | radio_checked | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | radio_unchecked | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | unchecked | |
+---------------------------------+--------------------------+------------------------------------------+
+---------------------------------+--------------------------+------------------------------+
| :ref:`int<class_int>` | check_vadjust | 0 |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | checked | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.88, 0.88, 0.88, 1 ) |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_hover_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+--------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover_pressed | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`int<class_int>` | hseparation | 4 |
+---------------------------------+--------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | radio_checked | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | radio_unchecked | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | unchecked | |
+---------------------------------+--------------------------+------------------------------+
Description
-----------

View File

@@ -19,43 +19,43 @@ Checkable button.
Theme Properties
----------------
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`int<class_int>` | check_vadjust | 0 |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.941176, 0.941176, 0.941176, 1 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_hover_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover_pressed | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`int<class_int>` | hseparation | 4 |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | off | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | off_disabled | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | on | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | on_disabled | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed | |
+---------------------------------+--------------------------+------------------------------------------+
+---------------------------------+--------------------------+------------------------------+
| :ref:`int<class_int>` | check_vadjust | 0 |
+---------------------------------+--------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.88, 0.88, 0.88, 1 ) |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_hover_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+--------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover_pressed | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`int<class_int>` | hseparation | 4 |
+---------------------------------+--------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | off | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | off_disabled | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | on | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | on_disabled | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed | |
+---------------------------------+--------------------------+------------------------------+
Description
-----------

View File

@@ -22,7 +22,7 @@ Properties
+---------------------------+---------------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionShape_property_disabled>` | false |
+---------------------------+---------------------------------------------------------+-------+
| :ref:`Shape<class_Shape>` | :ref:`shape<class_CollisionShape_property_shape>` | null |
| :ref:`Shape<class_Shape>` | :ref:`shape<class_CollisionShape_property_shape>` | |
+---------------------------+---------------------------------------------------------+-------+
Methods
@@ -65,13 +65,11 @@ A disabled collision shape has no effect in the world.
- :ref:`Shape<class_Shape>` **shape**
+-----------+------------------+
| *Default* | null |
+-----------+------------------+
| *Setter* | set_shape(value) |
+-----------+------------------+
| *Getter* | get_shape() |
+-----------+------------------+
+----------+------------------+
| *Setter* | set_shape(value) |
+----------+------------------+
| *Getter* | get_shape() |
+----------+------------------+
The actual shape owned by this collision shape.

View File

@@ -26,7 +26,7 @@ Properties
+-------------------------------+-------------------------------------------------------------------------------------------+-------+
| :ref:`float<class_float>` | :ref:`one_way_collision_margin<class_CollisionShape2D_property_one_way_collision_margin>` | 1.0 |
+-------------------------------+-------------------------------------------------------------------------------------------+-------+
| :ref:`Shape2D<class_Shape2D>` | :ref:`shape<class_CollisionShape2D_property_shape>` | null |
| :ref:`Shape2D<class_Shape2D>` | :ref:`shape<class_CollisionShape2D_property_shape>` | |
+-------------------------------+-------------------------------------------------------------------------------------------+-------+
Description
@@ -86,13 +86,11 @@ Sets whether this collision shape should only detect collision on one side (top
- :ref:`Shape2D<class_Shape2D>` **shape**
+-----------+------------------+
| *Default* | null |
+-----------+------------------+
| *Setter* | set_shape(value) |
+-----------+------------------+
| *Getter* | get_shape() |
+-----------+------------------+
+----------+------------------+
| *Setter* | set_shape(value) |
+----------+------------------+
| *Getter* | get_shape() |
+----------+------------------+
The actual shape owned by this collision shape.

View File

@@ -31,6 +31,15 @@ Properties
| :ref:`float<class_float>` | :ref:`twist_span<class_ConeTwistJoint_property_twist_span>` | 180.0 |
+---------------------------+-------------------------------------------------------------+-------+
Methods
-------
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param<class_ConeTwistJoint_method_get_param>` **(** :ref:`Param<enum_ConeTwistJoint_Param>` param **)** const |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param<class_ConeTwistJoint_method_set_param>` **(** :ref:`Param<enum_ConeTwistJoint_Param>` param, :ref:`float<class_float>` value **)** |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
@@ -156,3 +165,14 @@ Twist is the rotation around the twist axis, this value defined how far the join
Twist is locked if below 0.05.
Method Descriptions
-------------------
.. _class_ConeTwistJoint_method_get_param:
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_ConeTwistJoint_Param>` param **)** const
.. _class_ConeTwistJoint_method_set_param:
- void **set_param** **(** :ref:`Param<enum_ConeTwistJoint_Param>` param, :ref:`float<class_float>` value **)**

View File

@@ -84,7 +84,7 @@ Properties
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
| :ref:`int<class_int>` | :ref:`size_flags_vertical<class_Control_property_size_flags_vertical>` | 1 |
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
| :ref:`Theme<class_Theme>` | :ref:`theme<class_Control_property_theme>` | null |
| :ref:`Theme<class_Theme>` | :ref:`theme<class_Control_property_theme>` | |
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
Methods
@@ -119,6 +119,8 @@ Methods
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`force_drag<class_Control_method_force_drag>` **(** :ref:`Variant<class_Variant>` data, :ref:`Control<class_Control>` preview **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_anchor<class_Control_method_get_anchor>` **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_begin<class_Control_method_get_begin>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`get_color<class_Control_method_get_color>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const |
@@ -133,6 +135,8 @@ Methods
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_end<class_Control_method_get_end>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`get_focus_neighbour<class_Control_method_get_focus_neighbour>` **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Control<class_Control>` | :ref:`get_focus_owner<class_Control_method_get_focus_owner>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Font<class_Font>` | :ref:`get_font<class_Control_method_get_font>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const |
@@ -141,6 +145,8 @@ Methods
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`get_icon<class_Control_method_get_icon>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_margin<class_Control_method_get_margin>` **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_minimum_size<class_Control_method_get_minimum_size>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_parent_area_size<class_Control_method_get_parent_area_size>` **(** **)** const |
@@ -205,8 +211,12 @@ Methods
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_end<class_Control_method_set_end>` **(** :ref:`Vector2<class_Vector2>` position **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_focus_neighbour<class_Control_method_set_focus_neighbour>` **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`NodePath<class_NodePath>` neighbour **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_global_position<class_Control_method_set_global_position>` **(** :ref:`Vector2<class_Vector2>` position, :ref:`bool<class_bool>` keep_margins=false **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_margin<class_Control_method_set_margin>` **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`float<class_float>` offset **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_margins_preset<class_Control_method_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_position<class_Control_method_set_position>` **(** :ref:`Vector2<class_Vector2>` position, :ref:`bool<class_bool>` keep_margins=false **)** |
@@ -1024,13 +1034,11 @@ Tells the parent :ref:`Container<class_Container>` nodes how they should resize
- :ref:`Theme<class_Theme>` **theme**
+-----------+------------------+
| *Default* | null |
+-----------+------------------+
| *Setter* | set_theme(value) |
+-----------+------------------+
| *Getter* | get_theme() |
+-----------+------------------+
+----------+------------------+
| *Setter* | set_theme(value) |
+----------+------------------+
| *Getter* | get_theme() |
+----------+------------------+
Changing this property replaces the current :ref:`Theme<class_Theme>` resource this node and all its ``Control`` children use.
@@ -1142,6 +1150,10 @@ Forces drag and bypasses :ref:`get_drag_data<class_Control_method_get_drag_data>
The methods :ref:`can_drop_data<class_Control_method_can_drop_data>` and :ref:`drop_data<class_Control_method_drop_data>` must be implemented on controls that want to receive drop data.
.. _class_Control_method_get_anchor:
- :ref:`float<class_float>` **get_anchor** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin **)** const
.. _class_Control_method_get_begin:
- :ref:`Vector2<class_Vector2>` **get_begin** **(** **)** const
@@ -1189,6 +1201,10 @@ A preview that will follow the mouse that should represent the data can be set w
Returns :ref:`margin_right<class_Control_property_margin_right>` and :ref:`margin_bottom<class_Control_property_margin_bottom>`.
.. _class_Control_method_get_focus_neighbour:
- :ref:`NodePath<class_NodePath>` **get_focus_neighbour** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin **)** const
.. _class_Control_method_get_focus_owner:
- :ref:`Control<class_Control>` **get_focus_owner** **(** **)** const
@@ -1209,6 +1225,10 @@ Returns the position and size of the control relative to the top-left corner of
- :ref:`Texture<class_Texture>` **get_icon** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
.. _class_Control_method_get_margin:
- :ref:`float<class_float>` **get_margin** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin **)** const
.. _class_Control_method_get_minimum_size:
- :ref:`Vector2<class_Vector2>` **get_minimum_size** **(** **)** const
@@ -1388,10 +1408,18 @@ Shows the given control at the mouse pointer. A good time to call this method is
Sets :ref:`margin_right<class_Control_property_margin_right>` and :ref:`margin_bottom<class_Control_property_margin_bottom>` at the same time.
.. _class_Control_method_set_focus_neighbour:
- void **set_focus_neighbour** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`NodePath<class_NodePath>` neighbour **)**
.. _class_Control_method_set_global_position:
- void **set_global_position** **(** :ref:`Vector2<class_Vector2>` position, :ref:`bool<class_bool>` keep_margins=false **)**
.. _class_Control_method_set_margin:
- void **set_margin** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`float<class_float>` offset **)**
.. _class_Control_method_set_margins_preset:
- void **set_margins_preset** **(** :ref:`LayoutPreset<enum_Control_LayoutPreset>` preset, :ref:`LayoutPresetMode<enum_Control_LayoutPresetMode>` resize_mode=0, :ref:`int<class_int>` margin=0 **)**

View File

@@ -24,35 +24,35 @@ Properties
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`angle<class_CPUParticles_property_angle>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`Curve<class_Curve>` | :ref:`angle_curve<class_CPUParticles_property_angle_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`angle_curve<class_CPUParticles_property_angle_curve>` | |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`angle_random<class_CPUParticles_property_angle_random>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`angular_velocity<class_CPUParticles_property_angular_velocity>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`Curve<class_Curve>` | :ref:`angular_velocity_curve<class_CPUParticles_property_angular_velocity_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`angular_velocity_curve<class_CPUParticles_property_angular_velocity_curve>` | |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`angular_velocity_random<class_CPUParticles_property_angular_velocity_random>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`anim_offset<class_CPUParticles_property_anim_offset>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`Curve<class_Curve>` | :ref:`anim_offset_curve<class_CPUParticles_property_anim_offset_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`anim_offset_curve<class_CPUParticles_property_anim_offset_curve>` | |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`anim_offset_random<class_CPUParticles_property_anim_offset_random>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`anim_speed<class_CPUParticles_property_anim_speed>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`Curve<class_Curve>` | :ref:`anim_speed_curve<class_CPUParticles_property_anim_speed_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`anim_speed_curve<class_CPUParticles_property_anim_speed_curve>` | |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`anim_speed_random<class_CPUParticles_property_anim_speed_random>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`Color<class_Color>` | :ref:`color<class_CPUParticles_property_color>` | Color( 1, 1, 1, 1 ) |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`Gradient<class_Gradient>` | :ref:`color_ramp<class_CPUParticles_property_color_ramp>` | null |
| :ref:`Gradient<class_Gradient>` | :ref:`color_ramp<class_CPUParticles_property_color_ramp>` | |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`damping<class_CPUParticles_property_damping>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`Curve<class_Curve>` | :ref:`damping_curve<class_CPUParticles_property_damping_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`damping_curve<class_CPUParticles_property_damping_curve>` | |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`damping_random<class_CPUParticles_property_damping_random>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
@@ -92,7 +92,7 @@ Properties
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`hue_variation<class_CPUParticles_property_hue_variation>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`Curve<class_Curve>` | :ref:`hue_variation_curve<class_CPUParticles_property_hue_variation_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`hue_variation_curve<class_CPUParticles_property_hue_variation_curve>` | |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`hue_variation_random<class_CPUParticles_property_hue_variation_random>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
@@ -102,15 +102,17 @@ Properties
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`lifetime<class_CPUParticles_property_lifetime>` | 1.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`lifetime_randomness<class_CPUParticles_property_lifetime_randomness>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`linear_accel<class_CPUParticles_property_linear_accel>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`Curve<class_Curve>` | :ref:`linear_accel_curve<class_CPUParticles_property_linear_accel_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`linear_accel_curve<class_CPUParticles_property_linear_accel_curve>` | |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`linear_accel_random<class_CPUParticles_property_linear_accel_random>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`local_coords<class_CPUParticles_property_local_coords>` | true |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_CPUParticles_property_mesh>` | null |
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_CPUParticles_property_mesh>` | |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`one_shot<class_CPUParticles_property_one_shot>` | false |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
@@ -124,7 +126,7 @@ Properties
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`radial_accel<class_CPUParticles_property_radial_accel>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`Curve<class_Curve>` | :ref:`radial_accel_curve<class_CPUParticles_property_radial_accel_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`radial_accel_curve<class_CPUParticles_property_radial_accel_curve>` | |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`radial_accel_random<class_CPUParticles_property_radial_accel_random>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
@@ -132,7 +134,7 @@ Properties
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`scale_amount<class_CPUParticles_property_scale_amount>` | 1.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`Curve<class_Curve>` | :ref:`scale_amount_curve<class_CPUParticles_property_scale_amount_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`scale_amount_curve<class_CPUParticles_property_scale_amount_curve>` | |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`scale_amount_random<class_CPUParticles_property_scale_amount_random>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
@@ -142,7 +144,7 @@ Properties
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`tangential_accel<class_CPUParticles_property_tangential_accel>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`Curve<class_Curve>` | :ref:`tangential_accel_curve<class_CPUParticles_property_tangential_accel_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`tangential_accel_curve<class_CPUParticles_property_tangential_accel_curve>` | |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`tangential_accel_random<class_CPUParticles_property_tangential_accel_random>` | 0.0 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
@@ -150,11 +152,27 @@ Properties
Methods
-------
+------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`convert_from_particles<class_CPUParticles_method_convert_from_particles>` **(** :ref:`Node<class_Node>` particles **)** |
+------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`restart<class_CPUParticles_method_restart>` **(** **)** |
+------+-------------------------------------------------------------------------------------------------------------------------------+
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`convert_from_particles<class_CPUParticles_method_convert_from_particles>` **(** :ref:`Node<class_Node>` particles **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param<class_CPUParticles_method_get_param>` **(** :ref:`Parameter<enum_CPUParticles_Parameter>` param **)** const |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>` | :ref:`get_param_curve<class_CPUParticles_method_get_param_curve>` **(** :ref:`Parameter<enum_CPUParticles_Parameter>` param **)** const |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param_randomness<class_CPUParticles_method_get_param_randomness>` **(** :ref:`Parameter<enum_CPUParticles_Parameter>` param **)** const |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_particle_flag<class_CPUParticles_method_get_particle_flag>` **(** :ref:`Flags<enum_CPUParticles_Flags>` flag **)** const |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`restart<class_CPUParticles_method_restart>` **(** **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param<class_CPUParticles_method_set_param>` **(** :ref:`Parameter<enum_CPUParticles_Parameter>` param, :ref:`float<class_float>` value **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param_curve<class_CPUParticles_method_set_param_curve>` **(** :ref:`Parameter<enum_CPUParticles_Parameter>` param, :ref:`Curve<class_Curve>` curve **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>` **(** :ref:`Parameter<enum_CPUParticles_Parameter>` param, :ref:`float<class_float>` randomness **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_particle_flag<class_CPUParticles_method_set_particle_flag>` **(** :ref:`Flags<enum_CPUParticles_Flags>` flag, :ref:`bool<class_bool>` enable **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
@@ -205,29 +223,29 @@ enum **DrawOrder**:
enum **Parameter**:
- **PARAM_INITIAL_LINEAR_VELOCITY** = **0** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set initial velocity properties.
- **PARAM_INITIAL_LINEAR_VELOCITY** = **0** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles_method_set_param_curve>` to set initial velocity properties.
- **PARAM_ANGULAR_VELOCITY** = **1** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set angular velocity properties.
- **PARAM_ANGULAR_VELOCITY** = **1** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles_method_set_param_curve>` to set angular velocity properties.
- **PARAM_ORBIT_VELOCITY** = **2** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set orbital velocity properties.
- **PARAM_ORBIT_VELOCITY** = **2** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles_method_set_param_curve>` to set orbital velocity properties.
- **PARAM_LINEAR_ACCEL** = **3** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set linear acceleration properties.
- **PARAM_LINEAR_ACCEL** = **3** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles_method_set_param_curve>` to set linear acceleration properties.
- **PARAM_RADIAL_ACCEL** = **4** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set radial acceleration properties.
- **PARAM_RADIAL_ACCEL** = **4** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles_method_set_param_curve>` to set radial acceleration properties.
- **PARAM_TANGENTIAL_ACCEL** = **5** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set tangential acceleration properties.
- **PARAM_TANGENTIAL_ACCEL** = **5** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles_method_set_param_curve>` to set tangential acceleration properties.
- **PARAM_DAMPING** = **6** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set damping properties.
- **PARAM_DAMPING** = **6** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles_method_set_param_curve>` to set damping properties.
- **PARAM_ANGLE** = **7** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set angle properties.
- **PARAM_ANGLE** = **7** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles_method_set_param_curve>` to set angle properties.
- **PARAM_SCALE** = **8** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set scale properties.
- **PARAM_SCALE** = **8** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles_method_set_param_curve>` to set scale properties.
- **PARAM_HUE_VARIATION** = **9** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set hue variation properties.
- **PARAM_HUE_VARIATION** = **9** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles_method_set_param_curve>` to set hue variation properties.
- **PARAM_ANIM_SPEED** = **10** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set animation speed properties.
- **PARAM_ANIM_SPEED** = **10** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles_method_set_param_curve>` to set animation speed properties.
- **PARAM_ANIM_OFFSET** = **11** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set animation offset properties.
- **PARAM_ANIM_OFFSET** = **11** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles_method_set_param_curve>` to set animation offset properties.
- **PARAM_MAX** = **12** --- Represents the size of the :ref:`Parameter<enum_CPUParticles_Parameter>` enum.
@@ -243,11 +261,11 @@ enum **Parameter**:
enum **Flags**:
- **FLAG_ALIGN_Y_TO_VELOCITY** = **0** --- Use with :ref:`set_flag<class_CPUParticles_method_set_flag>` to set :ref:`flag_align_y<class_CPUParticles_property_flag_align_y>`.
- **FLAG_ALIGN_Y_TO_VELOCITY** = **0** --- Use with :ref:`set_particle_flag<class_CPUParticles_method_set_particle_flag>` to set :ref:`flag_align_y<class_CPUParticles_property_flag_align_y>`.
- **FLAG_ROTATE_Y** = **1** --- Use with :ref:`set_flag<class_CPUParticles_method_set_flag>` to set :ref:`flag_rotate_y<class_CPUParticles_property_flag_rotate_y>`.
- **FLAG_ROTATE_Y** = **1** --- Use with :ref:`set_particle_flag<class_CPUParticles_method_set_particle_flag>` to set :ref:`flag_rotate_y<class_CPUParticles_property_flag_rotate_y>`.
- **FLAG_DISABLE_Z** = **2** --- Use with :ref:`set_flag<class_CPUParticles_method_set_flag>` to set :ref:`flag_disable_z<class_CPUParticles_property_flag_disable_z>`.
- **FLAG_DISABLE_Z** = **2** --- Use with :ref:`set_particle_flag<class_CPUParticles_method_set_particle_flag>` to set :ref:`flag_disable_z<class_CPUParticles_property_flag_disable_z>`.
- **FLAG_MAX** = **3** --- Represents the size of the :ref:`Flags<enum_CPUParticles_Flags>` enum.
@@ -317,13 +335,11 @@ Initial rotation applied to each particle, in degrees.
- :ref:`Curve<class_Curve>` **angle_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Each particle's rotation will be animated along this :ref:`Curve<class_Curve>`.
@@ -359,13 +375,11 @@ Initial angular velocity applied to each particle. Sets the speed of rotation of
- :ref:`Curve<class_Curve>` **angular_velocity_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Each particle's angular velocity will vary along this :ref:`Curve<class_Curve>`.
@@ -401,13 +415,11 @@ Particle animation offset.
- :ref:`Curve<class_Curve>` **anim_offset_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Each particle's animation offset will vary along this :ref:`Curve<class_Curve>`.
@@ -443,13 +455,11 @@ Particle animation speed.
- :ref:`Curve<class_Curve>` **anim_speed_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Each particle's animation speed will vary along this :ref:`Curve<class_Curve>`.
@@ -485,13 +495,11 @@ Unused for 3D particles.
- :ref:`Gradient<class_Gradient>` **color_ramp**
+-----------+-----------------------+
| *Default* | null |
+-----------+-----------------------+
| *Setter* | set_color_ramp(value) |
+-----------+-----------------------+
| *Getter* | get_color_ramp() |
+-----------+-----------------------+
+----------+-----------------------+
| *Setter* | set_color_ramp(value) |
+----------+-----------------------+
| *Getter* | get_color_ramp() |
+----------+-----------------------+
Unused for 3D particles.
@@ -513,13 +521,11 @@ The rate at which particles lose velocity.
- :ref:`Curve<class_Curve>` **damping_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Damping will vary along this :ref:`Curve<class_Curve>`.
@@ -781,13 +787,11 @@ Initial hue variation applied to each particle.
- :ref:`Curve<class_Curve>` **hue_variation_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Each particle's hue will vary along this :ref:`Curve<class_Curve>`.
@@ -847,6 +851,20 @@ Initial velocity randomness ratio.
Amount of time each particle will exist.
.. _class_CPUParticles_property_lifetime_randomness:
- :ref:`float<class_float>` **lifetime_randomness**
+-----------+--------------------------------+
| *Default* | 0.0 |
+-----------+--------------------------------+
| *Setter* | set_lifetime_randomness(value) |
+-----------+--------------------------------+
| *Getter* | get_lifetime_randomness() |
+-----------+--------------------------------+
Particle lifetime randomness ratio.
.. _class_CPUParticles_property_linear_accel:
- :ref:`float<class_float>` **linear_accel**
@@ -865,13 +883,11 @@ Linear acceleration applied to each particle in the direction of motion.
- :ref:`Curve<class_Curve>` **linear_accel_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Each particle's linear acceleration will vary along this :ref:`Curve<class_Curve>`.
@@ -907,13 +923,11 @@ If ``true``, particles use the parent node's coordinate space. If ``false``, the
- :ref:`Mesh<class_Mesh>` **mesh**
+-----------+-----------------+
| *Default* | null |
+-----------+-----------------+
| *Setter* | set_mesh(value) |
+-----------+-----------------+
| *Getter* | get_mesh() |
+-----------+-----------------+
+----------+-----------------+
| *Setter* | set_mesh(value) |
+----------+-----------------+
| *Getter* | get_mesh() |
+----------+-----------------+
The :ref:`Mesh<class_Mesh>` used for each particle. If ``null``, particles will be spheres.
@@ -1001,13 +1015,11 @@ Radial acceleration applied to each particle. Makes particle accelerate away fro
- :ref:`Curve<class_Curve>` **radial_accel_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Each particle's radial acceleration will vary along this :ref:`Curve<class_Curve>`.
@@ -1057,13 +1069,11 @@ Initial scale applied to each particle.
- :ref:`Curve<class_Curve>` **scale_amount_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Each particle's scale will vary along this :ref:`Curve<class_Curve>`.
@@ -1127,13 +1137,11 @@ Tangential acceleration applied to each particle. Tangential acceleration is per
- :ref:`Curve<class_Curve>` **tangential_accel_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Each particle's tangential acceleration will vary along this :ref:`Curve<class_Curve>`.
@@ -1160,9 +1168,41 @@ Method Descriptions
Sets this node's properties to match a given :ref:`Particles<class_Particles>` node with an assigned :ref:`ParticlesMaterial<class_ParticlesMaterial>`.
.. _class_CPUParticles_method_get_param:
- :ref:`float<class_float>` **get_param** **(** :ref:`Parameter<enum_CPUParticles_Parameter>` param **)** const
.. _class_CPUParticles_method_get_param_curve:
- :ref:`Curve<class_Curve>` **get_param_curve** **(** :ref:`Parameter<enum_CPUParticles_Parameter>` param **)** const
.. _class_CPUParticles_method_get_param_randomness:
- :ref:`float<class_float>` **get_param_randomness** **(** :ref:`Parameter<enum_CPUParticles_Parameter>` param **)** const
.. _class_CPUParticles_method_get_particle_flag:
- :ref:`bool<class_bool>` **get_particle_flag** **(** :ref:`Flags<enum_CPUParticles_Flags>` flag **)** const
.. _class_CPUParticles_method_restart:
- void **restart** **(** **)**
Restarts the particle emitter.
.. _class_CPUParticles_method_set_param:
- void **set_param** **(** :ref:`Parameter<enum_CPUParticles_Parameter>` param, :ref:`float<class_float>` value **)**
.. _class_CPUParticles_method_set_param_curve:
- void **set_param_curve** **(** :ref:`Parameter<enum_CPUParticles_Parameter>` param, :ref:`Curve<class_Curve>` curve **)**
.. _class_CPUParticles_method_set_param_randomness:
- void **set_param_randomness** **(** :ref:`Parameter<enum_CPUParticles_Parameter>` param, :ref:`float<class_float>` randomness **)**
.. _class_CPUParticles_method_set_particle_flag:
- void **set_particle_flag** **(** :ref:`Flags<enum_CPUParticles_Flags>` flag, :ref:`bool<class_bool>` enable **)**

View File

@@ -24,35 +24,35 @@ Properties
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`angle<class_CPUParticles2D_property_angle>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`Curve<class_Curve>` | :ref:`angle_curve<class_CPUParticles2D_property_angle_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`angle_curve<class_CPUParticles2D_property_angle_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`angle_random<class_CPUParticles2D_property_angle_random>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`angular_velocity<class_CPUParticles2D_property_angular_velocity>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`Curve<class_Curve>` | :ref:`angular_velocity_curve<class_CPUParticles2D_property_angular_velocity_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`angular_velocity_curve<class_CPUParticles2D_property_angular_velocity_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`angular_velocity_random<class_CPUParticles2D_property_angular_velocity_random>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`anim_offset<class_CPUParticles2D_property_anim_offset>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`Curve<class_Curve>` | :ref:`anim_offset_curve<class_CPUParticles2D_property_anim_offset_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`anim_offset_curve<class_CPUParticles2D_property_anim_offset_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`anim_offset_random<class_CPUParticles2D_property_anim_offset_random>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`anim_speed<class_CPUParticles2D_property_anim_speed>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`Curve<class_Curve>` | :ref:`anim_speed_curve<class_CPUParticles2D_property_anim_speed_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`anim_speed_curve<class_CPUParticles2D_property_anim_speed_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`anim_speed_random<class_CPUParticles2D_property_anim_speed_random>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`Color<class_Color>` | :ref:`color<class_CPUParticles2D_property_color>` | Color( 1, 1, 1, 1 ) |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`Gradient<class_Gradient>` | :ref:`color_ramp<class_CPUParticles2D_property_color_ramp>` | null |
| :ref:`Gradient<class_Gradient>` | :ref:`color_ramp<class_CPUParticles2D_property_color_ramp>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`damping<class_CPUParticles2D_property_damping>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`Curve<class_Curve>` | :ref:`damping_curve<class_CPUParticles2D_property_damping_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`damping_curve<class_CPUParticles2D_property_damping_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`damping_random<class_CPUParticles2D_property_damping_random>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
@@ -88,7 +88,7 @@ Properties
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`hue_variation<class_CPUParticles2D_property_hue_variation>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`Curve<class_Curve>` | :ref:`hue_variation_curve<class_CPUParticles2D_property_hue_variation_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`hue_variation_curve<class_CPUParticles2D_property_hue_variation_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`hue_variation_random<class_CPUParticles2D_property_hue_variation_random>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
@@ -98,21 +98,23 @@ Properties
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`lifetime<class_CPUParticles2D_property_lifetime>` | 1.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`lifetime_randomness<class_CPUParticles2D_property_lifetime_randomness>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`linear_accel<class_CPUParticles2D_property_linear_accel>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`Curve<class_Curve>` | :ref:`linear_accel_curve<class_CPUParticles2D_property_linear_accel_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`linear_accel_curve<class_CPUParticles2D_property_linear_accel_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`linear_accel_random<class_CPUParticles2D_property_linear_accel_random>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`bool<class_bool>` | :ref:`local_coords<class_CPUParticles2D_property_local_coords>` | true |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`Texture<class_Texture>` | :ref:`normalmap<class_CPUParticles2D_property_normalmap>` | null |
| :ref:`Texture<class_Texture>` | :ref:`normalmap<class_CPUParticles2D_property_normalmap>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`bool<class_bool>` | :ref:`one_shot<class_CPUParticles2D_property_one_shot>` | false |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`orbit_velocity<class_CPUParticles2D_property_orbit_velocity>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`Curve<class_Curve>` | :ref:`orbit_velocity_curve<class_CPUParticles2D_property_orbit_velocity_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`orbit_velocity_curve<class_CPUParticles2D_property_orbit_velocity_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`orbit_velocity_random<class_CPUParticles2D_property_orbit_velocity_random>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
@@ -120,7 +122,7 @@ Properties
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`radial_accel<class_CPUParticles2D_property_radial_accel>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`Curve<class_Curve>` | :ref:`radial_accel_curve<class_CPUParticles2D_property_radial_accel_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`radial_accel_curve<class_CPUParticles2D_property_radial_accel_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`radial_accel_random<class_CPUParticles2D_property_radial_accel_random>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
@@ -128,7 +130,7 @@ Properties
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`scale_amount<class_CPUParticles2D_property_scale_amount>` | 1.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`Curve<class_Curve>` | :ref:`scale_amount_curve<class_CPUParticles2D_property_scale_amount_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`scale_amount_curve<class_CPUParticles2D_property_scale_amount_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`scale_amount_random<class_CPUParticles2D_property_scale_amount_random>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
@@ -138,21 +140,37 @@ Properties
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`tangential_accel<class_CPUParticles2D_property_tangential_accel>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`Curve<class_Curve>` | :ref:`tangential_accel_curve<class_CPUParticles2D_property_tangential_accel_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`tangential_accel_curve<class_CPUParticles2D_property_tangential_accel_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`tangential_accel_random<class_CPUParticles2D_property_tangential_accel_random>` | 0.0 |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
| :ref:`Texture<class_Texture>` | :ref:`texture<class_CPUParticles2D_property_texture>` | null |
| :ref:`Texture<class_Texture>` | :ref:`texture<class_CPUParticles2D_property_texture>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
Methods
-------
+------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`convert_from_particles<class_CPUParticles2D_method_convert_from_particles>` **(** :ref:`Node<class_Node>` particles **)** |
+------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`restart<class_CPUParticles2D_method_restart>` **(** **)** |
+------+---------------------------------------------------------------------------------------------------------------------------------+
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`convert_from_particles<class_CPUParticles2D_method_convert_from_particles>` **(** :ref:`Node<class_Node>` particles **)** |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param<class_CPUParticles2D_method_get_param>` **(** :ref:`Parameter<enum_CPUParticles2D_Parameter>` param **)** const |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>` | :ref:`get_param_curve<class_CPUParticles2D_method_get_param_curve>` **(** :ref:`Parameter<enum_CPUParticles2D_Parameter>` param **)** const |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param_randomness<class_CPUParticles2D_method_get_param_randomness>` **(** :ref:`Parameter<enum_CPUParticles2D_Parameter>` param **)** const |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_particle_flag<class_CPUParticles2D_method_get_particle_flag>` **(** :ref:`Flags<enum_CPUParticles2D_Flags>` flag **)** const |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`restart<class_CPUParticles2D_method_restart>` **(** **)** |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param<class_CPUParticles2D_method_set_param>` **(** :ref:`Parameter<enum_CPUParticles2D_Parameter>` param, :ref:`float<class_float>` value **)** |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param_curve<class_CPUParticles2D_method_set_param_curve>` **(** :ref:`Parameter<enum_CPUParticles2D_Parameter>` param, :ref:`Curve<class_Curve>` curve **)** |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>` **(** :ref:`Parameter<enum_CPUParticles2D_Parameter>` param, :ref:`float<class_float>` randomness **)** |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_particle_flag<class_CPUParticles2D_method_set_particle_flag>` **(** :ref:`Flags<enum_CPUParticles2D_Flags>` flag, :ref:`bool<class_bool>` enable **)** |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
@@ -199,29 +217,29 @@ enum **DrawOrder**:
enum **Parameter**:
- **PARAM_INITIAL_LINEAR_VELOCITY** = **0** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles2D_method_set_param_texture>` to set initial velocity properties.
- **PARAM_INITIAL_LINEAR_VELOCITY** = **0** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles2D_method_set_param_curve>` to set initial velocity properties.
- **PARAM_ANGULAR_VELOCITY** = **1** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles2D_method_set_param_texture>` to set angular velocity properties.
- **PARAM_ANGULAR_VELOCITY** = **1** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles2D_method_set_param_curve>` to set angular velocity properties.
- **PARAM_ORBIT_VELOCITY** = **2** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles2D_method_set_param_texture>` to set orbital velocity properties.
- **PARAM_ORBIT_VELOCITY** = **2** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles2D_method_set_param_curve>` to set orbital velocity properties.
- **PARAM_LINEAR_ACCEL** = **3** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles2D_method_set_param_texture>` to set linear acceleration properties.
- **PARAM_LINEAR_ACCEL** = **3** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles2D_method_set_param_curve>` to set linear acceleration properties.
- **PARAM_RADIAL_ACCEL** = **4** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles2D_method_set_param_texture>` to set radial acceleration properties.
- **PARAM_RADIAL_ACCEL** = **4** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles2D_method_set_param_curve>` to set radial acceleration properties.
- **PARAM_TANGENTIAL_ACCEL** = **5** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles2D_method_set_param_texture>` to set tangential acceleration properties.
- **PARAM_TANGENTIAL_ACCEL** = **5** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles2D_method_set_param_curve>` to set tangential acceleration properties.
- **PARAM_DAMPING** = **6** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles2D_method_set_param_texture>` to set damping properties.
- **PARAM_DAMPING** = **6** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles2D_method_set_param_curve>` to set damping properties.
- **PARAM_ANGLE** = **7** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles2D_method_set_param_texture>` to set angle properties.
- **PARAM_ANGLE** = **7** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles2D_method_set_param_curve>` to set angle properties.
- **PARAM_SCALE** = **8** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles2D_method_set_param_texture>` to set scale properties.
- **PARAM_SCALE** = **8** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles2D_method_set_param_curve>` to set scale properties.
- **PARAM_HUE_VARIATION** = **9** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles2D_method_set_param_texture>` to set hue variation properties.
- **PARAM_HUE_VARIATION** = **9** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles2D_method_set_param_curve>` to set hue variation properties.
- **PARAM_ANIM_SPEED** = **10** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles2D_method_set_param_texture>` to set animation speed properties.
- **PARAM_ANIM_SPEED** = **10** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles2D_method_set_param_curve>` to set animation speed properties.
- **PARAM_ANIM_OFFSET** = **11** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles2D_method_set_param_texture>` to set animation offset properties.
- **PARAM_ANIM_OFFSET** = **11** --- Use with :ref:`set_param<class_CPUParticles2D_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles2D_method_set_param_randomness>`, and :ref:`set_param_curve<class_CPUParticles2D_method_set_param_curve>` to set animation offset properties.
- **PARAM_MAX** = **12** --- Represents the size of the :ref:`Parameter<enum_CPUParticles2D_Parameter>` enum.
@@ -237,7 +255,7 @@ enum **Parameter**:
enum **Flags**:
- **FLAG_ALIGN_Y_TO_VELOCITY** = **0** --- Use with :ref:`set_flag<class_CPUParticles2D_method_set_flag>` to set :ref:`flag_align_y<class_CPUParticles2D_property_flag_align_y>`.
- **FLAG_ALIGN_Y_TO_VELOCITY** = **0** --- Use with :ref:`set_particle_flag<class_CPUParticles2D_method_set_particle_flag>` to set :ref:`flag_align_y<class_CPUParticles2D_property_flag_align_y>`.
- **FLAG_ROTATE_Y** = **1** --- Present for consistency with 3D particle nodes, not used in 2D.
@@ -316,13 +334,11 @@ Initial rotation applied to each particle, in degrees.
- :ref:`Curve<class_Curve>` **angle_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Each particle's rotation will be animated along this :ref:`Curve<class_Curve>`.
@@ -358,13 +374,11 @@ Initial angular velocity applied to each particle. Sets the speed of rotation of
- :ref:`Curve<class_Curve>` **angular_velocity_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Each particle's angular velocity will vary along this :ref:`Curve<class_Curve>`.
@@ -400,13 +414,11 @@ Particle animation offset.
- :ref:`Curve<class_Curve>` **anim_offset_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Each particle's animation offset will vary along this :ref:`Curve<class_Curve>`.
@@ -442,13 +454,11 @@ Particle animation speed.
- :ref:`Curve<class_Curve>` **anim_speed_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Each particle's animation speed will vary along this :ref:`Curve<class_Curve>`.
@@ -484,13 +494,11 @@ Each particle's initial color. If :ref:`texture<class_CPUParticles2D_property_te
- :ref:`Gradient<class_Gradient>` **color_ramp**
+-----------+-----------------------+
| *Default* | null |
+-----------+-----------------------+
| *Setter* | set_color_ramp(value) |
+-----------+-----------------------+
| *Getter* | get_color_ramp() |
+-----------+-----------------------+
+----------+-----------------------+
| *Setter* | set_color_ramp(value) |
+----------+-----------------------+
| *Getter* | get_color_ramp() |
+----------+-----------------------+
Each particle's color will vary along this :ref:`Gradient<class_Gradient>`.
@@ -512,13 +520,11 @@ The rate at which particles lose velocity.
- :ref:`Curve<class_Curve>` **damping_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Damping will vary along this :ref:`Curve<class_Curve>`.
@@ -746,13 +752,11 @@ Initial hue variation applied to each particle.
- :ref:`Curve<class_Curve>` **hue_variation_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Each particle's hue will vary along this :ref:`Curve<class_Curve>`.
@@ -812,6 +816,20 @@ Initial velocity randomness ratio.
Amount of time each particle will exist.
.. _class_CPUParticles2D_property_lifetime_randomness:
- :ref:`float<class_float>` **lifetime_randomness**
+-----------+--------------------------------+
| *Default* | 0.0 |
+-----------+--------------------------------+
| *Setter* | set_lifetime_randomness(value) |
+-----------+--------------------------------+
| *Getter* | get_lifetime_randomness() |
+-----------+--------------------------------+
Particle lifetime randomness ratio.
.. _class_CPUParticles2D_property_linear_accel:
- :ref:`float<class_float>` **linear_accel**
@@ -830,13 +848,11 @@ Linear acceleration applied to each particle in the direction of motion.
- :ref:`Curve<class_Curve>` **linear_accel_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Each particle's linear acceleration will vary along this :ref:`Curve<class_Curve>`.
@@ -872,13 +888,11 @@ If ``true``, particles use the parent node's coordinate space. If ``false``, the
- :ref:`Texture<class_Texture>` **normalmap**
+-----------+----------------------+
| *Default* | null |
+-----------+----------------------+
| *Setter* | set_normalmap(value) |
+-----------+----------------------+
| *Getter* | get_normalmap() |
+-----------+----------------------+
+----------+----------------------+
| *Setter* | set_normalmap(value) |
+----------+----------------------+
| *Getter* | get_normalmap() |
+----------+----------------------+
Normal map to be used for the :ref:`texture<class_CPUParticles2D_property_texture>` property.
@@ -914,13 +928,11 @@ Orbital velocity applied to each particle. Makes the particles circle around ori
- :ref:`Curve<class_Curve>` **orbit_velocity_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Each particle's orbital velocity will vary along this :ref:`Curve<class_Curve>`.
@@ -970,13 +982,11 @@ Radial acceleration applied to each particle. Makes particle accelerate away fro
- :ref:`Curve<class_Curve>` **radial_accel_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Each particle's radial acceleration will vary along this :ref:`Curve<class_Curve>`.
@@ -1026,13 +1036,11 @@ Initial scale applied to each particle.
- :ref:`Curve<class_Curve>` **scale_amount_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Each particle's scale will vary along this :ref:`Curve<class_Curve>`.
@@ -1096,13 +1104,11 @@ Tangential acceleration applied to each particle. Tangential acceleration is per
- :ref:`Curve<class_Curve>` **tangential_accel_curve**
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_param_curve(value) |
+-----------+------------------------+
| *Getter* | get_param_curve() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
Each particle's tangential acceleration will vary along this :ref:`Curve<class_Curve>`.
@@ -1124,13 +1130,11 @@ Tangential acceleration randomness ratio.
- :ref:`Texture<class_Texture>` **texture**
+-----------+--------------------+
| *Default* | null |
+-----------+--------------------+
| *Setter* | set_texture(value) |
+-----------+--------------------+
| *Getter* | get_texture() |
+-----------+--------------------+
+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture() |
+----------+--------------------+
Particle texture. If ``null``, particles will be squares.
@@ -1143,9 +1147,41 @@ Method Descriptions
Sets this node's properties to match a given :ref:`Particles2D<class_Particles2D>` node with an assigned :ref:`ParticlesMaterial<class_ParticlesMaterial>`.
.. _class_CPUParticles2D_method_get_param:
- :ref:`float<class_float>` **get_param** **(** :ref:`Parameter<enum_CPUParticles2D_Parameter>` param **)** const
.. _class_CPUParticles2D_method_get_param_curve:
- :ref:`Curve<class_Curve>` **get_param_curve** **(** :ref:`Parameter<enum_CPUParticles2D_Parameter>` param **)** const
.. _class_CPUParticles2D_method_get_param_randomness:
- :ref:`float<class_float>` **get_param_randomness** **(** :ref:`Parameter<enum_CPUParticles2D_Parameter>` param **)** const
.. _class_CPUParticles2D_method_get_particle_flag:
- :ref:`bool<class_bool>` **get_particle_flag** **(** :ref:`Flags<enum_CPUParticles2D_Flags>` flag **)** const
.. _class_CPUParticles2D_method_restart:
- void **restart** **(** **)**
Restarts the particle emitter.
.. _class_CPUParticles2D_method_set_param:
- void **set_param** **(** :ref:`Parameter<enum_CPUParticles2D_Parameter>` param, :ref:`float<class_float>` value **)**
.. _class_CPUParticles2D_method_set_param_curve:
- void **set_param_curve** **(** :ref:`Parameter<enum_CPUParticles2D_Parameter>` param, :ref:`Curve<class_Curve>` curve **)**
.. _class_CPUParticles2D_method_set_param_randomness:
- void **set_param_randomness** **(** :ref:`Parameter<enum_CPUParticles2D_Parameter>` param, :ref:`float<class_float>` randomness **)**
.. _class_CPUParticles2D_method_set_particle_flag:
- void **set_particle_flag** **(** :ref:`Flags<enum_CPUParticles2D_Flags>` flag, :ref:`bool<class_bool>` enable **)**

View File

@@ -19,15 +19,15 @@ A CSG Box shape.
Properties
----------
+---------------------------------+-------------------------------------------------+------+
| :ref:`float<class_float>` | :ref:`depth<class_CSGBox_property_depth>` | 2.0 |
+---------------------------------+-------------------------------------------------+------+
| :ref:`float<class_float>` | :ref:`height<class_CSGBox_property_height>` | 2.0 |
+---------------------------------+-------------------------------------------------+------+
| :ref:`Material<class_Material>` | :ref:`material<class_CSGBox_property_material>` | null |
+---------------------------------+-------------------------------------------------+------+
| :ref:`float<class_float>` | :ref:`width<class_CSGBox_property_width>` | 2.0 |
+---------------------------------+-------------------------------------------------+------+
+---------------------------------+-------------------------------------------------+-----+
| :ref:`float<class_float>` | :ref:`depth<class_CSGBox_property_depth>` | 2.0 |
+---------------------------------+-------------------------------------------------+-----+
| :ref:`float<class_float>` | :ref:`height<class_CSGBox_property_height>` | 2.0 |
+---------------------------------+-------------------------------------------------+-----+
| :ref:`Material<class_Material>` | :ref:`material<class_CSGBox_property_material>` | |
+---------------------------------+-------------------------------------------------+-----+
| :ref:`float<class_float>` | :ref:`width<class_CSGBox_property_width>` | 2.0 |
+---------------------------------+-------------------------------------------------+-----+
Description
-----------
@@ -69,13 +69,11 @@ Height of the box measured from the center of the box.
- :ref:`Material<class_Material>` **material**
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_material(value) |
+-----------+---------------------+
| *Getter* | get_material() |
+-----------+---------------------+
+----------+---------------------+
| *Setter* | set_material(value) |
+----------+---------------------+
| *Getter* | get_material() |
+----------+---------------------+
The material used to render the box.

View File

@@ -24,7 +24,7 @@ Properties
+---------------------------------+--------------------------------------------------------------+-------+
| :ref:`float<class_float>` | :ref:`height<class_CSGCylinder_property_height>` | 1.0 |
+---------------------------------+--------------------------------------------------------------+-------+
| :ref:`Material<class_Material>` | :ref:`material<class_CSGCylinder_property_material>` | null |
| :ref:`Material<class_Material>` | :ref:`material<class_CSGCylinder_property_material>` | |
+---------------------------------+--------------------------------------------------------------+-------+
| :ref:`float<class_float>` | :ref:`radius<class_CSGCylinder_property_radius>` | 1.0 |
+---------------------------------+--------------------------------------------------------------+-------+
@@ -73,13 +73,11 @@ The height of the cylinder.
- :ref:`Material<class_Material>` **material**
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_material(value) |
+-----------+---------------------+
| *Getter* | get_material() |
+-----------+---------------------+
+----------+---------------------+
| *Setter* | set_material(value) |
+----------+---------------------+
| *Getter* | get_material() |
+----------+---------------------+
The material used to render the cylinder.

View File

@@ -19,11 +19,11 @@ A CSG Mesh shape that uses a mesh resource.
Properties
----------
+---------------------------------+--------------------------------------------------+------+
| :ref:`Material<class_Material>` | :ref:`material<class_CSGMesh_property_material>` | null |
+---------------------------------+--------------------------------------------------+------+
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_CSGMesh_property_mesh>` | null |
+---------------------------------+--------------------------------------------------+------+
+---------------------------------+--------------------------------------------------+
| :ref:`Material<class_Material>` | :ref:`material<class_CSGMesh_property_material>` |
+---------------------------------+--------------------------------------------------+
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_CSGMesh_property_mesh>` |
+---------------------------------+--------------------------------------------------+
Description
-----------
@@ -37,25 +37,21 @@ Property Descriptions
- :ref:`Material<class_Material>` **material**
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_material(value) |
+-----------+---------------------+
| *Getter* | get_material() |
+-----------+---------------------+
+----------+---------------------+
| *Setter* | set_material(value) |
+----------+---------------------+
| *Getter* | get_material() |
+----------+---------------------+
.. _class_CSGMesh_property_mesh:
- :ref:`Mesh<class_Mesh>` **mesh**
+-----------+-----------------+
| *Default* | null |
+-----------+-----------------+
| *Setter* | set_mesh(value) |
+-----------+-----------------+
| *Getter* | get_mesh() |
+-----------+-----------------+
+----------+-----------------+
| *Setter* | set_mesh(value) |
+----------+-----------------+
| *Getter* | get_mesh() |
+----------+-----------------+
The mesh resource to use as a CSG shape.

View File

@@ -22,7 +22,7 @@ Properties
+---------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------+
| :ref:`float<class_float>` | :ref:`depth<class_CSGPolygon_property_depth>` | 1.0 |
+---------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------+
| :ref:`Material<class_Material>` | :ref:`material<class_CSGPolygon_property_material>` | null |
| :ref:`Material<class_Material>` | :ref:`material<class_CSGPolygon_property_material>` | |
+---------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------+
| :ref:`Mode<enum_CSGPolygon_Mode>` | :ref:`mode<class_CSGPolygon_property_mode>` | 0 |
+---------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------+
@@ -108,13 +108,11 @@ Extrusion depth when :ref:`mode<class_CSGPolygon_property_mode>` is :ref:`MODE_D
- :ref:`Material<class_Material>` **material**
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_material(value) |
+-----------+---------------------+
| *Getter* | get_material() |
+-----------+---------------------+
+----------+---------------------+
| *Setter* | set_material(value) |
+----------+---------------------+
| *Getter* | get_material() |
+----------+---------------------+
Material to use for the resulting mesh.

View File

@@ -69,7 +69,7 @@ enum **Operation**:
- **OPERATION_INTERSECTION** = **1** --- Only intersecting geometry remains, the rest is removed.
- **OPERATION_SUBTRACTION** = **2** --- The second shape is susbtracted from the first, leaving a dent with it's shape.
- **OPERATION_SUBTRACTION** = **2** --- The second shape is subtracted from the first, leaving a dent with its shape.
Description
-----------

View File

@@ -20,7 +20,7 @@ Properties
----------
+---------------------------------+------------------------------------------------------------------+------+
| :ref:`Material<class_Material>` | :ref:`material<class_CSGSphere_property_material>` | null |
| :ref:`Material<class_Material>` | :ref:`material<class_CSGSphere_property_material>` | |
+---------------------------------+------------------------------------------------------------------+------+
| :ref:`int<class_int>` | :ref:`radial_segments<class_CSGSphere_property_radial_segments>` | 12 |
+---------------------------------+------------------------------------------------------------------+------+
@@ -43,13 +43,11 @@ Property Descriptions
- :ref:`Material<class_Material>` **material**
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_material(value) |
+-----------+---------------------+
| *Getter* | get_material() |
+-----------+---------------------+
+----------+---------------------+
| *Setter* | set_material(value) |
+----------+---------------------+
| *Getter* | get_material() |
+----------+---------------------+
The material used to render the sphere.

View File

@@ -22,7 +22,7 @@ Properties
+---------------------------------+-----------------------------------------------------------+------+
| :ref:`float<class_float>` | :ref:`inner_radius<class_CSGTorus_property_inner_radius>` | 2.0 |
+---------------------------------+-----------------------------------------------------------+------+
| :ref:`Material<class_Material>` | :ref:`material<class_CSGTorus_property_material>` | null |
| :ref:`Material<class_Material>` | :ref:`material<class_CSGTorus_property_material>` | |
+---------------------------------+-----------------------------------------------------------+------+
| :ref:`float<class_float>` | :ref:`outer_radius<class_CSGTorus_property_outer_radius>` | 3.0 |
+---------------------------------+-----------------------------------------------------------+------+
@@ -59,13 +59,11 @@ The inner radius of the torus.
- :ref:`Material<class_Material>` **material**
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_material(value) |
+-----------+---------------------+
| *Getter* | get_material() |
+-----------+---------------------+
+----------+---------------------+
| *Setter* | set_material(value) |
+----------+---------------------+
| *Getter* | get_material() |
+----------+---------------------+
The material used to render the torus.

View File

@@ -20,7 +20,7 @@ Properties
----------
+---------------------------+-------------------------------------------------+------+
| :ref:`Curve<class_Curve>` | :ref:`curve<class_CurveTexture_property_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`curve<class_CurveTexture_property_curve>` | |
+---------------------------+-------------------------------------------------+------+
| :ref:`int<class_int>` | :ref:`width<class_CurveTexture_property_width>` | 2048 |
+---------------------------+-------------------------------------------------+------+
@@ -37,13 +37,11 @@ Property Descriptions
- :ref:`Curve<class_Curve>` **curve**
+-----------+------------------+
| *Default* | null |
+-----------+------------------+
| *Setter* | set_curve(value) |
+-----------+------------------+
| *Getter* | get_curve() |
+-----------+------------------+
+----------+------------------+
| *Setter* | set_curve(value) |
+----------+------------------+
| *Getter* | get_curve() |
+----------+------------------+
The ``curve`` rendered onto the texture.

View File

@@ -28,7 +28,7 @@ Properties
+-----------------------------------------------+------------------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>` | :ref:`extra_spacing_top<class_DynamicFont_property_extra_spacing_top>` | 0 |
+-----------------------------------------------+------------------------------------------------------------------------------+---------------------+
| :ref:`DynamicFontData<class_DynamicFontData>` | :ref:`font_data<class_DynamicFont_property_font_data>` | null |
| :ref:`DynamicFontData<class_DynamicFontData>` | :ref:`font_data<class_DynamicFont_property_font_data>` | |
+-----------------------------------------------+------------------------------------------------------------------------------+---------------------+
| :ref:`Color<class_Color>` | :ref:`outline_color<class_DynamicFont_property_outline_color>` | Color( 1, 1, 1, 1 ) |
+-----------------------------------------------+------------------------------------------------------------------------------+---------------------+
@@ -51,10 +51,14 @@ Methods
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_fallback_count<class_DynamicFont_method_get_fallback_count>` **(** **)** const |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_spacing<class_DynamicFont_method_get_spacing>` **(** :ref:`int<class_int>` type **)** const |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_fallback<class_DynamicFont_method_remove_fallback>` **(** :ref:`int<class_int>` idx **)** |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_fallback<class_DynamicFont_method_set_fallback>` **(** :ref:`int<class_int>` idx, :ref:`DynamicFontData<class_DynamicFontData>` data **)** |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_spacing<class_DynamicFont_method_set_spacing>` **(** :ref:`int<class_int>` type, :ref:`int<class_int>` value **)** |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
@@ -154,13 +158,11 @@ Extra spacing at the top in pixels.
- :ref:`DynamicFontData<class_DynamicFontData>` **font_data**
+-----------+----------------------+
| *Default* | null |
+-----------+----------------------+
| *Setter* | set_font_data(value) |
+-----------+----------------------+
| *Getter* | get_font_data() |
+-----------+----------------------+
+----------+----------------------+
| *Setter* | set_font_data(value) |
+----------+----------------------+
| *Getter* | get_font_data() |
+----------+----------------------+
The font data.
@@ -251,6 +253,10 @@ Returns the fallback font at index ``idx``.
Returns the number of fallback fonts.
.. _class_DynamicFont_method_get_spacing:
- :ref:`int<class_int>` **get_spacing** **(** :ref:`int<class_int>` type **)** const
.. _class_DynamicFont_method_remove_fallback:
- void **remove_fallback** **(** :ref:`int<class_int>` idx **)**
@@ -263,3 +269,7 @@ Removes the fallback font at index ``idx``.
Sets the fallback font at index ``idx``.
.. _class_DynamicFont_method_set_spacing:
- void **set_spacing** **(** :ref:`int<class_int>` type, :ref:`int<class_int>` value **)**

View File

@@ -22,7 +22,7 @@ Properties
+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+
| :ref:`float<class_float>` | :ref:`adjustment_brightness<class_Environment_property_adjustment_brightness>` | 1.0 |
+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`adjustment_color_correction<class_Environment_property_adjustment_color_correction>` | null |
| :ref:`Texture<class_Texture>` | :ref:`adjustment_color_correction<class_Environment_property_adjustment_color_correction>` | |
+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+
| :ref:`float<class_float>` | :ref:`adjustment_contrast<class_Environment_property_adjustment_contrast>` | 1.0 |
+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+
@@ -56,7 +56,7 @@ Properties
+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+
| :ref:`BGMode<enum_Environment_BGMode>` | :ref:`background_mode<class_Environment_property_background_mode>` | 0 |
+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+
| :ref:`Sky<class_Sky>` | :ref:`background_sky<class_Environment_property_background_sky>` | null |
| :ref:`Sky<class_Sky>` | :ref:`background_sky<class_Environment_property_background_sky>` | |
+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+
| :ref:`float<class_float>` | :ref:`background_sky_custom_fov<class_Environment_property_background_sky_custom_fov>` | 0.0 |
+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+
@@ -189,6 +189,15 @@ Properties
| :ref:`float<class_float>` | :ref:`tonemap_white<class_Environment_property_tonemap_white>` | 1.0 |
+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+
Methods
-------
+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_glow_level_enabled<class_Environment_method_is_glow_level_enabled>` **(** :ref:`int<class_int>` idx **)** const |
+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_glow_level<class_Environment_method_set_glow_level>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enabled **)** |
+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
@@ -361,13 +370,11 @@ Global brightness value of the rendered scene (default value is 1).
- :ref:`Texture<class_Texture>` **adjustment_color_correction**
+-----------+----------------------------------------+
| *Default* | null |
+-----------+----------------------------------------+
| *Setter* | set_adjustment_color_correction(value) |
+-----------+----------------------------------------+
| *Getter* | get_adjustment_color_correction() |
+-----------+----------------------------------------+
+----------+----------------------------------------+
| *Setter* | set_adjustment_color_correction(value) |
+----------+----------------------------------------+
| *Getter* | get_adjustment_color_correction() |
+----------+----------------------------------------+
Applies the provided :ref:`Texture<class_Texture>` resource to affect the global color aspect of the rendered scene.
@@ -599,13 +606,11 @@ Defines the mode of background.
- :ref:`Sky<class_Sky>` **background_sky**
+-----------+----------------+
| *Default* | null |
+-----------+----------------+
| *Setter* | set_sky(value) |
+-----------+----------------+
| *Getter* | get_sky() |
+-----------+----------------+
+----------+----------------+
| *Setter* | set_sky(value) |
+----------+----------------+
| *Getter* | get_sky() |
+----------+----------------+
:ref:`Sky<class_Sky>` resource defined as background.
@@ -1477,3 +1482,14 @@ Tonemapping mode.
White reference value for tonemap.
Method Descriptions
-------------------
.. _class_Environment_method_is_glow_level_enabled:
- :ref:`bool<class_bool>` **is_glow_level_enabled** **(** :ref:`int<class_int>` idx **)** const
.. _class_Environment_method_set_glow_level:
- void **set_glow_level** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enabled **)**

View File

@@ -19,9 +19,9 @@ Brief Description
Properties
----------
+-----------------------------------------------+-------------------------------------------------+------+
| :ref:`GDNativeLibrary<class_GDNativeLibrary>` | :ref:`library<class_GDNative_property_library>` | null |
+-----------------------------------------------+-------------------------------------------------+------+
+-----------------------------------------------+-------------------------------------------------+
| :ref:`GDNativeLibrary<class_GDNativeLibrary>` | :ref:`library<class_GDNative_property_library>` |
+-----------------------------------------------+-------------------------------------------------+
Methods
-------
@@ -41,13 +41,11 @@ Property Descriptions
- :ref:`GDNativeLibrary<class_GDNativeLibrary>` **library**
+-----------+--------------------+
| *Default* | null |
+-----------+--------------------+
| *Setter* | set_library(value) |
+-----------+--------------------+
| *Getter* | get_library() |
+-----------+--------------------+
+----------+--------------------+
| *Setter* | set_library(value) |
+----------+--------------------+
| *Getter* | get_library() |
+----------+--------------------+
Method Descriptions
-------------------

View File

@@ -191,6 +191,35 @@ Properties
| :ref:`int<class_int>` | :ref:`precision<class_Generic6DOFJoint_property_precision>` | 1 |
+---------------------------+---------------------------------------------------------------------------------------------------------------+-------+
Methods
-------
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_flag_x<class_Generic6DOFJoint_method_get_flag_x>` **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag **)** const |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_flag_y<class_Generic6DOFJoint_method_get_flag_y>` **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag **)** const |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_flag_z<class_Generic6DOFJoint_method_get_flag_z>` **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag **)** const |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param_x<class_Generic6DOFJoint_method_get_param_x>` **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param **)** const |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param_y<class_Generic6DOFJoint_method_get_param_y>` **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param **)** const |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param_z<class_Generic6DOFJoint_method_get_param_z>` **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param **)** const |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flag_x<class_Generic6DOFJoint_method_set_flag_x>` **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag, :ref:`bool<class_bool>` value **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flag_y<class_Generic6DOFJoint_method_set_flag_y>` **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag, :ref:`bool<class_bool>` value **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flag_z<class_Generic6DOFJoint_method_set_flag_z>` **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag, :ref:`bool<class_bool>` value **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param_x<class_Generic6DOFJoint_method_set_param_x>` **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param, :ref:`float<class_float>` value **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param_y<class_Generic6DOFJoint_method_set_param_y>` **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param, :ref:`float<class_float>` value **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param_z<class_Generic6DOFJoint_method_set_param_z>` **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param, :ref:`float<class_float>` value **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
@@ -1424,3 +1453,54 @@ The speed that the linear motor will attempt to reach on the Z axis.
| *Getter* | get_precision() |
+-----------+----------------------+
Method Descriptions
-------------------
.. _class_Generic6DOFJoint_method_get_flag_x:
- :ref:`bool<class_bool>` **get_flag_x** **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag **)** const
.. _class_Generic6DOFJoint_method_get_flag_y:
- :ref:`bool<class_bool>` **get_flag_y** **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag **)** const
.. _class_Generic6DOFJoint_method_get_flag_z:
- :ref:`bool<class_bool>` **get_flag_z** **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag **)** const
.. _class_Generic6DOFJoint_method_get_param_x:
- :ref:`float<class_float>` **get_param_x** **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param **)** const
.. _class_Generic6DOFJoint_method_get_param_y:
- :ref:`float<class_float>` **get_param_y** **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param **)** const
.. _class_Generic6DOFJoint_method_get_param_z:
- :ref:`float<class_float>` **get_param_z** **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param **)** const
.. _class_Generic6DOFJoint_method_set_flag_x:
- void **set_flag_x** **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag, :ref:`bool<class_bool>` value **)**
.. _class_Generic6DOFJoint_method_set_flag_y:
- void **set_flag_y** **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag, :ref:`bool<class_bool>` value **)**
.. _class_Generic6DOFJoint_method_set_flag_z:
- void **set_flag_z** **(** :ref:`Flag<enum_Generic6DOFJoint_Flag>` flag, :ref:`bool<class_bool>` value **)**
.. _class_Generic6DOFJoint_method_set_param_x:
- void **set_param_x** **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param, :ref:`float<class_float>` value **)**
.. _class_Generic6DOFJoint_method_set_param_y:
- void **set_param_y** **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param, :ref:`float<class_float>` value **)**
.. _class_Generic6DOFJoint_method_set_param_z:
- void **set_param_z** **(** :ref:`Param<enum_Generic6DOFJoint_Param>` param, :ref:`float<class_float>` value **)**

View File

@@ -34,7 +34,7 @@ Properties
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-------+
| :ref:`float<class_float>` | :ref:`lod_min_hysteresis<class_GeometryInstance_property_lod_min_hysteresis>` | 0.0 |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-------+
| :ref:`Material<class_Material>` | :ref:`material_override<class_GeometryInstance_property_material_override>` | null |
| :ref:`Material<class_Material>` | :ref:`material_override<class_GeometryInstance_property_material_override>` | |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`use_in_baked_light<class_GeometryInstance_property_use_in_baked_light>` | false |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-------+
@@ -42,9 +42,13 @@ Properties
Methods
-------
+------+----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_aabb<class_GeometryInstance_method_set_custom_aabb>` **(** :ref:`AABB<class_AABB>` aabb **)** |
+------+----------------------------------------------------------------------------------------------------------------+
+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_flag<class_GeometryInstance_method_get_flag>` **(** :ref:`Flags<enum_GeometryInstance_Flags>` flag **)** const |
+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_aabb<class_GeometryInstance_method_set_custom_aabb>` **(** :ref:`AABB<class_AABB>` aabb **)** |
+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flag<class_GeometryInstance_method_set_flag>` **(** :ref:`Flags<enum_GeometryInstance_Flags>` flag, :ref:`bool<class_bool>` value **)** |
+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
@@ -187,13 +191,11 @@ The GeometryInstance's min LOD margin.
- :ref:`Material<class_Material>` **material_override**
+-----------+------------------------------+
| *Default* | null |
+-----------+------------------------------+
| *Setter* | set_material_override(value) |
+-----------+------------------------------+
| *Getter* | get_material_override() |
+-----------+------------------------------+
+----------+------------------------------+
| *Setter* | set_material_override(value) |
+----------+------------------------------+
| *Getter* | get_material_override() |
+----------+------------------------------+
The material override for the whole geometry.
@@ -216,9 +218,17 @@ If ``true``, this GeometryInstance will be used when baking lights using a :ref:
Method Descriptions
-------------------
.. _class_GeometryInstance_method_get_flag:
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_GeometryInstance_Flags>` flag **)** const
.. _class_GeometryInstance_method_set_custom_aabb:
- void **set_custom_aabb** **(** :ref:`AABB<class_AABB>` aabb **)**
Overrides the bounding box of this node with a custom one. To remove it, set an :ref:`AABB<class_AABB>` with all fields set to zero.
.. _class_GeometryInstance_method_set_flag:
- void **set_flag** **(** :ref:`Flags<enum_GeometryInstance_Flags>` flag, :ref:`bool<class_bool>` value **)**

View File

@@ -24,7 +24,7 @@ Properties
+---------------------------------------+------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`compress<class_GIProbe_property_compress>` | false |
+---------------------------------------+------------------------------------------------------------+-----------------------+
| :ref:`GIProbeData<class_GIProbeData>` | :ref:`data<class_GIProbe_property_data>` | null |
| :ref:`GIProbeData<class_GIProbeData>` | :ref:`data<class_GIProbe_property_data>` | |
+---------------------------------------+------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>` | :ref:`dynamic_range<class_GIProbe_property_dynamic_range>` | 4 |
+---------------------------------------+------------------------------------------------------------+-----------------------+
@@ -113,13 +113,11 @@ Property Descriptions
- :ref:`GIProbeData<class_GIProbeData>` **data**
+-----------+-----------------------+
| *Default* | null |
+-----------+-----------------------+
| *Setter* | set_probe_data(value) |
+-----------+-----------------------+
| *Getter* | get_probe_data() |
+-----------+-----------------------+
+----------+-----------------------+
| *Setter* | set_probe_data(value) |
+----------+-----------------------+
| *Getter* | get_probe_data() |
+----------+-----------------------+
.. _class_GIProbe_property_dynamic_range:

View File

@@ -20,7 +20,7 @@ Properties
----------
+---------------------------------+----------------------------------------------------------+------+
| :ref:`Gradient<class_Gradient>` | :ref:`gradient<class_GradientTexture_property_gradient>` | null |
| :ref:`Gradient<class_Gradient>` | :ref:`gradient<class_GradientTexture_property_gradient>` | |
+---------------------------------+----------------------------------------------------------+------+
| :ref:`int<class_int>` | :ref:`width<class_GradientTexture_property_width>` | 2048 |
+---------------------------------+----------------------------------------------------------+------+
@@ -37,13 +37,11 @@ Property Descriptions
- :ref:`Gradient<class_Gradient>` **gradient**
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_gradient(value) |
+-----------+---------------------+
| *Getter* | get_gradient() |
+-----------+---------------------+
+----------+---------------------+
| *Setter* | set_gradient(value) |
+----------+---------------------+
| *Getter* | get_gradient() |
+----------+---------------------+
The :ref:`Gradient<class_Gradient>` that will be used to fill the texture.

View File

@@ -36,7 +36,7 @@ Properties
+---------------------------------------+------------------------------------------------------------------+--------------------+
| :ref:`int<class_int>` | :ref:`collision_mask<class_GridMap_property_collision_mask>` | 1 |
+---------------------------------------+------------------------------------------------------------------+--------------------+
| :ref:`MeshLibrary<class_MeshLibrary>` | :ref:`mesh_library<class_GridMap_property_mesh_library>` | null |
| :ref:`MeshLibrary<class_MeshLibrary>` | :ref:`mesh_library<class_GridMap_property_mesh_library>` | |
+---------------------------------------+------------------------------------------------------------------+--------------------+
| :ref:`MeshLibrary<class_MeshLibrary>` | :ref:`theme<class_GridMap_property_theme>` | |
+---------------------------------------+------------------------------------------------------------------+--------------------+
@@ -218,13 +218,11 @@ The dimensions of the grid's cells.
- :ref:`MeshLibrary<class_MeshLibrary>` **mesh_library**
+-----------+-------------------------+
| *Default* | null |
+-----------+-------------------------+
| *Setter* | set_mesh_library(value) |
+-----------+-------------------------+
| *Getter* | get_mesh_library() |
+-----------+-------------------------+
+----------+-------------------------+
| *Setter* | set_mesh_library(value) |
+----------+-------------------------+
| *Getter* | get_mesh_library() |
+----------+-------------------------+
The assigned :ref:`MeshLibrary<class_MeshLibrary>`.

View File

@@ -41,6 +41,19 @@ Properties
| :ref:`float<class_float>` | :ref:`params/bias<class_HingeJoint_property_params/bias>` | 0.3 |
+---------------------------+-------------------------------------------------------------------------------------+-------+
Methods
-------
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_flag<class_HingeJoint_method_get_flag>` **(** :ref:`Flag<enum_HingeJoint_Flag>` flag **)** const |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param<class_HingeJoint_method_get_param>` **(** :ref:`Param<enum_HingeJoint_Param>` param **)** const |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flag<class_HingeJoint_method_set_flag>` **(** :ref:`Flag<enum_HingeJoint_Flag>` flag, :ref:`bool<class_bool>` enabled **)** |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param<class_HingeJoint_method_set_param>` **(** :ref:`Param<enum_HingeJoint_Param>` param, :ref:`float<class_float>` value **)** |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
@@ -238,3 +251,22 @@ Target speed for the motor.
The speed with which the two bodies get pulled together when they move in different directions.
Method Descriptions
-------------------
.. _class_HingeJoint_method_get_flag:
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flag<enum_HingeJoint_Flag>` flag **)** const
.. _class_HingeJoint_method_get_param:
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_HingeJoint_Param>` param **)** const
.. _class_HingeJoint_method_set_flag:
- void **set_flag** **(** :ref:`Flag<enum_HingeJoint_Flag>` flag, :ref:`bool<class_bool>` enabled **)**
.. _class_HingeJoint_method_set_param:
- void **set_param** **(** :ref:`Param<enum_HingeJoint_Param>` param, :ref:`float<class_float>` value **)**

View File

@@ -26,6 +26,8 @@ Properties
+-----------------------------+--------------------------------------------------------------------+-------+
| :ref:`int<class_int>` | :ref:`max_redirects<class_HTTPRequest_property_max_redirects>` | 8 |
+-----------------------------+--------------------------------------------------------------------+-------+
| :ref:`int<class_int>` | :ref:`timeout<class_HTTPRequest_property_timeout>` | 0 |
+-----------------------------+--------------------------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`use_threads<class_HTTPRequest_property_use_threads>` | false |
+-----------------------------+--------------------------------------------------------------------+-------+
@@ -82,6 +84,8 @@ Enumerations
.. _class_HTTPRequest_constant_RESULT_REDIRECT_LIMIT_REACHED:
.. _class_HTTPRequest_constant_RESULT_TIMEOUT:
enum **Result**:
- **RESULT_SUCCESS** = **0** --- Request successful.
@@ -108,6 +112,8 @@ enum **Result**:
- **RESULT_REDIRECT_LIMIT_REACHED** = **11** --- Request reached its maximum redirect limit, see :ref:`max_redirects<class_HTTPRequest_property_max_redirects>`.
- **RESULT_TIMEOUT** = **12**
Description
-----------
@@ -165,6 +171,18 @@ The file to download into. Will output any received file into it.
Maximum number of allowed redirects.
.. _class_HTTPRequest_property_timeout:
- :ref:`int<class_int>` **timeout**
+-----------+--------------------+
| *Default* | 0 |
+-----------+--------------------+
| *Setter* | set_timeout(value) |
+-----------+--------------------+
| *Getter* | get_timeout() |
+-----------+--------------------+
.. _class_HTTPRequest_property_use_threads:
- :ref:`bool<class_bool>` **use_threads**

View File

@@ -19,9 +19,9 @@ Image datatype.
Properties
----------
+-------------------------------------+----------------------------------------+--------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`data<class_Image_property_data>` | { "data": PoolByteArray( ), "format": "Lum8", "height": 0, "mipmaps": false, "width": 0 } |
+-------------------------------------+----------------------------------------+--------------------------------------------------------------------------------------------+
+-------------------------------------+----------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`data<class_Image_property_data>` | {"data": PoolByteArray( ),"format": "Lum8","height": 0,"mipmaps": false,"width": 0} |
+-------------------------------------+----------------------------------------+--------------------------------------------------------------------------------------+
Methods
-------
@@ -418,9 +418,9 @@ Property Descriptions
- :ref:`Dictionary<class_Dictionary>` **data**
+-----------+--------------------------------------------------------------------------------------------+
| *Default* | { "data": PoolByteArray( ), "format": "Lum8", "height": 0, "mipmaps": false, "width": 0 } |
+-----------+--------------------------------------------------------------------------------------------+
+-----------+--------------------------------------------------------------------------------------+
| *Default* | {"data": PoolByteArray( ),"format": "Lum8","height": 0,"mipmaps": false,"width": 0} |
+-----------+--------------------------------------------------------------------------------------+
Holds all of the image's color data in a given format. See ``FORMAT_*`` constants.

View File

@@ -129,7 +129,7 @@ enum **MouseMode**:
- **MOUSE_MODE_HIDDEN** = **1** --- Makes the mouse cursor hidden if it is visible.
- **MOUSE_MODE_CAPTURED** = **2** --- Captures the mouse. The mouse will be hidden and unable to leave the game window, but it will still register movement and mouse button presses.
- **MOUSE_MODE_CAPTURED** = **2** --- Captures the mouse. The mouse will be hidden and unable to leave the game window, but it will still register movement and mouse button presses. On Windows and Linux, the mouse will use raw input mode, which means the reported movement will be unaffected by the OS' mouse acceleration settings.
- **MOUSE_MODE_CONFINED** = **3** --- Makes the mouse cursor visible but confines it to the game window.

View File

@@ -131,35 +131,35 @@ Methods
Theme Properties
----------------
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | bg | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | bg_focus | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | cursor | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | cursor_unfocused | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.627451, 0.627451, 0.627451, 1 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_selected | Color( 1, 1, 1, 1 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | guide_color | Color( 0, 0, 0, 0.1 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`int<class_int>` | hseparation | 4 |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`int<class_int>` | icon_margin | 4 |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`int<class_int>` | line_separation | 2 |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | selected | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | selected_focus | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`int<class_int>` | vseparation | 2 |
+---------------------------------+---------------------+------------------------------------------+
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | bg | |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | bg_focus | |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | cursor | |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | cursor_unfocused | |
+---------------------------------+---------------------+------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.63, 0.63, 0.63, 1 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_selected | Color( 1, 1, 1, 1 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | guide_color | Color( 0, 0, 0, 0.1 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`int<class_int>` | hseparation | 4 |
+---------------------------------+---------------------+------------------------------+
| :ref:`int<class_int>` | icon_margin | 4 |
+---------------------------------+---------------------+------------------------------+
| :ref:`int<class_int>` | line_separation | 2 |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | selected | |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | selected_focus | |
+---------------------------------+---------------------+------------------------------+
| :ref:`int<class_int>` | vseparation | 2 |
+---------------------------------+---------------------+------------------------------+
Signals
-------

View File

@@ -32,6 +32,8 @@ Properties
Methods
-------
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_axis_lock<class_KinematicBody_method_get_axis_lock>` **(** :ref:`BodyAxis<enum_PhysicsServer_BodyAxis>` axis **)** const |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`get_floor_velocity<class_KinematicBody_method_get_floor_velocity>` **(** **)** const |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -51,6 +53,8 @@ Methods
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`move_and_slide_with_snap<class_KinematicBody_method_move_and_slide_with_snap>` **(** :ref:`Vector3<class_Vector3>` linear_velocity, :ref:`Vector3<class_Vector3>` snap, :ref:`Vector3<class_Vector3>` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool<class_bool>` stop_on_slope=false, :ref:`int<class_int>` max_slides=4, :ref:`float<class_float>` floor_max_angle=0.785398, :ref:`bool<class_bool>` infinite_inertia=true **)** |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_axis_lock<class_KinematicBody_method_set_axis_lock>` **(** :ref:`BodyAxis<enum_PhysicsServer_BodyAxis>` axis, :ref:`bool<class_bool>` lock **)** |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`test_move<class_KinematicBody_method_test_move>` **(** :ref:`Transform<class_Transform>` from, :ref:`Vector3<class_Vector3>` rel_vec, :ref:`bool<class_bool>` infinite_inertia=true **)** |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -130,6 +134,10 @@ Lock the body's Z axis movement.
Method Descriptions
-------------------
.. _class_KinematicBody_method_get_axis_lock:
- :ref:`bool<class_bool>` **get_axis_lock** **(** :ref:`BodyAxis<enum_PhysicsServer_BodyAxis>` axis **)** const
.. _class_KinematicBody_method_get_floor_velocity:
- :ref:`Vector3<class_Vector3>` **get_floor_velocity** **(** **)** const
@@ -202,6 +210,10 @@ Moves the body while keeping it attached to slopes. Similar to :ref:`move_and_sl
As long as the ``snap`` vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting``snap`` to``(0, 0, 0)`` or by using :ref:`move_and_slide<class_KinematicBody_method_move_and_slide>` instead.
.. _class_KinematicBody_method_set_axis_lock:
- void **set_axis_lock** **(** :ref:`BodyAxis<enum_PhysicsServer_BodyAxis>` axis, :ref:`bool<class_bool>` lock **)**
.. _class_KinematicBody_method_test_move:
- :ref:`bool<class_bool>` **test_move** **(** :ref:`Transform<class_Transform>` from, :ref:`Vector3<class_Vector3>` rel_vec, :ref:`bool<class_bool>` infinite_inertia=true **)**

View File

@@ -20,19 +20,19 @@ Properties
----------
+-------------------------------+-------------------------------------------------------------------------------------+--------------------+
| :ref:`Object<class_Object>` | :ref:`collider<class_KinematicCollision_property_collider>` | null |
| :ref:`Object<class_Object>` | :ref:`collider<class_KinematicCollision_property_collider>` | |
+-------------------------------+-------------------------------------------------------------------------------------+--------------------+
| :ref:`int<class_int>` | :ref:`collider_id<class_KinematicCollision_property_collider_id>` | 0 |
+-------------------------------+-------------------------------------------------------------------------------------+--------------------+
| :ref:`Variant<class_Variant>` | :ref:`collider_metadata<class_KinematicCollision_property_collider_metadata>` | |
+-------------------------------+-------------------------------------------------------------------------------------+--------------------+
| :ref:`Object<class_Object>` | :ref:`collider_shape<class_KinematicCollision_property_collider_shape>` | null |
| :ref:`Object<class_Object>` | :ref:`collider_shape<class_KinematicCollision_property_collider_shape>` | |
+-------------------------------+-------------------------------------------------------------------------------------+--------------------+
| :ref:`int<class_int>` | :ref:`collider_shape_index<class_KinematicCollision_property_collider_shape_index>` | 0 |
+-------------------------------+-------------------------------------------------------------------------------------+--------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`collider_velocity<class_KinematicCollision_property_collider_velocity>` | Vector3( 0, 0, 0 ) |
+-------------------------------+-------------------------------------------------------------------------------------+--------------------+
| :ref:`Object<class_Object>` | :ref:`local_shape<class_KinematicCollision_property_local_shape>` | null |
| :ref:`Object<class_Object>` | :ref:`local_shape<class_KinematicCollision_property_local_shape>` | |
+-------------------------------+-------------------------------------------------------------------------------------+--------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`normal<class_KinematicCollision_property_normal>` | Vector3( 0, 0, 0 ) |
+-------------------------------+-------------------------------------------------------------------------------------+--------------------+
@@ -57,11 +57,9 @@ Property Descriptions
- :ref:`Object<class_Object>` **collider**
+-----------+----------------+
| *Default* | null |
+-----------+----------------+
| *Getter* | get_collider() |
+-----------+----------------+
+----------+----------------+
| *Getter* | get_collider() |
+----------+----------------+
The colliding body.
@@ -91,11 +89,9 @@ The colliding body's metadata. See :ref:`Object<class_Object>`.
- :ref:`Object<class_Object>` **collider_shape**
+-----------+----------------------+
| *Default* | null |
+-----------+----------------------+
| *Getter* | get_collider_shape() |
+-----------+----------------------+
+----------+----------------------+
| *Getter* | get_collider_shape() |
+----------+----------------------+
The colliding body's shape.
@@ -127,11 +123,9 @@ The colliding object's velocity.
- :ref:`Object<class_Object>` **local_shape**
+-----------+-------------------+
| *Default* | null |
+-----------+-------------------+
| *Getter* | get_local_shape() |
+-----------+-------------------+
+----------+-------------------+
| *Getter* | get_local_shape() |
+----------+-------------------+
The moving object's colliding shape.

View File

@@ -20,19 +20,19 @@ Properties
----------
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
| :ref:`Object<class_Object>` | :ref:`collider<class_KinematicCollision2D_property_collider>` | null |
| :ref:`Object<class_Object>` | :ref:`collider<class_KinematicCollision2D_property_collider>` | |
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
| :ref:`int<class_int>` | :ref:`collider_id<class_KinematicCollision2D_property_collider_id>` | 0 |
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
| :ref:`Variant<class_Variant>` | :ref:`collider_metadata<class_KinematicCollision2D_property_collider_metadata>` | |
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
| :ref:`Object<class_Object>` | :ref:`collider_shape<class_KinematicCollision2D_property_collider_shape>` | null |
| :ref:`Object<class_Object>` | :ref:`collider_shape<class_KinematicCollision2D_property_collider_shape>` | |
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
| :ref:`int<class_int>` | :ref:`collider_shape_index<class_KinematicCollision2D_property_collider_shape_index>` | 0 |
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
| :ref:`Vector2<class_Vector2>` | :ref:`collider_velocity<class_KinematicCollision2D_property_collider_velocity>` | Vector2( 0, 0 ) |
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
| :ref:`Object<class_Object>` | :ref:`local_shape<class_KinematicCollision2D_property_local_shape>` | null |
| :ref:`Object<class_Object>` | :ref:`local_shape<class_KinematicCollision2D_property_local_shape>` | |
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
| :ref:`Vector2<class_Vector2>` | :ref:`normal<class_KinematicCollision2D_property_normal>` | Vector2( 0, 0 ) |
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
@@ -57,11 +57,9 @@ Property Descriptions
- :ref:`Object<class_Object>` **collider**
+-----------+----------------+
| *Default* | null |
+-----------+----------------+
| *Getter* | get_collider() |
+-----------+----------------+
+----------+----------------+
| *Getter* | get_collider() |
+----------+----------------+
The colliding body.
@@ -91,11 +89,9 @@ The colliding body's metadata. See :ref:`Object<class_Object>`.
- :ref:`Object<class_Object>` **collider_shape**
+-----------+----------------------+
| *Default* | null |
+-----------+----------------------+
| *Getter* | get_collider_shape() |
+-----------+----------------------+
+----------+----------------------+
| *Getter* | get_collider_shape() |
+----------+----------------------+
The colliding body's shape.
@@ -127,11 +123,9 @@ The colliding object's velocity.
- :ref:`Object<class_Object>` **local_shape**
+-----------+-------------------+
| *Default* | null |
+-----------+-------------------+
| *Getter* | get_local_shape() |
+-----------+-------------------+
+----------+-------------------+
| *Getter* | get_local_shape() |
+----------+-------------------+
The moving object's colliding shape.

View File

@@ -49,6 +49,15 @@ Properties
| :ref:`bool<class_bool>` | :ref:`shadow_reverse_cull_face<class_Light_property_shadow_reverse_cull_face>` | false |
+--------------------------------------+--------------------------------------------------------------------------------+---------------------+
Methods
-------
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param<class_Light_method_get_param>` **(** :ref:`Param<enum_Light_Param>` param **)** const |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param<class_Light_method_set_param>` **(** :ref:`Param<enum_Light_Param>` param, :ref:`float<class_float>` value **)** |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
@@ -333,3 +342,14 @@ If ``true``, the light will cast shadows.
| *Getter* | get_shadow_reverse_cull_face() |
+-----------+-------------------------------------+
Method Descriptions
-------------------
.. _class_Light_method_get_param:
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_Light_Param>` param **)** const
.. _class_Light_method_set_param:
- void **set_param** **(** :ref:`Param<enum_Light_Param>` param, :ref:`float<class_float>` value **)**

View File

@@ -58,7 +58,7 @@ Properties
+------------------------------------------------+------------------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>` | :ref:`shadow_item_cull_mask<class_Light2D_property_shadow_item_cull_mask>` | 1 |
+------------------------------------------------+------------------------------------------------------------------------------+---------------------+
| :ref:`Texture<class_Texture>` | :ref:`texture<class_Light2D_property_texture>` | null |
| :ref:`Texture<class_Texture>` | :ref:`texture<class_Light2D_property_texture>` | |
+------------------------------------------------+------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`texture_scale<class_Light2D_property_texture_scale>` | 1.0 |
+------------------------------------------------+------------------------------------------------------------------------------+---------------------+
@@ -399,13 +399,11 @@ The shadow mask. Used with :ref:`LightOccluder2D<class_LightOccluder2D>` to cast
- :ref:`Texture<class_Texture>` **texture**
+-----------+--------------------+
| *Default* | null |
+-----------+--------------------+
| *Setter* | set_texture(value) |
+-----------+--------------------+
| *Getter* | get_texture() |
+-----------+--------------------+
+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture() |
+----------+--------------------+
:ref:`Texture<class_Texture>` used for the Light2D's appearance.

View File

@@ -19,11 +19,11 @@ Occludes light cast by a Light2D, casting shadows.
Properties
----------
+---------------------------------------------------+--------------------------------------------------------------+------+
| :ref:`int<class_int>` | :ref:`light_mask<class_LightOccluder2D_property_light_mask>` | 1 |
+---------------------------------------------------+--------------------------------------------------------------+------+
| :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` | :ref:`occluder<class_LightOccluder2D_property_occluder>` | null |
+---------------------------------------------------+--------------------------------------------------------------+------+
+---------------------------------------------------+--------------------------------------------------------------+---+
| :ref:`int<class_int>` | :ref:`light_mask<class_LightOccluder2D_property_light_mask>` | 1 |
+---------------------------------------------------+--------------------------------------------------------------+---+
| :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` | :ref:`occluder<class_LightOccluder2D_property_occluder>` | |
+---------------------------------------------------+--------------------------------------------------------------+---+
Description
-----------
@@ -56,13 +56,11 @@ The LightOccluder2D's light mask. The LightOccluder2D will cast shadows only fro
- :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` **occluder**
+-----------+-----------------------------+
| *Default* | null |
+-----------+-----------------------------+
| *Setter* | set_occluder_polygon(value) |
+-----------+-----------------------------+
| *Getter* | get_occluder_polygon() |
+-----------+-----------------------------+
+----------+-----------------------------+
| *Setter* | set_occluder_polygon(value) |
+----------+-----------------------------+
| *Getter* | get_occluder_polygon() |
+----------+-----------------------------+
The :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` used to compute the shadow.

View File

@@ -26,7 +26,7 @@ Properties
+-----------------------------------------------------+---------------------------------------------------------------+-------------------------+
| :ref:`LineCapMode<enum_Line2D_LineCapMode>` | :ref:`end_cap_mode<class_Line2D_property_end_cap_mode>` | 0 |
+-----------------------------------------------------+---------------------------------------------------------------+-------------------------+
| :ref:`Gradient<class_Gradient>` | :ref:`gradient<class_Line2D_property_gradient>` | null |
| :ref:`Gradient<class_Gradient>` | :ref:`gradient<class_Line2D_property_gradient>` | |
+-----------------------------------------------------+---------------------------------------------------------------+-------------------------+
| :ref:`LineJointMode<enum_Line2D_LineJointMode>` | :ref:`joint_mode<class_Line2D_property_joint_mode>` | 0 |
+-----------------------------------------------------+---------------------------------------------------------------+-------------------------+
@@ -36,13 +36,13 @@ Properties
+-----------------------------------------------------+---------------------------------------------------------------+-------------------------+
| :ref:`float<class_float>` | :ref:`sharp_limit<class_Line2D_property_sharp_limit>` | 2.0 |
+-----------------------------------------------------+---------------------------------------------------------------+-------------------------+
| :ref:`Texture<class_Texture>` | :ref:`texture<class_Line2D_property_texture>` | null |
| :ref:`Texture<class_Texture>` | :ref:`texture<class_Line2D_property_texture>` | |
+-----------------------------------------------------+---------------------------------------------------------------+-------------------------+
| :ref:`LineTextureMode<enum_Line2D_LineTextureMode>` | :ref:`texture_mode<class_Line2D_property_texture_mode>` | 0 |
+-----------------------------------------------------+---------------------------------------------------------------+-------------------------+
| :ref:`float<class_float>` | :ref:`width<class_Line2D_property_width>` | 10.0 |
+-----------------------------------------------------+---------------------------------------------------------------+-------------------------+
| :ref:`Curve<class_Curve>` | :ref:`width_curve<class_Line2D_property_width_curve>` | null |
| :ref:`Curve<class_Curve>` | :ref:`width_curve<class_Line2D_property_width_curve>` | |
+-----------------------------------------------------+---------------------------------------------------------------+-------------------------+
Methods
@@ -167,13 +167,11 @@ Controls the style of the line's last point. Use ``LINE_CAP_*`` constants.
- :ref:`Gradient<class_Gradient>` **gradient**
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_gradient(value) |
+-----------+---------------------+
| *Getter* | get_gradient() |
+-----------+---------------------+
+----------+---------------------+
| *Setter* | set_gradient(value) |
+----------+---------------------+
| *Getter* | get_gradient() |
+----------+---------------------+
The gradient is drawn through the whole line from start to finish. The default color will not be used if a gradient is set.
@@ -237,13 +235,11 @@ The direction difference in radians between vector points. This value is only us
- :ref:`Texture<class_Texture>` **texture**
+-----------+--------------------+
| *Default* | null |
+-----------+--------------------+
| *Setter* | set_texture(value) |
+-----------+--------------------+
| *Getter* | get_texture() |
+-----------+--------------------+
+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture() |
+----------+--------------------+
The texture used for the line's texture. Uses ``texture_mode`` for drawing style.
@@ -279,13 +275,11 @@ The line's width.
- :ref:`Curve<class_Curve>` **width_curve**
+-----------+------------------+
| *Default* | null |
+-----------+------------------+
| *Setter* | set_curve(value) |
+-----------+------------------+
| *Getter* | get_curve() |
+-----------+------------------+
+----------+------------------+
| *Setter* | set_curve(value) |
+----------+------------------+
| *Getter* | get_curve() |
+----------+------------------+
The line's width varies with the curve. The original width is simply multiply by the value of the Curve.

View File

@@ -73,33 +73,33 @@ Methods
Theme Properties
----------------
+---------------------------------+----------------------------+--------------------------------------------+
| :ref:`Texture<class_Texture>` | clear | |
+---------------------------------+----------------------------+--------------------------------------------+
| :ref:`Color<class_Color>` | clear_button_color | Color( 0.878431, 0.878431, 0.878431, 1 ) |
+---------------------------------+----------------------------+--------------------------------------------+
| :ref:`Color<class_Color>` | clear_button_color_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+----------------------------+--------------------------------------------+
| :ref:`Color<class_Color>` | cursor_color | Color( 0.941176, 0.941176, 0.941176, 1 ) |
+---------------------------------+----------------------------+--------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+----------------------------+--------------------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+----------------------------+--------------------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) |
+---------------------------------+----------------------------+--------------------------------------------+
| :ref:`Color<class_Color>` | font_color_selected | Color( 0, 0, 0, 1 ) |
+---------------------------------+----------------------------+--------------------------------------------+
| :ref:`Color<class_Color>` | font_color_uneditable | Color( 0.878431, 0.878431, 0.878431, 0.5 ) |
+---------------------------------+----------------------------+--------------------------------------------+
| :ref:`int<class_int>` | minimum_spaces | 12 |
+---------------------------------+----------------------------+--------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+----------------------------+--------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | read_only | |
+---------------------------------+----------------------------+--------------------------------------------+
| :ref:`Color<class_Color>` | selection_color | Color( 0.490196, 0.490196, 0.490196, 1 ) |
+---------------------------------+----------------------------+--------------------------------------------+
+---------------------------------+----------------------------+--------------------------------+
| :ref:`Texture<class_Texture>` | clear | |
+---------------------------------+----------------------------+--------------------------------+
| :ref:`Color<class_Color>` | clear_button_color | Color( 0.88, 0.88, 0.88, 1 ) |
+---------------------------------+----------------------------+--------------------------------+
| :ref:`Color<class_Color>` | clear_button_color_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+----------------------------+--------------------------------+
| :ref:`Color<class_Color>` | cursor_color | Color( 0.94, 0.94, 0.94, 1 ) |
+---------------------------------+----------------------------+--------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+----------------------------+--------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+----------------------------+--------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.88, 0.88, 0.88, 1 ) |
+---------------------------------+----------------------------+--------------------------------+
| :ref:`Color<class_Color>` | font_color_selected | Color( 0, 0, 0, 1 ) |
+---------------------------------+----------------------------+--------------------------------+
| :ref:`Color<class_Color>` | font_color_uneditable | Color( 0.88, 0.88, 0.88, 0.5 ) |
+---------------------------------+----------------------------+--------------------------------+
| :ref:`int<class_int>` | minimum_spaces | 12 |
+---------------------------------+----------------------------+--------------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+----------------------------+--------------------------------+
| :ref:`StyleBox<class_StyleBox>` | read_only | |
+---------------------------------+----------------------------+--------------------------------+
| :ref:`Color<class_Color>` | selection_color | Color( 0.49, 0.49, 0.49, 1 ) |
+---------------------------------+----------------------------+--------------------------------+
Signals
-------

View File

@@ -28,19 +28,19 @@ Properties
Theme Properties
----------------
+---------------------------------+--------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+--------------------+------------------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+--------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) |
+---------------------------------+--------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.941176, 0.941176, 0.941176, 1 ) |
+---------------------------------+--------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+--------------------+------------------------------------------+
| :ref:`int<class_int>` | underline_spacing | 2 |
+---------------------------------+--------------------+------------------------------------------+
+---------------------------------+--------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+--------------------+------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+--------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.88, 0.88, 0.88, 1 ) |
+---------------------------------+--------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) |
+---------------------------------+--------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+--------------------+------------------------------+
| :ref:`int<class_int>` | underline_spacing | 2 |
+---------------------------------+--------------------+------------------------------+
Enumerations
------------

View File

@@ -21,11 +21,11 @@ Abstract base :ref:`Resource<class_Resource>` for coloring and shading geometry.
Properties
----------
+---------------------------------+-----------------------------------------------------------------+------+
| :ref:`Material<class_Material>` | :ref:`next_pass<class_Material_property_next_pass>` | null |
+---------------------------------+-----------------------------------------------------------------+------+
| :ref:`int<class_int>` | :ref:`render_priority<class_Material_property_render_priority>` | 0 |
+---------------------------------+-----------------------------------------------------------------+------+
+---------------------------------+-----------------------------------------------------------------+---+
| :ref:`Material<class_Material>` | :ref:`next_pass<class_Material_property_next_pass>` | |
+---------------------------------+-----------------------------------------------------------------+---+
| :ref:`int<class_int>` | :ref:`render_priority<class_Material_property_render_priority>` | 0 |
+---------------------------------+-----------------------------------------------------------------+---+
Constants
---------
@@ -50,13 +50,11 @@ Property Descriptions
- :ref:`Material<class_Material>` **next_pass**
+-----------+----------------------+
| *Default* | null |
+-----------+----------------------+
| *Setter* | set_next_pass(value) |
+-----------+----------------------+
| *Getter* | get_next_pass() |
+-----------+----------------------+
+----------+----------------------+
| *Setter* | set_next_pass(value) |
+----------+----------------------+
| *Getter* | get_next_pass() |
+----------+----------------------+
.. _class_Material_property_render_priority:

View File

@@ -35,29 +35,29 @@ Methods
Theme Properties
----------------
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_disabled | Color( 1, 1, 1, 0.3 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.941176, 0.941176, 0.941176, 1 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`int<class_int>` | hseparation | 3 |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed | |
+---------------------------------+---------------------+------------------------------------------+
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled | |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+---------------------+------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.88, 0.88, 0.88, 1 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_disabled | Color( 1, 1, 1, 0.3 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover | |
+---------------------------------+---------------------+------------------------------+
| :ref:`int<class_int>` | hseparation | 3 |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed | |
+---------------------------------+---------------------+------------------------------+
Signals
-------

View File

@@ -22,7 +22,7 @@ Properties
----------
+---------------------------------+-------------------------------------------------------+----------------+
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_MeshInstance_property_mesh>` | null |
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_MeshInstance_property_mesh>` | |
+---------------------------------+-------------------------------------------------------+----------------+
| :ref:`NodePath<class_NodePath>` | :ref:`skeleton<class_MeshInstance_property_skeleton>` | NodePath("..") |
+---------------------------------+-------------------------------------------------------+----------------+
@@ -56,13 +56,11 @@ Property Descriptions
- :ref:`Mesh<class_Mesh>` **mesh**
+-----------+-----------------+
| *Default* | null |
+-----------+-----------------+
| *Setter* | set_mesh(value) |
+-----------+-----------------+
| *Getter* | get_mesh() |
+-----------+-----------------+
+----------+-----------------+
| *Setter* | set_mesh(value) |
+----------+-----------------+
| *Getter* | get_mesh() |
+----------+-----------------+
The :ref:`Mesh<class_Mesh>` resource for the instance.

View File

@@ -19,13 +19,13 @@ Node used for displaying a :ref:`Mesh<class_Mesh>` in 2D.
Properties
----------
+-------------------------------+-------------------------------------------------------------+------+
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_MeshInstance2D_property_mesh>` | null |
+-------------------------------+-------------------------------------------------------------+------+
| :ref:`Texture<class_Texture>` | :ref:`normal_map<class_MeshInstance2D_property_normal_map>` | null |
+-------------------------------+-------------------------------------------------------------+------+
| :ref:`Texture<class_Texture>` | :ref:`texture<class_MeshInstance2D_property_texture>` | null |
+-------------------------------+-------------------------------------------------------------+------+
+-------------------------------+-------------------------------------------------------------+
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_MeshInstance2D_property_mesh>` |
+-------------------------------+-------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`normal_map<class_MeshInstance2D_property_normal_map>` |
+-------------------------------+-------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`texture<class_MeshInstance2D_property_texture>` |
+-------------------------------+-------------------------------------------------------------+
Signals
-------
@@ -51,13 +51,11 @@ Property Descriptions
- :ref:`Mesh<class_Mesh>` **mesh**
+-----------+-----------------+
| *Default* | null |
+-----------+-----------------+
| *Setter* | set_mesh(value) |
+-----------+-----------------+
| *Getter* | get_mesh() |
+-----------+-----------------+
+----------+-----------------+
| *Setter* | set_mesh(value) |
+----------+-----------------+
| *Getter* | get_mesh() |
+----------+-----------------+
The :ref:`Mesh<class_Mesh>` that will be drawn by the ``MeshInstance2D``.
@@ -65,13 +63,11 @@ The :ref:`Mesh<class_Mesh>` that will be drawn by the ``MeshInstance2D``.
- :ref:`Texture<class_Texture>` **normal_map**
+-----------+-----------------------+
| *Default* | null |
+-----------+-----------------------+
| *Setter* | set_normal_map(value) |
+-----------+-----------------------+
| *Getter* | get_normal_map() |
+-----------+-----------------------+
+----------+-----------------------+
| *Setter* | set_normal_map(value) |
+----------+-----------------------+
| *Getter* | get_normal_map() |
+----------+-----------------------+
The normal map that will be used if using the default :ref:`CanvasItemMaterial<class_CanvasItemMaterial>`.
@@ -79,13 +75,11 @@ The normal map that will be used if using the default :ref:`CanvasItemMaterial<c
- :ref:`Texture<class_Texture>` **texture**
+-----------+--------------------+
| *Default* | null |
+-----------+--------------------+
| *Setter* | set_texture(value) |
+-----------+--------------------+
| *Getter* | get_texture() |
+-----------+--------------------+
+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture() |
+----------+--------------------+
The :ref:`Texture<class_Texture>` that will be used if using the default :ref:`CanvasItemMaterial<class_CanvasItemMaterial>`. Can be accessed as ``TEXTURE`` in CanvasItem shader.

View File

@@ -20,11 +20,11 @@ Properties
----------
+-------------------------------+--------------------------------------------------------------+-----------------+
| :ref:`Texture<class_Texture>` | :ref:`base_texture<class_MeshTexture_property_base_texture>` | null |
| :ref:`Texture<class_Texture>` | :ref:`base_texture<class_MeshTexture_property_base_texture>` | |
+-------------------------------+--------------------------------------------------------------+-----------------+
| :ref:`Vector2<class_Vector2>` | :ref:`image_size<class_MeshTexture_property_image_size>` | Vector2( 0, 0 ) |
+-------------------------------+--------------------------------------------------------------+-----------------+
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_MeshTexture_property_mesh>` | null |
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_MeshTexture_property_mesh>` | |
+-------------------------------+--------------------------------------------------------------+-----------------+
Description
@@ -39,13 +39,11 @@ Property Descriptions
- :ref:`Texture<class_Texture>` **base_texture**
+-----------+-------------------------+
| *Default* | null |
+-----------+-------------------------+
| *Setter* | set_base_texture(value) |
+-----------+-------------------------+
| *Getter* | get_base_texture() |
+-----------+-------------------------+
+----------+-------------------------+
| *Setter* | set_base_texture(value) |
+----------+-------------------------+
| *Getter* | get_base_texture() |
+----------+-------------------------+
Sets the base texture that the Mesh will use to draw.
@@ -67,13 +65,11 @@ Sets the size of the image, needed for reference.
- :ref:`Mesh<class_Mesh>` **mesh**
+-----------+-----------------+
| *Default* | null |
+-----------+-----------------+
| *Setter* | set_mesh(value) |
+-----------+-----------------+
| *Getter* | get_mesh() |
+-----------+-----------------+
+----------+-----------------+
| *Setter* | set_mesh(value) |
+----------+-----------------+
| *Getter* | get_mesh() |
+----------+-----------------+
Sets the mesh used to draw. It must be a mesh using 2D vertices.

View File

@@ -19,19 +19,19 @@ Provides high-performance mesh instancing.
Properties
----------
+----------------------------------------------------------+--------------------------------------------------------------------------------+------+
| :ref:`ColorFormat<enum_MultiMesh_ColorFormat>` | :ref:`color_format<class_MultiMesh_property_color_format>` | 0 |
+----------------------------------------------------------+--------------------------------------------------------------------------------+------+
| :ref:`CustomDataFormat<enum_MultiMesh_CustomDataFormat>` | :ref:`custom_data_format<class_MultiMesh_property_custom_data_format>` | 0 |
+----------------------------------------------------------+--------------------------------------------------------------------------------+------+
| :ref:`int<class_int>` | :ref:`instance_count<class_MultiMesh_property_instance_count>` | 0 |
+----------------------------------------------------------+--------------------------------------------------------------------------------+------+
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_MultiMesh_property_mesh>` | null |
+----------------------------------------------------------+--------------------------------------------------------------------------------+------+
| :ref:`TransformFormat<enum_MultiMesh_TransformFormat>` | :ref:`transform_format<class_MultiMesh_property_transform_format>` | 0 |
+----------------------------------------------------------+--------------------------------------------------------------------------------+------+
| :ref:`int<class_int>` | :ref:`visible_instance_count<class_MultiMesh_property_visible_instance_count>` | -1 |
+----------------------------------------------------------+--------------------------------------------------------------------------------+------+
+----------------------------------------------------------+--------------------------------------------------------------------------------+----+
| :ref:`ColorFormat<enum_MultiMesh_ColorFormat>` | :ref:`color_format<class_MultiMesh_property_color_format>` | 0 |
+----------------------------------------------------------+--------------------------------------------------------------------------------+----+
| :ref:`CustomDataFormat<enum_MultiMesh_CustomDataFormat>` | :ref:`custom_data_format<class_MultiMesh_property_custom_data_format>` | 0 |
+----------------------------------------------------------+--------------------------------------------------------------------------------+----+
| :ref:`int<class_int>` | :ref:`instance_count<class_MultiMesh_property_instance_count>` | 0 |
+----------------------------------------------------------+--------------------------------------------------------------------------------+----+
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_MultiMesh_property_mesh>` | |
+----------------------------------------------------------+--------------------------------------------------------------------------------+----+
| :ref:`TransformFormat<enum_MultiMesh_TransformFormat>` | :ref:`transform_format<class_MultiMesh_property_transform_format>` | 0 |
+----------------------------------------------------------+--------------------------------------------------------------------------------+----+
| :ref:`int<class_int>` | :ref:`visible_instance_count<class_MultiMesh_property_visible_instance_count>` | -1 |
+----------------------------------------------------------+--------------------------------------------------------------------------------+----+
Methods
-------
@@ -170,13 +170,11 @@ Number of instances that will get drawn. This clears and (re)sizes the buffers.
- :ref:`Mesh<class_Mesh>` **mesh**
+-----------+-----------------+
| *Default* | null |
+-----------+-----------------+
| *Setter* | set_mesh(value) |
+-----------+-----------------+
| *Getter* | get_mesh() |
+-----------+-----------------+
+----------+-----------------+
| *Setter* | set_mesh(value) |
+----------+-----------------+
| *Getter* | get_mesh() |
+----------+-----------------+
Mesh to be drawn.

View File

@@ -19,9 +19,9 @@ Node that instances a :ref:`MultiMesh<class_MultiMesh>`.
Properties
----------
+-----------------------------------+--------------------------------------------------------------+------+
| :ref:`MultiMesh<class_MultiMesh>` | :ref:`multimesh<class_MultiMeshInstance_property_multimesh>` | null |
+-----------------------------------+--------------------------------------------------------------+------+
+-----------------------------------+--------------------------------------------------------------+
| :ref:`MultiMesh<class_MultiMesh>` | :ref:`multimesh<class_MultiMeshInstance_property_multimesh>` |
+-----------------------------------+--------------------------------------------------------------+
Description
-----------
@@ -44,13 +44,11 @@ Property Descriptions
- :ref:`MultiMesh<class_MultiMesh>` **multimesh**
+-----------+----------------------+
| *Default* | null |
+-----------+----------------------+
| *Setter* | set_multimesh(value) |
+-----------+----------------------+
| *Getter* | get_multimesh() |
+-----------+----------------------+
+----------+----------------------+
| *Setter* | set_multimesh(value) |
+----------+----------------------+
| *Getter* | get_multimesh() |
+----------+----------------------+
The :ref:`MultiMesh<class_MultiMesh>` resource that will be used and shared among all instances of the ``MultiMeshInstance``.

View File

@@ -19,13 +19,13 @@ Node that instances a :ref:`MultiMesh<class_MultiMesh>` in 2D.
Properties
----------
+-----------------------------------+------------------------------------------------------------------+------+
| :ref:`MultiMesh<class_MultiMesh>` | :ref:`multimesh<class_MultiMeshInstance2D_property_multimesh>` | null |
+-----------------------------------+------------------------------------------------------------------+------+
| :ref:`Texture<class_Texture>` | :ref:`normal_map<class_MultiMeshInstance2D_property_normal_map>` | null |
+-----------------------------------+------------------------------------------------------------------+------+
| :ref:`Texture<class_Texture>` | :ref:`texture<class_MultiMeshInstance2D_property_texture>` | null |
+-----------------------------------+------------------------------------------------------------------+------+
+-----------------------------------+------------------------------------------------------------------+
| :ref:`MultiMesh<class_MultiMesh>` | :ref:`multimesh<class_MultiMeshInstance2D_property_multimesh>` |
+-----------------------------------+------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`normal_map<class_MultiMeshInstance2D_property_normal_map>` |
+-----------------------------------+------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`texture<class_MultiMeshInstance2D_property_texture>` |
+-----------------------------------+------------------------------------------------------------------+
Signals
-------
@@ -48,13 +48,11 @@ Property Descriptions
- :ref:`MultiMesh<class_MultiMesh>` **multimesh**
+-----------+----------------------+
| *Default* | null |
+-----------+----------------------+
| *Setter* | set_multimesh(value) |
+-----------+----------------------+
| *Getter* | get_multimesh() |
+-----------+----------------------+
+----------+----------------------+
| *Setter* | set_multimesh(value) |
+----------+----------------------+
| *Getter* | get_multimesh() |
+----------+----------------------+
The :ref:`MultiMesh<class_MultiMesh>` that will be drawn by the ``MultiMeshInstance2D``.
@@ -62,13 +60,11 @@ The :ref:`MultiMesh<class_MultiMesh>` that will be drawn by the ``MultiMeshInsta
- :ref:`Texture<class_Texture>` **normal_map**
+-----------+-----------------------+
| *Default* | null |
+-----------+-----------------------+
| *Setter* | set_normal_map(value) |
+-----------+-----------------------+
| *Getter* | get_normal_map() |
+-----------+-----------------------+
+----------+-----------------------+
| *Setter* | set_normal_map(value) |
+----------+-----------------------+
| *Getter* | get_normal_map() |
+----------+-----------------------+
The normal map that will be used if using the default :ref:`CanvasItemMaterial<class_CanvasItemMaterial>`.
@@ -76,13 +72,11 @@ The normal map that will be used if using the default :ref:`CanvasItemMaterial<c
- :ref:`Texture<class_Texture>` **texture**
+-----------+--------------------+
| *Default* | null |
+-----------+--------------------+
| *Setter* | set_texture(value) |
+-----------+--------------------+
| *Getter* | get_texture() |
+-----------+--------------------+
+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture() |
+----------+--------------------+
The :ref:`Texture<class_Texture>` that will be used if using the default :ref:`CanvasItemMaterial<class_CanvasItemMaterial>`. Can be accessed as ``TEXTURE`` in CanvasItem shader.

View File

@@ -19,15 +19,15 @@ Brief Description
Properties
----------
+-----------------------------------------------+-----------------------------------------------------------------------------------+------+
| :ref:`String<class_String>` | :ref:`class_name<class_NativeScript_property_class_name>` | "" |
+-----------------------------------------------+-----------------------------------------------------------------------------------+------+
| :ref:`GDNativeLibrary<class_GDNativeLibrary>` | :ref:`library<class_NativeScript_property_library>` | null |
+-----------------------------------------------+-----------------------------------------------------------------------------------+------+
| :ref:`String<class_String>` | :ref:`script_class_icon_path<class_NativeScript_property_script_class_icon_path>` | "" |
+-----------------------------------------------+-----------------------------------------------------------------------------------+------+
| :ref:`String<class_String>` | :ref:`script_class_name<class_NativeScript_property_script_class_name>` | "" |
+-----------------------------------------------+-----------------------------------------------------------------------------------+------+
+-----------------------------------------------+-----------------------------------------------------------------------------------+----+
| :ref:`String<class_String>` | :ref:`class_name<class_NativeScript_property_class_name>` | "" |
+-----------------------------------------------+-----------------------------------------------------------------------------------+----+
| :ref:`GDNativeLibrary<class_GDNativeLibrary>` | :ref:`library<class_NativeScript_property_library>` | |
+-----------------------------------------------+-----------------------------------------------------------------------------------+----+
| :ref:`String<class_String>` | :ref:`script_class_icon_path<class_NativeScript_property_script_class_icon_path>` | "" |
+-----------------------------------------------+-----------------------------------------------------------------------------------+----+
| :ref:`String<class_String>` | :ref:`script_class_name<class_NativeScript_property_script_class_name>` | "" |
+-----------------------------------------------+-----------------------------------------------------------------------------------+----+
Methods
-------
@@ -63,13 +63,11 @@ Property Descriptions
- :ref:`GDNativeLibrary<class_GDNativeLibrary>` **library**
+-----------+--------------------+
| *Default* | null |
+-----------+--------------------+
| *Setter* | set_library(value) |
+-----------+--------------------+
| *Getter* | get_library() |
+-----------+--------------------+
+----------+--------------------+
| *Setter* | set_library(value) |
+----------+--------------------+
| *Getter* | get_library() |
+----------+--------------------+
.. _class_NativeScript_property_script_class_icon_path:

View File

@@ -22,7 +22,7 @@ Properties
+---------------------------------------------+---------------------------------------------------------------+------+
| :ref:`bool<class_bool>` | :ref:`enabled<class_NavigationMeshInstance_property_enabled>` | true |
+---------------------------------------------+---------------------------------------------------------------+------+
| :ref:`NavigationMesh<class_NavigationMesh>` | :ref:`navmesh<class_NavigationMeshInstance_property_navmesh>` | null |
| :ref:`NavigationMesh<class_NavigationMesh>` | :ref:`navmesh<class_NavigationMeshInstance_property_navmesh>` | |
+---------------------------------------------+---------------------------------------------------------------+------+
Property Descriptions
@@ -44,11 +44,9 @@ Property Descriptions
- :ref:`NavigationMesh<class_NavigationMesh>` **navmesh**
+-----------+----------------------------+
| *Default* | null |
+-----------+----------------------------+
| *Setter* | set_navigation_mesh(value) |
+-----------+----------------------------+
| *Getter* | get_navigation_mesh() |
+-----------+----------------------------+
+----------+----------------------------+
| *Setter* | set_navigation_mesh(value) |
+----------+----------------------------+
| *Getter* | get_navigation_mesh() |
+----------+----------------------------+

View File

@@ -22,7 +22,7 @@ Properties
+---------------------------------------------------+------------------------------------------------------------------+------+
| :ref:`bool<class_bool>` | :ref:`enabled<class_NavigationPolygonInstance_property_enabled>` | true |
+---------------------------------------------------+------------------------------------------------------------------+------+
| :ref:`NavigationPolygon<class_NavigationPolygon>` | :ref:`navpoly<class_NavigationPolygonInstance_property_navpoly>` | null |
| :ref:`NavigationPolygon<class_NavigationPolygon>` | :ref:`navpoly<class_NavigationPolygonInstance_property_navpoly>` | |
+---------------------------------------------------+------------------------------------------------------------------+------+
Property Descriptions
@@ -44,11 +44,9 @@ Property Descriptions
- :ref:`NavigationPolygon<class_NavigationPolygon>` **navpoly**
+-----------+-------------------------------+
| *Default* | null |
+-----------+-------------------------------+
| *Setter* | set_navigation_polygon(value) |
+-----------+-------------------------------+
| *Getter* | get_navigation_polygon() |
+-----------+-------------------------------+
+----------+-------------------------------+
| *Setter* | set_navigation_polygon(value) |
+----------+-------------------------------+
| *Getter* | get_navigation_polygon() |
+----------+-------------------------------+

View File

@@ -36,9 +36,18 @@ Properties
+------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`region_rect<class_NinePatchRect_property_region_rect>` | Rect2( 0, 0, 0, 0 ) |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
| :ref:`Texture<class_Texture>` | :ref:`texture<class_NinePatchRect_property_texture>` | null |
| :ref:`Texture<class_Texture>` | :ref:`texture<class_NinePatchRect_property_texture>` | |
+------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
Methods
-------
+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_patch_margin<class_NinePatchRect_method_get_patch_margin>` **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin **)** const |
+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_patch_margin<class_NinePatchRect_method_set_patch_margin>` **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`int<class_int>` value **)** |
+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -191,13 +200,22 @@ Rectangular region of the texture to sample from. If you're working with an atla
- :ref:`Texture<class_Texture>` **texture**
+-----------+--------------------+
| *Default* | null |
+-----------+--------------------+
| *Setter* | set_texture(value) |
+-----------+--------------------+
| *Getter* | get_texture() |
+-----------+--------------------+
+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture() |
+----------+--------------------+
The node's texture resource.
Method Descriptions
-------------------
.. _class_NinePatchRect_method_get_patch_margin:
- :ref:`int<class_int>` **get_patch_margin** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin **)** const
.. _class_NinePatchRect_method_set_patch_margin:
- void **set_patch_margin** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`int<class_int>` value **)**

View File

@@ -975,7 +975,7 @@ Queues a node for deletion at the end of the current frame. When deleted, all of
- void **raise** **(** **)**
Moves this node to the top of the array of nodes of the parent node. This is often useful in GUIs (:ref:`Control<class_Control>` nodes), because their order of drawing depends on their order in the tree.
Moves this node to the bottom of parent node's children hierarchy. This is often useful in GUIs (:ref:`Control<class_Control>` nodes), because their order of drawing depends on their order in the tree, i.e. the further they are on the node list, the higher they are drawn. After using ``raise``, a Control will be drawn on top of their siblings.
.. _class_Node_method_remove_and_skip:

View File

@@ -26,7 +26,7 @@ Properties
+-------------------------------------------------+-----------------------------------------------------------------+-------+
| :ref:`int<class_int>` | :ref:`height<class_NoiseTexture_property_height>` | 512 |
+-------------------------------------------------+-----------------------------------------------------------------+-------+
| :ref:`OpenSimplexNoise<class_OpenSimplexNoise>` | :ref:`noise<class_NoiseTexture_property_noise>` | null |
| :ref:`OpenSimplexNoise<class_OpenSimplexNoise>` | :ref:`noise<class_NoiseTexture_property_noise>` | |
+-------------------------------------------------+-----------------------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`seamless<class_NoiseTexture_property_seamless>` | false |
+-------------------------------------------------+-----------------------------------------------------------------+-------+
@@ -87,13 +87,11 @@ Height of the generated texture.
- :ref:`OpenSimplexNoise<class_OpenSimplexNoise>` **noise**
+-----------+------------------+
| *Default* | null |
+-----------+------------------+
| *Setter* | set_noise(value) |
+-----------+------------------+
| *Getter* | get_noise() |
+-----------+------------------+
+----------+------------------+
| *Setter* | set_noise(value) |
+----------+------------------+
| *Getter* | get_noise() |
+----------+------------------+
The :ref:`OpenSimplexNoise<class_OpenSimplexNoise>` instance used to generate the noise.

View File

@@ -73,33 +73,33 @@ Methods
Theme Properties
----------------
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | arrow | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`int<class_int>` | arrow_margin | 2 |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.941176, 0.941176, 0.941176, 1 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`int<class_int>` | hseparation | 2 |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed | |
+---------------------------------+---------------------+------------------------------------------+
+---------------------------------+---------------------+------------------------------+
| :ref:`Texture<class_Texture>` | arrow | |
+---------------------------------+---------------------+------------------------------+
| :ref:`int<class_int>` | arrow_margin | 2 |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled | |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+---------------------+------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.88, 0.88, 0.88, 1 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover | |
+---------------------------------+---------------------+------------------------------+
| :ref:`int<class_int>` | hseparation | 2 |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed | |
+---------------------------------+---------------------+------------------------------+
Signals
-------

View File

@@ -1068,7 +1068,7 @@ On Linux, this is ``~/.local/share/godot/app_userdata/[project_name]``, or ``~/.
On macOS, this is ``~/Library/Application Support/Godot/app_userdata/[project_name]``, or ``~/Library/Application Support/[custom_name]`` if ``use_custom_user_dir`` is set.
On Windows, this is ``%APPDATA%/Godot/app_userdata/[project_name]``, or ``%APPDATA%/[custom_name]`` if ``use_custom_user_dir`` is set.
On Windows, this is ``%APPDATA%\Godot\app_userdata\[project_name]``, or ``%APPDATA%\[custom_name]`` if ``use_custom_user_dir`` is set. ``%APPDATA%`` expands to ``%USERPROFILE%\AppData\Roaming``.
If the project name is empty, ``user://`` falls back to ``res://``.

View File

@@ -19,9 +19,9 @@ An abstraction of a serialized scene.
Properties
----------
+-------------------------------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`_bundled<class_PackedScene_property__bundled>` | { "conn_count": 0, "conns": PoolIntArray( ), "editable_instances": [ ], "names": PoolStringArray( ), "node_count": 0, "node_paths": [ ], "nodes": PoolIntArray( ), "variants": [ ], "version": 2 } |
+-------------------------------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`_bundled<class_PackedScene_property__bundled>` | {"conn_count": 0,"conns": PoolIntArray( ),"editable_instances": [ ],"names": PoolStringArray( ),"node_count": 0,"node_paths": [ ],"nodes": PoolIntArray( ),"variants": [ ],"version": 2} |
+-------------------------------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Methods
-------
@@ -97,9 +97,9 @@ Property Descriptions
- :ref:`Dictionary<class_Dictionary>` **_bundled**
+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| *Default* | { "conn_count": 0, "conns": PoolIntArray( ), "editable_instances": [ ], "names": PoolStringArray( ), "node_count": 0, "node_paths": [ ], "nodes": PoolIntArray( ), "variants": [ ], "version": 2 } |
+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| *Default* | {"conn_count": 0,"conns": PoolIntArray( ),"editable_instances": [ ],"names": PoolStringArray( ),"node_count": 0,"node_paths": [ ],"nodes": PoolIntArray( ),"variants": [ ],"version": 2} |
+-----------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
A dictionary representation of the scene contents.

View File

@@ -19,9 +19,9 @@ A type of :ref:`Sky<class_Sky>` used to draw a background texture.
Properties
----------
+-------------------------------+------------------------------------------------------+------+
| :ref:`Texture<class_Texture>` | :ref:`panorama<class_PanoramaSky_property_panorama>` | null |
+-------------------------------+------------------------------------------------------+------+
+-------------------------------+------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`panorama<class_PanoramaSky_property_panorama>` |
+-------------------------------+------------------------------------------------------+
Description
-----------
@@ -35,13 +35,11 @@ Property Descriptions
- :ref:`Texture<class_Texture>` **panorama**
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_panorama(value) |
+-----------+---------------------+
| *Getter* | get_panorama() |
+-----------+---------------------+
+----------+---------------------+
| *Setter* | set_panorama(value) |
+----------+---------------------+
| *Getter* | get_panorama() |
+----------+---------------------+
:ref:`Texture<class_Texture>` to be applied to the PanoramaSky.

View File

@@ -24,7 +24,7 @@ Properties
+--------------------------------------------+--------------------------------------------------------------------+-----------------------------+
| :ref:`DrawOrder<enum_Particles_DrawOrder>` | :ref:`draw_order<class_Particles_property_draw_order>` | 0 |
+--------------------------------------------+--------------------------------------------------------------------+-----------------------------+
| :ref:`Mesh<class_Mesh>` | :ref:`draw_pass_1<class_Particles_property_draw_pass_1>` | null |
| :ref:`Mesh<class_Mesh>` | :ref:`draw_pass_1<class_Particles_property_draw_pass_1>` | |
+--------------------------------------------+--------------------------------------------------------------------+-----------------------------+
| :ref:`Mesh<class_Mesh>` | :ref:`draw_pass_2<class_Particles_property_draw_pass_2>` | |
+--------------------------------------------+--------------------------------------------------------------------+-----------------------------+
@@ -50,7 +50,7 @@ Properties
+--------------------------------------------+--------------------------------------------------------------------+-----------------------------+
| :ref:`float<class_float>` | :ref:`preprocess<class_Particles_property_preprocess>` | 0.0 |
+--------------------------------------------+--------------------------------------------------------------------+-----------------------------+
| :ref:`Material<class_Material>` | :ref:`process_material<class_Particles_property_process_material>` | null |
| :ref:`Material<class_Material>` | :ref:`process_material<class_Particles_property_process_material>` | |
+--------------------------------------------+--------------------------------------------------------------------+-----------------------------+
| :ref:`float<class_float>` | :ref:`randomness<class_Particles_property_randomness>` | 0.0 |
+--------------------------------------------+--------------------------------------------------------------------+-----------------------------+
@@ -62,11 +62,15 @@ Properties
Methods
-------
+-------------------------+----------------------------------------------------------------------------+
| :ref:`AABB<class_AABB>` | :ref:`capture_aabb<class_Particles_method_capture_aabb>` **(** **)** const |
+-------------------------+----------------------------------------------------------------------------+
| void | :ref:`restart<class_Particles_method_restart>` **(** **)** |
+-------------------------+----------------------------------------------------------------------------+
+-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_AABB>` | :ref:`capture_aabb<class_Particles_method_capture_aabb>` **(** **)** const |
+-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Mesh<class_Mesh>` | :ref:`get_draw_pass_mesh<class_Particles_method_get_draw_pass_mesh>` **(** :ref:`int<class_int>` pass **)** const |
+-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`restart<class_Particles_method_restart>` **(** **)** |
+-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_draw_pass_mesh<class_Particles_method_set_draw_pass_mesh>` **(** :ref:`int<class_int>` pass, :ref:`Mesh<class_Mesh>` mesh **)** |
+-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
@@ -141,13 +145,11 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values.
- :ref:`Mesh<class_Mesh>` **draw_pass_1**
+-----------+---------------------------+
| *Default* | null |
+-----------+---------------------------+
| *Setter* | set_draw_pass_mesh(value) |
+-----------+---------------------------+
| *Getter* | get_draw_pass_mesh() |
+-----------+---------------------------+
+----------+---------------------------+
| *Setter* | set_draw_pass_mesh(value) |
+----------+---------------------------+
| *Getter* | get_draw_pass_mesh() |
+----------+---------------------------+
:ref:`Mesh<class_Mesh>` that is drawn for the first draw pass.
@@ -317,13 +319,11 @@ Amount of time to preprocess the particles before animation starts. Lets you sta
- :ref:`Material<class_Material>` **process_material**
+-----------+-----------------------------+
| *Default* | null |
+-----------+-----------------------------+
| *Setter* | set_process_material(value) |
+-----------+-----------------------------+
| *Getter* | get_process_material() |
+-----------+-----------------------------+
+----------+-----------------------------+
| *Setter* | set_process_material(value) |
+----------+-----------------------------+
| *Getter* | get_process_material() |
+----------+-----------------------------+
:ref:`Material<class_Material>` for processing particles. Can be a :ref:`ParticlesMaterial<class_ParticlesMaterial>` or a :ref:`ShaderMaterial<class_ShaderMaterial>`.
@@ -378,9 +378,17 @@ Method Descriptions
Returns the axis-aligned bounding box that contains all the particles that are active in the current frame.
.. _class_Particles_method_get_draw_pass_mesh:
- :ref:`Mesh<class_Mesh>` **get_draw_pass_mesh** **(** :ref:`int<class_int>` pass **)** const
.. _class_Particles_method_restart:
- void **restart** **(** **)**
Restarts the particle emission, clearing existing particles.
.. _class_Particles_method_set_draw_pass_mesh:
- void **set_draw_pass_mesh** **(** :ref:`int<class_int>` pass, :ref:`Mesh<class_Mesh>` mesh **)**

View File

@@ -36,19 +36,19 @@ Properties
+----------------------------------------------+----------------------------------------------------------------------+-------------------------------+
| :ref:`bool<class_bool>` | :ref:`local_coords<class_Particles2D_property_local_coords>` | true |
+----------------------------------------------+----------------------------------------------------------------------+-------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`normal_map<class_Particles2D_property_normal_map>` | null |
| :ref:`Texture<class_Texture>` | :ref:`normal_map<class_Particles2D_property_normal_map>` | |
+----------------------------------------------+----------------------------------------------------------------------+-------------------------------+
| :ref:`bool<class_bool>` | :ref:`one_shot<class_Particles2D_property_one_shot>` | false |
+----------------------------------------------+----------------------------------------------------------------------+-------------------------------+
| :ref:`float<class_float>` | :ref:`preprocess<class_Particles2D_property_preprocess>` | 0.0 |
+----------------------------------------------+----------------------------------------------------------------------+-------------------------------+
| :ref:`Material<class_Material>` | :ref:`process_material<class_Particles2D_property_process_material>` | null |
| :ref:`Material<class_Material>` | :ref:`process_material<class_Particles2D_property_process_material>` | |
+----------------------------------------------+----------------------------------------------------------------------+-------------------------------+
| :ref:`float<class_float>` | :ref:`randomness<class_Particles2D_property_randomness>` | 0.0 |
+----------------------------------------------+----------------------------------------------------------------------+-------------------------------+
| :ref:`float<class_float>` | :ref:`speed_scale<class_Particles2D_property_speed_scale>` | 1.0 |
+----------------------------------------------+----------------------------------------------------------------------+-------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`texture<class_Particles2D_property_texture>` | null |
| :ref:`Texture<class_Texture>` | :ref:`texture<class_Particles2D_property_texture>` | |
+----------------------------------------------+----------------------------------------------------------------------+-------------------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`visibility_rect<class_Particles2D_property_visibility_rect>` | Rect2( -100, -100, 200, 200 ) |
+----------------------------------------------+----------------------------------------------------------------------+-------------------------------+
@@ -208,13 +208,11 @@ If ``true``, particles use the parent node's coordinate space. If ``false``, the
- :ref:`Texture<class_Texture>` **normal_map**
+-----------+-----------------------+
| *Default* | null |
+-----------+-----------------------+
| *Setter* | set_normal_map(value) |
+-----------+-----------------------+
| *Getter* | get_normal_map() |
+-----------+-----------------------+
+----------+-----------------------+
| *Setter* | set_normal_map(value) |
+----------+-----------------------+
| *Getter* | get_normal_map() |
+----------+-----------------------+
Normal map to be used for the :ref:`texture<class_Particles2D_property_texture>` property.
@@ -250,13 +248,11 @@ Particle system starts as if it had already run for this many seconds.
- :ref:`Material<class_Material>` **process_material**
+-----------+-----------------------------+
| *Default* | null |
+-----------+-----------------------------+
| *Setter* | set_process_material(value) |
+-----------+-----------------------------+
| *Getter* | get_process_material() |
+-----------+-----------------------------+
+----------+-----------------------------+
| *Setter* | set_process_material(value) |
+----------+-----------------------------+
| *Getter* | get_process_material() |
+----------+-----------------------------+
:ref:`Material<class_Material>` for processing particles. Can be a :ref:`ParticlesMaterial<class_ParticlesMaterial>` or a :ref:`ShaderMaterial<class_ShaderMaterial>`.
@@ -292,13 +288,11 @@ Particle system's running speed scaling ratio. A value of ``0`` can be used to p
- :ref:`Texture<class_Texture>` **texture**
+-----------+--------------------+
| *Default* | null |
+-----------+--------------------+
| *Setter* | set_texture(value) |
+-----------+--------------------+
| *Getter* | get_texture() |
+-----------+--------------------+
+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture() |
+----------+--------------------+
Particle texture. If ``null``, particles will be squares.

View File

@@ -22,35 +22,35 @@ Properties
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`angle<class_ParticlesMaterial_property_angle>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`Texture<class_Texture>` | :ref:`angle_curve<class_ParticlesMaterial_property_angle_curve>` | null |
| :ref:`Texture<class_Texture>` | :ref:`angle_curve<class_ParticlesMaterial_property_angle_curve>` | |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`angle_random<class_ParticlesMaterial_property_angle_random>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`angular_velocity<class_ParticlesMaterial_property_angular_velocity>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`Texture<class_Texture>` | :ref:`angular_velocity_curve<class_ParticlesMaterial_property_angular_velocity_curve>` | null |
| :ref:`Texture<class_Texture>` | :ref:`angular_velocity_curve<class_ParticlesMaterial_property_angular_velocity_curve>` | |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`angular_velocity_random<class_ParticlesMaterial_property_angular_velocity_random>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`anim_offset<class_ParticlesMaterial_property_anim_offset>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`Texture<class_Texture>` | :ref:`anim_offset_curve<class_ParticlesMaterial_property_anim_offset_curve>` | null |
| :ref:`Texture<class_Texture>` | :ref:`anim_offset_curve<class_ParticlesMaterial_property_anim_offset_curve>` | |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`anim_offset_random<class_ParticlesMaterial_property_anim_offset_random>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`anim_speed<class_ParticlesMaterial_property_anim_speed>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`Texture<class_Texture>` | :ref:`anim_speed_curve<class_ParticlesMaterial_property_anim_speed_curve>` | null |
| :ref:`Texture<class_Texture>` | :ref:`anim_speed_curve<class_ParticlesMaterial_property_anim_speed_curve>` | |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`anim_speed_random<class_ParticlesMaterial_property_anim_speed_random>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`Color<class_Color>` | :ref:`color<class_ParticlesMaterial_property_color>` | Color( 1, 1, 1, 1 ) |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`Texture<class_Texture>` | :ref:`color_ramp<class_ParticlesMaterial_property_color_ramp>` | null |
| :ref:`Texture<class_Texture>` | :ref:`color_ramp<class_ParticlesMaterial_property_color_ramp>` | |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`damping<class_ParticlesMaterial_property_damping>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`Texture<class_Texture>` | :ref:`damping_curve<class_ParticlesMaterial_property_damping_curve>` | null |
| :ref:`Texture<class_Texture>` | :ref:`damping_curve<class_ParticlesMaterial_property_damping_curve>` | |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`damping_random<class_ParticlesMaterial_property_damping_random>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
@@ -82,7 +82,7 @@ Properties
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`hue_variation<class_ParticlesMaterial_property_hue_variation>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`Texture<class_Texture>` | :ref:`hue_variation_curve<class_ParticlesMaterial_property_hue_variation_curve>` | null |
| :ref:`Texture<class_Texture>` | :ref:`hue_variation_curve<class_ParticlesMaterial_property_hue_variation_curve>` | |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`hue_variation_random<class_ParticlesMaterial_property_hue_variation_random>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
@@ -90,9 +90,11 @@ Properties
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`initial_velocity_random<class_ParticlesMaterial_property_initial_velocity_random>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`lifetime_randomness<class_ParticlesMaterial_property_lifetime_randomness>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`linear_accel<class_ParticlesMaterial_property_linear_accel>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`Texture<class_Texture>` | :ref:`linear_accel_curve<class_ParticlesMaterial_property_linear_accel_curve>` | null |
| :ref:`Texture<class_Texture>` | :ref:`linear_accel_curve<class_ParticlesMaterial_property_linear_accel_curve>` | |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`linear_accel_random<class_ParticlesMaterial_property_linear_accel_random>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
@@ -104,13 +106,13 @@ Properties
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`radial_accel<class_ParticlesMaterial_property_radial_accel>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`Texture<class_Texture>` | :ref:`radial_accel_curve<class_ParticlesMaterial_property_radial_accel_curve>` | null |
| :ref:`Texture<class_Texture>` | :ref:`radial_accel_curve<class_ParticlesMaterial_property_radial_accel_curve>` | |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`radial_accel_random<class_ParticlesMaterial_property_radial_accel_random>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`scale<class_ParticlesMaterial_property_scale>` | 1.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`Texture<class_Texture>` | :ref:`scale_curve<class_ParticlesMaterial_property_scale_curve>` | null |
| :ref:`Texture<class_Texture>` | :ref:`scale_curve<class_ParticlesMaterial_property_scale_curve>` | |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`scale_random<class_ParticlesMaterial_property_scale_random>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
@@ -118,17 +120,38 @@ Properties
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`tangential_accel<class_ParticlesMaterial_property_tangential_accel>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`Texture<class_Texture>` | :ref:`tangential_accel_curve<class_ParticlesMaterial_property_tangential_accel_curve>` | null |
| :ref:`Texture<class_Texture>` | :ref:`tangential_accel_curve<class_ParticlesMaterial_property_tangential_accel_curve>` | |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`tangential_accel_random<class_ParticlesMaterial_property_tangential_accel_random>` | 0.0 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`GradientTexture<class_GradientTexture>` | :ref:`trail_color_modifier<class_ParticlesMaterial_property_trail_color_modifier>` | null |
| :ref:`GradientTexture<class_GradientTexture>` | :ref:`trail_color_modifier<class_ParticlesMaterial_property_trail_color_modifier>` | |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>` | :ref:`trail_divisor<class_ParticlesMaterial_property_trail_divisor>` | 1 |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
| :ref:`CurveTexture<class_CurveTexture>` | :ref:`trail_size_modifier<class_ParticlesMaterial_property_trail_size_modifier>` | null |
| :ref:`CurveTexture<class_CurveTexture>` | :ref:`trail_size_modifier<class_ParticlesMaterial_property_trail_size_modifier>` | |
+------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+
Methods
-------
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_flag<class_ParticlesMaterial_method_get_flag>` **(** :ref:`Flags<enum_ParticlesMaterial_Flags>` flag **)** const |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param<class_ParticlesMaterial_method_get_param>` **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param **)** const |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param_randomness<class_ParticlesMaterial_method_get_param_randomness>` **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param **)** const |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`get_param_texture<class_ParticlesMaterial_method_get_param_texture>` **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param **)** const |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flag<class_ParticlesMaterial_method_set_flag>` **(** :ref:`Flags<enum_ParticlesMaterial_Flags>` flag, :ref:`bool<class_bool>` enable **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param<class_ParticlesMaterial_method_set_param>` **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param, :ref:`float<class_float>` value **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param_randomness<class_ParticlesMaterial_method_set_param_randomness>` **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param, :ref:`float<class_float>` randomness **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param_texture<class_ParticlesMaterial_method_set_param_texture>` **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param, :ref:`Texture<class_Texture>` texture **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
@@ -264,13 +287,11 @@ Only applied when :ref:`flag_disable_z<class_ParticlesMaterial_property_flag_dis
- :ref:`Texture<class_Texture>` **angle_curve**
+-----------+--------------------------+
| *Default* | null |
+-----------+--------------------------+
| *Setter* | set_param_texture(value) |
+-----------+--------------------------+
| *Getter* | get_param_texture() |
+-----------+--------------------------+
+----------+--------------------------+
| *Setter* | set_param_texture(value) |
+----------+--------------------------+
| *Getter* | get_param_texture() |
+----------+--------------------------+
Each particle's rotation will be animated along this :ref:`CurveTexture<class_CurveTexture>`.
@@ -308,13 +329,11 @@ Only applied when :ref:`flag_disable_z<class_ParticlesMaterial_property_flag_dis
- :ref:`Texture<class_Texture>` **angular_velocity_curve**
+-----------+--------------------------+
| *Default* | null |
+-----------+--------------------------+
| *Setter* | set_param_texture(value) |
+-----------+--------------------------+
| *Getter* | get_param_texture() |
+-----------+--------------------------+
+----------+--------------------------+
| *Setter* | set_param_texture(value) |
+----------+--------------------------+
| *Getter* | get_param_texture() |
+----------+--------------------------+
Each particle's angular velocity will vary along this :ref:`CurveTexture<class_CurveTexture>`.
@@ -350,13 +369,11 @@ Particle animation offset.
- :ref:`Texture<class_Texture>` **anim_offset_curve**
+-----------+--------------------------+
| *Default* | null |
+-----------+--------------------------+
| *Setter* | set_param_texture(value) |
+-----------+--------------------------+
| *Getter* | get_param_texture() |
+-----------+--------------------------+
+----------+--------------------------+
| *Setter* | set_param_texture(value) |
+----------+--------------------------+
| *Getter* | get_param_texture() |
+----------+--------------------------+
Each particle's animation offset will vary along this :ref:`CurveTexture<class_CurveTexture>`.
@@ -392,13 +409,11 @@ Particle animation speed.
- :ref:`Texture<class_Texture>` **anim_speed_curve**
+-----------+--------------------------+
| *Default* | null |
+-----------+--------------------------+
| *Setter* | set_param_texture(value) |
+-----------+--------------------------+
| *Getter* | get_param_texture() |
+-----------+--------------------------+
+----------+--------------------------+
| *Setter* | set_param_texture(value) |
+----------+--------------------------+
| *Getter* | get_param_texture() |
+----------+--------------------------+
Each particle's animation speed will vary along this :ref:`CurveTexture<class_CurveTexture>`.
@@ -434,13 +449,11 @@ Each particle's initial color. If the :ref:`Particles2D<class_Particles2D>`'s ``
- :ref:`Texture<class_Texture>` **color_ramp**
+-----------+-----------------------+
| *Default* | null |
+-----------+-----------------------+
| *Setter* | set_color_ramp(value) |
+-----------+-----------------------+
| *Getter* | get_color_ramp() |
+-----------+-----------------------+
+----------+-----------------------+
| *Setter* | set_color_ramp(value) |
+----------+-----------------------+
| *Getter* | get_color_ramp() |
+----------+-----------------------+
Each particle's color will vary along this :ref:`GradientTexture<class_GradientTexture>`.
@@ -462,13 +475,11 @@ The rate at which particles lose velocity.
- :ref:`Texture<class_Texture>` **damping_curve**
+-----------+--------------------------+
| *Default* | null |
+-----------+--------------------------+
| *Setter* | set_param_texture(value) |
+-----------+--------------------------+
| *Getter* | get_param_texture() |
+-----------+--------------------------+
+----------+--------------------------+
| *Setter* | set_param_texture(value) |
+----------+--------------------------+
| *Getter* | get_param_texture() |
+----------+--------------------------+
Damping will vary along this :ref:`CurveTexture<class_CurveTexture>`.
@@ -674,13 +685,11 @@ Initial hue variation applied to each particle.
- :ref:`Texture<class_Texture>` **hue_variation_curve**
+-----------+--------------------------+
| *Default* | null |
+-----------+--------------------------+
| *Setter* | set_param_texture(value) |
+-----------+--------------------------+
| *Getter* | get_param_texture() |
+-----------+--------------------------+
+----------+--------------------------+
| *Setter* | set_param_texture(value) |
+----------+--------------------------+
| *Getter* | get_param_texture() |
+----------+--------------------------+
Each particle's hue will vary along this :ref:`CurveTexture<class_CurveTexture>`.
@@ -726,6 +735,20 @@ Initial velocity magnitude for each particle. Direction comes from :ref:`spread<
Initial velocity randomness ratio.
.. _class_ParticlesMaterial_property_lifetime_randomness:
- :ref:`float<class_float>` **lifetime_randomness**
+-----------+--------------------------------+
| *Default* | 0.0 |
+-----------+--------------------------------+
| *Setter* | set_lifetime_randomness(value) |
+-----------+--------------------------------+
| *Getter* | get_lifetime_randomness() |
+-----------+--------------------------------+
Particle lifetime randomness ratio.
.. _class_ParticlesMaterial_property_linear_accel:
- :ref:`float<class_float>` **linear_accel**
@@ -744,13 +767,11 @@ Linear acceleration applied to each particle in the direction of motion.
- :ref:`Texture<class_Texture>` **linear_accel_curve**
+-----------+--------------------------+
| *Default* | null |
+-----------+--------------------------+
| *Setter* | set_param_texture(value) |
+-----------+--------------------------+
| *Getter* | get_param_texture() |
+-----------+--------------------------+
+----------+--------------------------+
| *Setter* | set_param_texture(value) |
+----------+--------------------------+
| *Getter* | get_param_texture() |
+----------+--------------------------+
Each particle's linear acceleration will vary along this :ref:`CurveTexture<class_CurveTexture>`.
@@ -824,13 +845,11 @@ Radial acceleration applied to each particle. Makes particle accelerate away fro
- :ref:`Texture<class_Texture>` **radial_accel_curve**
+-----------+--------------------------+
| *Default* | null |
+-----------+--------------------------+
| *Setter* | set_param_texture(value) |
+-----------+--------------------------+
| *Getter* | get_param_texture() |
+-----------+--------------------------+
+----------+--------------------------+
| *Setter* | set_param_texture(value) |
+----------+--------------------------+
| *Getter* | get_param_texture() |
+----------+--------------------------+
Each particle's radial acceleration will vary along this :ref:`CurveTexture<class_CurveTexture>`.
@@ -866,13 +885,11 @@ Initial scale applied to each particle.
- :ref:`Texture<class_Texture>` **scale_curve**
+-----------+--------------------------+
| *Default* | null |
+-----------+--------------------------+
| *Setter* | set_param_texture(value) |
+-----------+--------------------------+
| *Getter* | get_param_texture() |
+-----------+--------------------------+
+----------+--------------------------+
| *Setter* | set_param_texture(value) |
+----------+--------------------------+
| *Getter* | get_param_texture() |
+----------+--------------------------+
Each particle's scale will vary along this :ref:`CurveTexture<class_CurveTexture>`.
@@ -922,13 +939,11 @@ Tangential acceleration applied to each particle. Tangential acceleration is per
- :ref:`Texture<class_Texture>` **tangential_accel_curve**
+-----------+--------------------------+
| *Default* | null |
+-----------+--------------------------+
| *Setter* | set_param_texture(value) |
+-----------+--------------------------+
| *Getter* | get_param_texture() |
+-----------+--------------------------+
+----------+--------------------------+
| *Setter* | set_param_texture(value) |
+----------+--------------------------+
| *Getter* | get_param_texture() |
+----------+--------------------------+
Each particle's tangential acceleration will vary along this :ref:`CurveTexture<class_CurveTexture>`.
@@ -950,13 +965,11 @@ Tangential acceleration randomness ratio.
- :ref:`GradientTexture<class_GradientTexture>` **trail_color_modifier**
+-----------+---------------------------------+
| *Default* | null |
+-----------+---------------------------------+
| *Setter* | set_trail_color_modifier(value) |
+-----------+---------------------------------+
| *Getter* | get_trail_color_modifier() |
+-----------+---------------------------------+
+----------+---------------------------------+
| *Setter* | set_trail_color_modifier(value) |
+----------+---------------------------------+
| *Getter* | get_trail_color_modifier() |
+----------+---------------------------------+
Trail particles' color will vary along this :ref:`GradientTexture<class_GradientTexture>`.
@@ -978,13 +991,46 @@ Emitter will emit ``amount`` divided by ``trail_divisor`` particles. The remaini
- :ref:`CurveTexture<class_CurveTexture>` **trail_size_modifier**
+-----------+--------------------------------+
| *Default* | null |
+-----------+--------------------------------+
| *Setter* | set_trail_size_modifier(value) |
+-----------+--------------------------------+
| *Getter* | get_trail_size_modifier() |
+-----------+--------------------------------+
+----------+--------------------------------+
| *Setter* | set_trail_size_modifier(value) |
+----------+--------------------------------+
| *Getter* | get_trail_size_modifier() |
+----------+--------------------------------+
Trail particles' size will vary along this :ref:`CurveTexture<class_CurveTexture>`.
Method Descriptions
-------------------
.. _class_ParticlesMaterial_method_get_flag:
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_ParticlesMaterial_Flags>` flag **)** const
.. _class_ParticlesMaterial_method_get_param:
- :ref:`float<class_float>` **get_param** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param **)** const
.. _class_ParticlesMaterial_method_get_param_randomness:
- :ref:`float<class_float>` **get_param_randomness** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param **)** const
.. _class_ParticlesMaterial_method_get_param_texture:
- :ref:`Texture<class_Texture>` **get_param_texture** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param **)** const
.. _class_ParticlesMaterial_method_set_flag:
- void **set_flag** **(** :ref:`Flags<enum_ParticlesMaterial_Flags>` flag, :ref:`bool<class_bool>` enable **)**
.. _class_ParticlesMaterial_method_set_param:
- void **set_param** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
.. _class_ParticlesMaterial_method_set_param_randomness:
- void **set_param_randomness** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param, :ref:`float<class_float>` randomness **)**
.. _class_ParticlesMaterial_method_set_param_texture:
- void **set_param_texture** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param, :ref:`Texture<class_Texture>` texture **)**

View File

@@ -19,9 +19,9 @@ Contains a :ref:`Curve3D<class_Curve3D>` path for :ref:`PathFollow<class_PathFol
Properties
----------
+-------------------------------+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Curve3D<class_Curve3D>` | :ref:`curve<class_Path_property_curve>` | Object(Curve3D,"resource_local_to_scene":false,"resource_name":"","bake_interval":0.2,"_data":{ "points": PoolVector3Array( ), "tilts": PoolRealArray( ) },"up_vector_enabled":true,"script":null) |
+-------------------------------+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------+-----------------------------------------+
| :ref:`Curve3D<class_Curve3D>` | :ref:`curve<class_Path_property_curve>` |
+-------------------------------+-----------------------------------------+
Signals
-------
@@ -46,13 +46,11 @@ Property Descriptions
- :ref:`Curve3D<class_Curve3D>` **curve**
+-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| *Default* | Object(Curve3D,"resource_local_to_scene":false,"resource_name":"","bake_interval":0.2,"_data":{ "points": PoolVector3Array( ), "tilts": PoolRealArray( ) },"up_vector_enabled":true,"script":null) |
+-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| *Setter* | set_curve(value) |
+-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| *Getter* | get_curve() |
+-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------+------------------+
| *Setter* | set_curve(value) |
+----------+------------------+
| *Getter* | get_curve() |
+----------+------------------+
A :ref:`Curve3D<class_Curve3D>` describing the path.

View File

@@ -19,9 +19,9 @@ Contains a :ref:`Curve2D<class_Curve2D>` path for :ref:`PathFollow2D<class_PathF
Properties
----------
+-------------------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Curve2D<class_Curve2D>` | :ref:`curve<class_Path2D_property_curve>` | Object(Curve2D,"resource_local_to_scene":false,"resource_name":"","bake_interval":5.0,"_data":{ "points": PoolVector2Array( ) },"script":null) |
+-------------------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------+-------------------------------------------+
| :ref:`Curve2D<class_Curve2D>` | :ref:`curve<class_Path2D_property_curve>` |
+-------------------------------+-------------------------------------------+
Description
-----------
@@ -37,13 +37,11 @@ Property Descriptions
- :ref:`Curve2D<class_Curve2D>` **curve**
+-----------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| *Default* | Object(Curve2D,"resource_local_to_scene":false,"resource_name":"","bake_interval":5.0,"_data":{ "points": PoolVector2Array( ) },"script":null) |
+-----------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| *Setter* | set_curve(value) |
+-----------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| *Getter* | get_curve() |
+-----------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+----------+------------------+
| *Setter* | set_curve(value) |
+----------+------------------+
| *Getter* | get_curve() |
+----------+------------------+
A :ref:`Curve2D<class_Curve2D>` describing the path.

View File

@@ -20,7 +20,7 @@ Properties
----------
+-------------------------------+--------------------------------------------------------------------------------------+-----------------+
| :ref:`Object<class_Object>` | :ref:`collider<class_Physics2DTestMotionResult_property_collider>` | null |
| :ref:`Object<class_Object>` | :ref:`collider<class_Physics2DTestMotionResult_property_collider>` | |
+-------------------------------+--------------------------------------------------------------------------------------+-----------------+
| :ref:`int<class_int>` | :ref:`collider_id<class_Physics2DTestMotionResult_property_collider_id>` | 0 |
+-------------------------------+--------------------------------------------------------------------------------------+-----------------+
@@ -46,11 +46,9 @@ Property Descriptions
- :ref:`Object<class_Object>` **collider**
+-----------+----------------+
| *Default* | null |
+-----------+----------------+
| *Getter* | get_collider() |
+-----------+----------------+
+----------+----------------+
| *Getter* | get_collider() |
+----------+----------------+
.. _class_Physics2DTestMotionResult_property_collider_id:

View File

@@ -27,6 +27,15 @@ Properties
| :ref:`float<class_float>` | :ref:`params/impulse_clamp<class_PinJoint_property_params/impulse_clamp>` | 0.0 |
+---------------------------+---------------------------------------------------------------------------+-----+
Methods
-------
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param<class_PinJoint_method_get_param>` **(** :ref:`Param<enum_PinJoint_Param>` param **)** const |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param<class_PinJoint_method_set_param>` **(** :ref:`Param<enum_PinJoint_Param>` param, :ref:`float<class_float>` value **)** |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
@@ -96,3 +105,14 @@ The force with which the pinned objects stay in velocity relation to each other.
If above 0, this value is the maximum value for an impulse that this Joint produces.
Method Descriptions
-------------------
.. _class_PinJoint_method_get_param:
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_PinJoint_Param>` param **)** const
.. _class_PinJoint_method_set_param:
- void **set_param** **(** :ref:`Param<enum_PinJoint_Param>` param, :ref:`float<class_float>` value **)**

View File

@@ -40,7 +40,7 @@ Properties
+-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`skeleton<class_Polygon2D_property_skeleton>` | NodePath("") |
+-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+
| :ref:`Texture<class_Texture>` | :ref:`texture<class_Polygon2D_property_texture>` | null |
| :ref:`Texture<class_Texture>` | :ref:`texture<class_Polygon2D_property_texture>` | |
+-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`texture_offset<class_Polygon2D_property_texture_offset>` | Vector2( 0, 0 ) |
+-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+
@@ -218,13 +218,11 @@ The polygon's list of vertices. The final point will be connected to the first.
- :ref:`Texture<class_Texture>` **texture**
+-----------+--------------------+
| *Default* | null |
+-----------+--------------------+
| *Setter* | set_texture(value) |
+-----------+--------------------+
| *Getter* | get_texture() |
+-----------+--------------------+
+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture() |
+----------+--------------------+
The polygon's fill texture. Use ``uv`` to set texture coordinates.

View File

@@ -137,43 +137,43 @@ Methods
Theme Properties
----------------
+---------------------------------+-------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | checked | |
+---------------------------------+-------------------------+------------------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+-------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) |
+---------------------------------+-------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_accel | Color( 0.7, 0.7, 0.7, 0.8 ) |
+---------------------------------+-------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.4, 0.4, 0.4, 0.8 ) |
+---------------------------------+-------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.878431, 0.878431, 0.878431, 1 ) |
+---------------------------------+-------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover | |
+---------------------------------+-------------------------+------------------------------------------+
| :ref:`int<class_int>` | hseparation | 4 |
+---------------------------------+-------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | labeled_separator_left | |
+---------------------------------+-------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | labeled_separator_right | |
+---------------------------------+-------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | panel | |
+---------------------------------+-------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | panel_disabled | |
+---------------------------------+-------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | radio_checked | |
+---------------------------------+-------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | radio_unchecked | |
+---------------------------------+-------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | separator | |
+---------------------------------+-------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | submenu | |
+---------------------------------+-------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | unchecked | |
+---------------------------------+-------------------------+------------------------------------------+
| :ref:`int<class_int>` | vseparation | 4 |
+---------------------------------+-------------------------+------------------------------------------+
+---------------------------------+-------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | checked | |
+---------------------------------+-------------------------+------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+-------------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.88, 0.88, 0.88, 1 ) |
+---------------------------------+-------------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_accel | Color( 0.7, 0.7, 0.7, 0.8 ) |
+---------------------------------+-------------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.4, 0.4, 0.4, 0.8 ) |
+---------------------------------+-------------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.88, 0.88, 0.88, 1 ) |
+---------------------------------+-------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover | |
+---------------------------------+-------------------------+------------------------------+
| :ref:`int<class_int>` | hseparation | 4 |
+---------------------------------+-------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | labeled_separator_left | |
+---------------------------------+-------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | labeled_separator_right | |
+---------------------------------+-------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | panel | |
+---------------------------------+-------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | panel_disabled | |
+---------------------------------+-------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | radio_checked | |
+---------------------------------+-------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | radio_unchecked | |
+---------------------------------+-------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | separator | |
+---------------------------------+-------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | submenu | |
+---------------------------------+-------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | unchecked | |
+---------------------------------+-------------------------+------------------------------+
| :ref:`int<class_int>` | vseparation | 4 |
+---------------------------------+-------------------------+------------------------------+
Signals
-------

View File

@@ -26,7 +26,7 @@ Properties
+---------------------------------+--------------------------------------------------------------+--------------------------+
| :ref:`bool<class_bool>` | :ref:`flip_faces<class_PrimitiveMesh_property_flip_faces>` | false |
+---------------------------------+--------------------------------------------------------------+--------------------------+
| :ref:`Material<class_Material>` | :ref:`material<class_PrimitiveMesh_property_material>` | null |
| :ref:`Material<class_Material>` | :ref:`material<class_PrimitiveMesh_property_material>` | |
+---------------------------------+--------------------------------------------------------------+--------------------------+
Methods
@@ -76,13 +76,11 @@ If set, the order of the vertices in each triangle are reversed resulting in the
- :ref:`Material<class_Material>` **material**
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_material(value) |
+-----------+---------------------+
| *Getter* | get_material() |
+-----------+---------------------+
+----------+---------------------+
| *Setter* | set_material(value) |
+----------+---------------------+
| *Getter* | get_material() |
+----------+---------------------+
The current :ref:`Material<class_Material>` of the primitive mesh.

View File

@@ -26,17 +26,17 @@ Properties
Theme Properties
----------------
+---------------------------------+-------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | bg | |
+---------------------------------+-------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | fg | |
+---------------------------------+-------------------+------------------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+-------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.941176, 0.941176, 0.941176, 1 ) |
+---------------------------------+-------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_shadow | Color( 0, 0, 0, 1 ) |
+---------------------------------+-------------------+------------------------------------------+
+---------------------------------+-------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | bg | |
+---------------------------------+-------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | fg | |
+---------------------------------+-------------------+------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+-------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.94, 0.94, 0.94, 1 ) |
+---------------------------------+-------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_shadow | Color( 0, 0, 0, 1 ) |
+---------------------------------+-------------------+------------------------------+
Description
-----------

File diff suppressed because it is too large Load Diff

View File

@@ -19,9 +19,9 @@ Brief Description
Properties
----------
+-------------------------------+-----------------------------------------------+------+
| :ref:`Texture<class_Texture>` | :ref:`base<class_ProxyTexture_property_base>` | null |
+-------------------------------+-----------------------------------------------+------+
+-------------------------------+-----------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`base<class_ProxyTexture_property_base>` |
+-------------------------------+-----------------------------------------------+
Property Descriptions
---------------------
@@ -30,11 +30,9 @@ Property Descriptions
- :ref:`Texture<class_Texture>` **base**
+-----------+-----------------+
| *Default* | null |
+-----------+-----------------+
| *Setter* | set_base(value) |
+-----------+-----------------+
| *Getter* | get_base() |
+-----------+-----------------+
+----------+-----------------+
| *Setter* | set_base(value) |
+----------+-----------------+
| *Getter* | get_base() |
+----------+-----------------+

View File

@@ -20,7 +20,7 @@ Properties
----------
+-------------------------------------+---------------------------------------------------+------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`names<class_RegExMatch_property_names>` | { } |
| :ref:`Dictionary<class_Dictionary>` | :ref:`names<class_RegExMatch_property_names>` | {} |
+-------------------------------------+---------------------------------------------------+------+
| :ref:`Array<class_Array>` | :ref:`strings<class_RegExMatch_property_strings>` | [ ] |
+-------------------------------------+---------------------------------------------------+------+
@@ -53,7 +53,7 @@ Property Descriptions
- :ref:`Dictionary<class_Dictionary>` **names**
+-----------+-------------+
| *Default* | { } |
| *Default* | {} |
+-----------+-------------+
| *Getter* | get_names() |
+-----------+-------------+

View File

@@ -31,6 +31,13 @@ Properties
| :ref:`bool<class_bool>` | :ref:`use_global_coordinates<class_RemoteTransform_property_use_global_coordinates>` | true |
+---------------------------------+--------------------------------------------------------------------------------------+--------------+
Methods
-------
+------+----------------------------------------------------------------------------------------+
| void | :ref:`force_update_cache<class_RemoteTransform_method_force_update_cache>` **(** **)** |
+------+----------------------------------------------------------------------------------------+
Description
-----------
@@ -111,3 +118,12 @@ If ``true``, the remote node's scale is updated.
If ``true``, global coordinates are used. If ``false``, local coordinates are used.
Method Descriptions
-------------------
.. _class_RemoteTransform_method_force_update_cache:
- void **force_update_cache** **(** **)**
``RemoteTransform`` caches the remote node. It may not notice if the remote node disappears; :ref:`force_update_cache<class_RemoteTransform_method_force_update_cache>` forces it to update the cache again.

View File

@@ -31,6 +31,13 @@ Properties
| :ref:`bool<class_bool>` | :ref:`use_global_coordinates<class_RemoteTransform2D_property_use_global_coordinates>` | true |
+---------------------------------+----------------------------------------------------------------------------------------+--------------+
Methods
-------
+------+------------------------------------------------------------------------------------------+
| void | :ref:`force_update_cache<class_RemoteTransform2D_method_force_update_cache>` **(** **)** |
+------+------------------------------------------------------------------------------------------+
Description
-----------
@@ -111,3 +118,12 @@ If ``true``, the remote node's scale is updated.
If ``true``, global coordinates are used. If ``false``, local coordinates are used.
Method Descriptions
-------------------
.. _class_RemoteTransform2D_method_force_update_cache:
- void **force_update_cache** **(** **)**
``RemoteTransform2D`` caches the remote node. It may not notice if the remote node disappears; :ref:`force_update_cache<class_RemoteTransform2D_method_force_update_cache>` forces it to update the cache again.

View File

@@ -101,41 +101,41 @@ Methods
Theme Properties
----------------
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Font<class_Font>` | bold_font | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Font<class_Font>` | bold_italics_font | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | default_color | Color( 1, 1, 1, 1 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_selected | Color( 0.490196, 0.490196, 0.490196, 1 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_shadow | Color( 0, 0, 0, 0 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Font<class_Font>` | italics_font | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`int<class_int>` | line_separation | 1 |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Font<class_Font>` | mono_font | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Font<class_Font>` | normal_font | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | selection_color | Color( 0.1, 0.1, 1, 0.8 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`int<class_int>` | shadow_as_outline | 0 |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`int<class_int>` | shadow_offset_x | 1 |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`int<class_int>` | shadow_offset_y | 1 |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`int<class_int>` | table_hseparation | 3 |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`int<class_int>` | table_vseparation | 3 |
+---------------------------------+---------------------+------------------------------------------+
+---------------------------------+---------------------+------------------------------+
| :ref:`Font<class_Font>` | bold_font | |
+---------------------------------+---------------------+------------------------------+
| :ref:`Font<class_Font>` | bold_italics_font | |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | default_color | Color( 1, 1, 1, 1 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_selected | Color( 0.49, 0.49, 0.49, 1 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_shadow | Color( 0, 0, 0, 0 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`Font<class_Font>` | italics_font | |
+---------------------------------+---------------------+------------------------------+
| :ref:`int<class_int>` | line_separation | 1 |
+---------------------------------+---------------------+------------------------------+
| :ref:`Font<class_Font>` | mono_font | |
+---------------------------------+---------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+---------------------+------------------------------+
| :ref:`Font<class_Font>` | normal_font | |
+---------------------------------+---------------------+------------------------------+
| :ref:`Color<class_Color>` | selection_color | Color( 0.1, 0.1, 1, 0.8 ) |
+---------------------------------+---------------------+------------------------------+
| :ref:`int<class_int>` | shadow_as_outline | 0 |
+---------------------------------+---------------------+------------------------------+
| :ref:`int<class_int>` | shadow_offset_x | 1 |
+---------------------------------+---------------------+------------------------------+
| :ref:`int<class_int>` | shadow_offset_y | 1 |
+---------------------------------+---------------------+------------------------------+
| :ref:`int<class_int>` | table_hseparation | 3 |
+---------------------------------+---------------------+------------------------------+
| :ref:`int<class_int>` | table_vseparation | 3 |
+---------------------------------+---------------------+------------------------------+
Signals
-------

View File

@@ -62,7 +62,7 @@ Properties
+-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+
| :ref:`Mode<enum_RigidBody_Mode>` | :ref:`mode<class_RigidBody_property_mode>` | 0 |
+-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+
| :ref:`PhysicsMaterial<class_PhysicsMaterial>` | :ref:`physics_material_override<class_RigidBody_property_physics_material_override>` | null |
| :ref:`PhysicsMaterial<class_PhysicsMaterial>` | :ref:`physics_material_override<class_RigidBody_property_physics_material_override>` | |
+-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+
| :ref:`bool<class_bool>` | :ref:`sleeping<class_RigidBody_property_sleeping>` | false |
+-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+
@@ -87,8 +87,12 @@ Methods
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`apply_torque_impulse<class_RigidBody_method_apply_torque_impulse>` **(** :ref:`Vector3<class_Vector3>` impulse **)** |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_axis_lock<class_RigidBody_method_get_axis_lock>` **(** :ref:`BodyAxis<enum_PhysicsServer_BodyAxis>` axis **)** const |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_colliding_bodies<class_RigidBody_method_get_colliding_bodies>` **(** **)** const |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_axis_lock<class_RigidBody_method_set_axis_lock>` **(** :ref:`BodyAxis<enum_PhysicsServer_BodyAxis>` axis, :ref:`bool<class_bool>` lock **)** |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_axis_velocity<class_RigidBody_method_set_axis_velocity>` **(** :ref:`Vector3<class_Vector3>` axis_velocity **)** |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -457,13 +461,11 @@ The body mode. See :ref:`Mode<enum_RigidBody_Mode>` for possible values.
- :ref:`PhysicsMaterial<class_PhysicsMaterial>` **physics_material_override**
+-----------+--------------------------------------+
| *Default* | null |
+-----------+--------------------------------------+
| *Setter* | set_physics_material_override(value) |
+-----------+--------------------------------------+
| *Getter* | get_physics_material_override() |
+-----------+--------------------------------------+
+----------+--------------------------------------+
| *Setter* | set_physics_material_override(value) |
+----------+--------------------------------------+
| *Getter* | get_physics_material_override() |
+----------+--------------------------------------+
.. _class_RigidBody_property_sleeping:
@@ -542,6 +544,10 @@ Applies a positioned impulse to the body. An impulse is time independent! Applyi
Applies a torque impulse which will be affected by the body mass and shape. This will rotate the body around the ``impulse`` vector passed.
.. _class_RigidBody_method_get_axis_lock:
- :ref:`bool<class_bool>` **get_axis_lock** **(** :ref:`BodyAxis<enum_PhysicsServer_BodyAxis>` axis **)** const
.. _class_RigidBody_method_get_colliding_bodies:
- :ref:`Array<class_Array>` **get_colliding_bodies** **(** **)** const
@@ -550,6 +556,10 @@ Returns a list of the bodies colliding with this one. By default, number of max
**Note:** The result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead.
.. _class_RigidBody_method_set_axis_lock:
- void **set_axis_lock** **(** :ref:`BodyAxis<enum_PhysicsServer_BodyAxis>` axis, :ref:`bool<class_bool>` lock **)**
.. _class_RigidBody_method_set_axis_velocity:
- void **set_axis_velocity** **(** :ref:`Vector3<class_Vector3>` axis_velocity **)**

View File

@@ -54,7 +54,7 @@ Properties
+-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+
| :ref:`Mode<enum_RigidBody2D_Mode>` | :ref:`mode<class_RigidBody2D_property_mode>` | 0 |
+-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+
| :ref:`PhysicsMaterial<class_PhysicsMaterial>` | :ref:`physics_material_override<class_RigidBody2D_property_physics_material_override>` | null |
| :ref:`PhysicsMaterial<class_PhysicsMaterial>` | :ref:`physics_material_override<class_RigidBody2D_property_physics_material_override>` | |
+-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+
| :ref:`bool<class_bool>` | :ref:`sleeping<class_RigidBody2D_property_sleeping>` | false |
+-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+
@@ -416,13 +416,11 @@ The body's mode. See :ref:`Mode<enum_RigidBody2D_Mode>` for possible values.
- :ref:`PhysicsMaterial<class_PhysicsMaterial>` **physics_material_override**
+-----------+--------------------------------------+
| *Default* | null |
+-----------+--------------------------------------+
| *Setter* | set_physics_material_override(value) |
+-----------+--------------------------------------+
| *Getter* | get_physics_material_override() |
+-----------+--------------------------------------+
+----------+--------------------------------------+
| *Setter* | set_physics_material_override(value) |
+----------+--------------------------------------+
| *Getter* | get_physics_material_override() |
+----------+--------------------------------------+
.. _class_RigidBody2D_property_sleeping:

View File

@@ -19,9 +19,9 @@ A material that uses a custom :ref:`Shader<class_Shader>` program.
Properties
----------
+-----------------------------+-----------------------------------------------------+------+
| :ref:`Shader<class_Shader>` | :ref:`shader<class_ShaderMaterial_property_shader>` | null |
+-----------------------------+-----------------------------------------------------+------+
+-----------------------------+-----------------------------------------------------+
| :ref:`Shader<class_Shader>` | :ref:`shader<class_ShaderMaterial_property_shader>` |
+-----------------------------+-----------------------------------------------------+
Methods
-------
@@ -53,13 +53,11 @@ Property Descriptions
- :ref:`Shader<class_Shader>` **shader**
+-----------+-------------------+
| *Default* | null |
+-----------+-------------------+
| *Setter* | set_shader(value) |
+-----------+-------------------+
| *Getter* | get_shader() |
+-----------+-------------------+
+----------+-------------------+
| *Setter* | set_shader(value) |
+----------+-------------------+
| *Getter* | get_shader() |
+----------+-------------------+
The :ref:`Shader<class_Shader>` program used to render this material.

View File

@@ -19,9 +19,9 @@ A shortcut for binding input.
Properties
----------
+-------------------------------------+---------------------------------------------------+------+
| :ref:`InputEvent<class_InputEvent>` | :ref:`shortcut<class_ShortCut_property_shortcut>` | null |
+-------------------------------------+---------------------------------------------------+------+
+-------------------------------------+---------------------------------------------------+
| :ref:`InputEvent<class_InputEvent>` | :ref:`shortcut<class_ShortCut_property_shortcut>` |
+-------------------------------------+---------------------------------------------------+
Methods
-------
@@ -48,13 +48,11 @@ Property Descriptions
- :ref:`InputEvent<class_InputEvent>` **shortcut**
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_shortcut(value) |
+-----------+---------------------+
| *Getter* | get_shortcut() |
+-----------+---------------------+
+----------+---------------------+
| *Setter* | set_shortcut(value) |
+----------+---------------------+
| *Getter* | get_shortcut() |
+----------+---------------------+
The shortcut's :ref:`InputEvent<class_InputEvent>`.

View File

@@ -65,6 +65,15 @@ Properties
| :ref:`float<class_float>` | :ref:`linear_ortho/softness<class_SliderJoint_property_linear_ortho/softness>` | 1.0 |
+---------------------------+--------------------------------------------------------------------------------------------+------+
Methods
-------
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param<class_SliderJoint_method_get_param>` **(** :ref:`Param<enum_SliderJoint_Param>` param **)** const |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param<class_SliderJoint_method_set_param>` **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)** |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
@@ -478,3 +487,14 @@ The amount of restitution when movement is across axes orthogonal to the slider.
A factor applied to the movement across axes orthogonal to the slider.
Method Descriptions
-------------------
.. _class_SliderJoint_method_get_param:
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_SliderJoint_Param>` param **)** const
.. _class_SliderJoint_method_set_param:
- void **set_param** **(** :ref:`Param<enum_SliderJoint_Param>` param, :ref:`float<class_float>` value **)**

View File

@@ -22,7 +22,7 @@ Properties
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`Color<class_Color>` | :ref:`albedo_color<class_SpatialMaterial_property_albedo_color>` | Color( 1, 1, 1, 1 ) |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`Texture<class_Texture>` | :ref:`albedo_texture<class_SpatialMaterial_property_albedo_texture>` | null |
| :ref:`Texture<class_Texture>` | :ref:`albedo_texture<class_SpatialMaterial_property_albedo_texture>` | |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`anisotropy<class_SpatialMaterial_property_anisotropy>` | |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
@@ -122,7 +122,7 @@ Properties
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`metallic_specular<class_SpatialMaterial_property_metallic_specular>` | 0.5 |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`Texture<class_Texture>` | :ref:`metallic_texture<class_SpatialMaterial_property_metallic_texture>` | null |
| :ref:`Texture<class_Texture>` | :ref:`metallic_texture<class_SpatialMaterial_property_metallic_texture>` | |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`TextureChannel<enum_SpatialMaterial_TextureChannel>` | :ref:`metallic_texture_channel<class_SpatialMaterial_property_metallic_texture_channel>` | 2 |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
@@ -186,7 +186,7 @@ Properties
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`roughness<class_SpatialMaterial_property_roughness>` | 1.0 |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`Texture<class_Texture>` | :ref:`roughness_texture<class_SpatialMaterial_property_roughness_texture>` | null |
| :ref:`Texture<class_Texture>` | :ref:`roughness_texture<class_SpatialMaterial_property_roughness_texture>` | |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`TextureChannel<enum_SpatialMaterial_TextureChannel>` | :ref:`roughness_texture_channel<class_SpatialMaterial_property_roughness_texture_channel>` | 1 |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
@@ -223,6 +223,23 @@ Properties
| :ref:`bool<class_bool>` | :ref:`vertex_color_use_as_albedo<class_SpatialMaterial_property_vertex_color_use_as_albedo>` | false |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
Methods
-------
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_feature<class_SpatialMaterial_method_get_feature>` **(** :ref:`Feature<enum_SpatialMaterial_Feature>` feature **)** const |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_flag<class_SpatialMaterial_method_get_flag>` **(** :ref:`Flags<enum_SpatialMaterial_Flags>` flag **)** const |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`get_texture<class_SpatialMaterial_method_get_texture>` **(** :ref:`TextureParam<enum_SpatialMaterial_TextureParam>` param **)** const |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_feature<class_SpatialMaterial_method_set_feature>` **(** :ref:`Feature<enum_SpatialMaterial_Feature>` feature, :ref:`bool<class_bool>` enable **)** |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flag<class_SpatialMaterial_method_set_flag>` **(** :ref:`Flags<enum_SpatialMaterial_Flags>` flag, :ref:`bool<class_bool>` enable **)** |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture<class_SpatialMaterial_method_set_texture>` **(** :ref:`TextureParam<enum_SpatialMaterial_TextureParam>` param, :ref:`Texture<class_Texture>` texture **)** |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
@@ -661,13 +678,11 @@ The material's base color.
- :ref:`Texture<class_Texture>` **albedo_texture**
+-----------+--------------------+
| *Default* | null |
+-----------+--------------------+
| *Setter* | set_texture(value) |
+-----------+--------------------+
| *Getter* | get_texture() |
+-----------+--------------------+
+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture() |
+----------+--------------------+
.. _class_SpatialMaterial_property_anisotropy:
@@ -1247,13 +1262,11 @@ General reflectivity amount.
- :ref:`Texture<class_Texture>` **metallic_texture**
+-----------+--------------------+
| *Default* | null |
+-----------+--------------------+
| *Setter* | set_texture(value) |
+-----------+--------------------+
| *Getter* | get_texture() |
+-----------+--------------------+
+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture() |
+----------+--------------------+
.. _class_SpatialMaterial_property_metallic_texture_channel:
@@ -1645,13 +1658,11 @@ Surface reflection. A value of ``0`` represents a perfect mirror while a value o
- :ref:`Texture<class_Texture>` **roughness_texture**
+-----------+--------------------+
| *Default* | null |
+-----------+--------------------+
| *Setter* | set_texture(value) |
+-----------+--------------------+
| *Getter* | get_texture() |
+-----------+--------------------+
+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture() |
+----------+--------------------+
.. _class_SpatialMaterial_property_roughness_texture_channel:
@@ -1861,3 +1872,30 @@ If ``true``, the model's vertex colors are processed as sRGB mode.
If ``true``, the vertex color is used as albedo color.
Method Descriptions
-------------------
.. _class_SpatialMaterial_method_get_feature:
- :ref:`bool<class_bool>` **get_feature** **(** :ref:`Feature<enum_SpatialMaterial_Feature>` feature **)** const
.. _class_SpatialMaterial_method_get_flag:
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_SpatialMaterial_Flags>` flag **)** const
.. _class_SpatialMaterial_method_get_texture:
- :ref:`Texture<class_Texture>` **get_texture** **(** :ref:`TextureParam<enum_SpatialMaterial_TextureParam>` param **)** const
.. _class_SpatialMaterial_method_set_feature:
- void **set_feature** **(** :ref:`Feature<enum_SpatialMaterial_Feature>` feature, :ref:`bool<class_bool>` enable **)**
.. _class_SpatialMaterial_method_set_flag:
- void **set_flag** **(** :ref:`Flags<enum_SpatialMaterial_Flags>` flag, :ref:`bool<class_bool>` enable **)**
.. _class_SpatialMaterial_method_set_texture:
- void **set_texture** **(** :ref:`TextureParam<enum_SpatialMaterial_TextureParam>` param, :ref:`Texture<class_Texture>` texture **)**

View File

@@ -24,7 +24,7 @@ Properties
+---------------------------+----------------------------------------------------------------+------+
| :ref:`float<class_float>` | :ref:`margin<class_SpringArm_property_margin>` | 0.01 |
+---------------------------+----------------------------------------------------------------+------+
| :ref:`Shape<class_Shape>` | :ref:`shape<class_SpringArm_property_shape>` | null |
| :ref:`Shape<class_Shape>` | :ref:`shape<class_SpringArm_property_shape>` | |
+---------------------------+----------------------------------------------------------------+------+
| :ref:`float<class_float>` | :ref:`spring_length<class_SpringArm_property_spring_length>` | 1.0 |
+---------------------------+----------------------------------------------------------------+------+
@@ -73,13 +73,11 @@ Property Descriptions
- :ref:`Shape<class_Shape>` **shape**
+-----------+------------------+
| *Default* | null |
+-----------+------------------+
| *Setter* | set_shape(value) |
+-----------+------------------+
| *Getter* | get_shape() |
+-----------+------------------+
+----------+------------------+
| *Setter* | set_shape(value) |
+----------+------------------+
| *Getter* | get_shape() |
+----------+------------------+
.. _class_SpringArm_property_spring_length:

View File

@@ -30,7 +30,7 @@ Properties
+-------------------------------+---------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>` | :ref:`hframes<class_Sprite_property_hframes>` | 1 |
+-------------------------------+---------------------------------------------------------------------+---------------------+
| :ref:`Texture<class_Texture>` | :ref:`normal_map<class_Sprite_property_normal_map>` | null |
| :ref:`Texture<class_Texture>` | :ref:`normal_map<class_Sprite_property_normal_map>` | |
+-------------------------------+---------------------------------------------------------------------+---------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_Sprite_property_offset>` | Vector2( 0, 0 ) |
+-------------------------------+---------------------------------------------------------------------+---------------------+
@@ -40,7 +40,7 @@ Properties
+-------------------------------+---------------------------------------------------------------------+---------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`region_rect<class_Sprite_property_region_rect>` | Rect2( 0, 0, 0, 0 ) |
+-------------------------------+---------------------------------------------------------------------+---------------------+
| :ref:`Texture<class_Texture>` | :ref:`texture<class_Sprite_property_texture>` | null |
| :ref:`Texture<class_Texture>` | :ref:`texture<class_Sprite_property_texture>` | |
+-------------------------------+---------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>` | :ref:`vframes<class_Sprite_property_vframes>` | 1 |
+-------------------------------+---------------------------------------------------------------------+---------------------+
@@ -151,13 +151,11 @@ The number of columns in the sprite sheet.
- :ref:`Texture<class_Texture>` **normal_map**
+-----------+-----------------------+
| *Default* | null |
+-----------+-----------------------+
| *Setter* | set_normal_map(value) |
+-----------+-----------------------+
| *Getter* | get_normal_map() |
+-----------+-----------------------+
+----------+-----------------------+
| *Setter* | set_normal_map(value) |
+----------+-----------------------+
| *Getter* | get_normal_map() |
+----------+-----------------------+
The normal map gives depth to the Sprite.
@@ -221,13 +219,11 @@ The region of the atlas texture to display. :ref:`region_enabled<class_Sprite_pr
- :ref:`Texture<class_Texture>` **texture**
+-----------+--------------------+
| *Default* | null |
+-----------+--------------------+
| *Setter* | set_texture(value) |
+-----------+--------------------+
| *Getter* | get_texture() |
+-----------+--------------------+
+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture() |
+----------+--------------------+
:ref:`Texture<class_Texture>` object to draw.

View File

@@ -28,7 +28,7 @@ Properties
+-------------------------------+---------------------------------------------------------------+---------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`region_rect<class_Sprite3D_property_region_rect>` | Rect2( 0, 0, 0, 0 ) |
+-------------------------------+---------------------------------------------------------------+---------------------+
| :ref:`Texture<class_Texture>` | :ref:`texture<class_Sprite3D_property_texture>` | null |
| :ref:`Texture<class_Texture>` | :ref:`texture<class_Sprite3D_property_texture>` | |
+-------------------------------+---------------------------------------------------------------+---------------------+
| :ref:`int<class_int>` | :ref:`vframes<class_Sprite3D_property_vframes>` | 1 |
+-------------------------------+---------------------------------------------------------------+---------------------+
@@ -110,13 +110,11 @@ The region of the atlas texture to display. :ref:`region_enabled<class_Sprite3D_
- :ref:`Texture<class_Texture>` **texture**
+-----------+--------------------+
| *Default* | null |
+-----------+--------------------+
| *Setter* | set_texture(value) |
+-----------+--------------------+
| *Getter* | get_texture() |
+-----------+--------------------+
+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture() |
+----------+--------------------+
:ref:`Texture<class_Texture>` object to draw.

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