mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
Sync classref with master branch (4.0 changes)
This commit is contained in:
Rémi Verschelde
@@ -36,7 +36,7 @@ Methods
|
||||
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`atan2<class_@GDScript_method_atan2>` **(** :ref:`float<class_float>` y, :ref:`float<class_float>` x **)** |
|
||||
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`bytes2var<class_@GDScript_method_bytes2var>` **(** :ref:`PoolByteArray<class_PoolByteArray>` bytes, :ref:`bool<class_bool>` allow_objects=false **)** |
|
||||
| :ref:`Variant<class_Variant>` | :ref:`bytes2var<class_@GDScript_method_bytes2var>` **(** :ref:`PackedByteArray<class_PackedByteArray>` bytes, :ref:`bool<class_bool>` allow_objects=false **)** |
|
||||
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`cartesian2polar<class_@GDScript_method_cartesian2polar>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
|
||||
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -54,8 +54,6 @@ Methods
|
||||
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`db2linear<class_@GDScript_method_db2linear>` **(** :ref:`float<class_float>` db **)** |
|
||||
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`decimals<class_@GDScript_method_decimals>` **(** :ref:`float<class_float>` step **)** |
|
||||
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`dectime<class_@GDScript_method_dectime>` **(** :ref:`float<class_float>` value, :ref:`float<class_float>` amount, :ref:`float<class_float>` step **)** |
|
||||
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`deg2rad<class_@GDScript_method_deg2rad>` **(** :ref:`float<class_float>` deg **)** |
|
||||
@@ -194,7 +192,7 @@ Methods
|
||||
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`validate_json<class_@GDScript_method_validate_json>` **(** :ref:`String<class_String>` json **)** |
|
||||
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`var2bytes<class_@GDScript_method_var2bytes>` **(** :ref:`Variant<class_Variant>` var, :ref:`bool<class_bool>` full_objects=false **)** |
|
||||
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`var2bytes<class_@GDScript_method_var2bytes>` **(** :ref:`Variant<class_Variant>` var, :ref:`bool<class_bool>` full_objects=false **)** |
|
||||
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`var2str<class_@GDScript_method_var2str>` **(** :ref:`Variant<class_Variant>` var **)** |
|
||||
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -348,7 +346,7 @@ Returns the arc tangent of ``y/x`` in radians. Use to get the angle of tangent `
|
||||
|
||||
.. _class_@GDScript_method_bytes2var:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **bytes2var** **(** :ref:`PoolByteArray<class_PoolByteArray>` bytes, :ref:`bool<class_bool>` allow_objects=false **)**
|
||||
- :ref:`Variant<class_Variant>` **bytes2var** **(** :ref:`PackedByteArray<class_PackedByteArray>` bytes, :ref:`bool<class_bool>` allow_objects=false **)**
|
||||
|
||||
Decodes a byte array back to a value. When ``allow_objects`` is ``true`` decoding objects is allowed.
|
||||
|
||||
@@ -463,14 +461,6 @@ Converts from decibels to linear energy (audio).
|
||||
|
||||
----
|
||||
|
||||
.. _class_@GDScript_method_decimals:
|
||||
|
||||
- :ref:`int<class_int>` **decimals** **(** :ref:`float<class_float>` step **)**
|
||||
|
||||
Deprecated alias for :ref:`step_decimals<class_@GDScript_method_step_decimals>`.
|
||||
|
||||
----
|
||||
|
||||
.. _class_@GDScript_method_dectime:
|
||||
|
||||
- :ref:`float<class_float>` **dectime** **(** :ref:`float<class_float>` value, :ref:`float<class_float>` amount, :ref:`float<class_float>` step **)**
|
||||
@@ -688,11 +678,15 @@ Returns the Object that corresponds to ``instance_id``. All Objects have a uniqu
|
||||
|
||||
- :ref:`float<class_float>` **inverse_lerp** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight **)**
|
||||
|
||||
Returns a normalized value considering the given range.
|
||||
Returns a normalized value considering the given range. This is the opposite of :ref:`lerp<class_@GDScript_method_lerp>`.
|
||||
|
||||
::
|
||||
|
||||
inverse_lerp(3, 5, 4) # Returns 0.5
|
||||
var middle = lerp(20, 30, 0.75)
|
||||
# `middle` is now 27.5.
|
||||
# Now, we pretend to have forgotten the original ratio and want to get it back.
|
||||
var ratio = inverse_lerp(20, 30, 27.5)
|
||||
# `ratio` is now 0.75.
|
||||
|
||||
----
|
||||
|
||||
@@ -755,7 +749,7 @@ Returns length of Variant ``var``. Length is the character count of String, elem
|
||||
|
||||
- :ref:`Variant<class_Variant>` **lerp** **(** :ref:`Variant<class_Variant>` from, :ref:`Variant<class_Variant>` to, :ref:`float<class_float>` weight **)**
|
||||
|
||||
Linearly interpolates between two values by a normalized value.
|
||||
Linearly interpolates between two values by a normalized value. This is the opposite of :ref:`inverse_lerp<class_@GDScript_method_inverse_lerp>`.
|
||||
|
||||
If the ``from`` and ``to`` arguments are of type :ref:`int<class_int>` or :ref:`float<class_float>`, the return value is a :ref:`float<class_float>`.
|
||||
|
||||
@@ -774,7 +768,7 @@ If both are of the same vector type (:ref:`Vector2<class_Vector2>`, :ref:`Vector
|
||||
|
||||
Linearly interpolates between two angles (in radians) by a normalized value.
|
||||
|
||||
Similar to :ref:`lerp<class_@GDScript_method_lerp>` but interpolate correctly when the angles wrap around :ref:`TAU<class_@GDScript_constant_TAU>`.
|
||||
Similar to :ref:`lerp<class_@GDScript_method_lerp>`, but interpolates correctly when the angles wrap around :ref:`TAU<class_@GDScript_constant_TAU>`.
|
||||
|
||||
::
|
||||
|
||||
@@ -792,7 +786,14 @@ Similar to :ref:`lerp<class_@GDScript_method_lerp>` but interpolate correctly wh
|
||||
|
||||
- :ref:`float<class_float>` **linear2db** **(** :ref:`float<class_float>` nrg **)**
|
||||
|
||||
Converts from linear energy to decibels (audio).
|
||||
Converts from linear energy to decibels (audio). This can be used to implement volume sliders that behave as expected (since volume isn't linear). Example:
|
||||
|
||||
::
|
||||
|
||||
# "Slider" refers to a node that inherits Range such as HSlider or VSlider.
|
||||
# Its range must be configured to go from 0 to 1.
|
||||
# Change the bus name if you'd like to change the volume of a specific bus only.
|
||||
AudioServer.set_bus_volume_db(AudioServer.get_bus_index("Master"), linear2db($Slider.value))
|
||||
|
||||
----
|
||||
|
||||
@@ -1448,7 +1449,7 @@ Checks that ``json`` is valid JSON data. Returns an empty string if valid, or an
|
||||
|
||||
.. _class_@GDScript_method_var2bytes:
|
||||
|
||||
- :ref:`PoolByteArray<class_PoolByteArray>` **var2bytes** **(** :ref:`Variant<class_Variant>` var, :ref:`bool<class_bool>` full_objects=false **)**
|
||||
- :ref:`PackedByteArray<class_PackedByteArray>` **var2bytes** **(** :ref:`Variant<class_Variant>` var, :ref:`bool<class_bool>` full_objects=false **)**
|
||||
|
||||
Encodes a variable value to a byte array. When ``full_objects`` is ``true`` encoding objects is allowed (and can potentially include code).
|
||||
|
||||
|
||||
@@ -14,62 +14,68 @@ Global scope constants and variables.
|
||||
Description
|
||||
-----------
|
||||
|
||||
Global scope constants and variables. This is all that resides in the globals, constants regarding error codes, scancodes, property hints, etc.
|
||||
Global scope constants and variables. This is all that resides in the globals, constants regarding error codes, keycodes, property hints, etc.
|
||||
|
||||
Singletons are also documented here, since they can be accessed from anywhere.
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`ARVRServer<class_ARVRServer>` | :ref:`ARVRServer<class_@GlobalScope_property_ARVRServer>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`AudioServer<class_AudioServer>` | :ref:`AudioServer<class_@GlobalScope_property_AudioServer>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`CameraServer<class_CameraServer>` | :ref:`CameraServer<class_@GlobalScope_property_CameraServer>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`ClassDB<class_ClassDB>` | :ref:`ClassDB<class_@GlobalScope_property_ClassDB>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`Engine<class_Engine>` | :ref:`Engine<class_@GlobalScope_property_Engine>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`Geometry<class_Geometry>` | :ref:`Geometry<class_@GlobalScope_property_Geometry>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`IP<class_IP>` | :ref:`IP<class_@GlobalScope_property_IP>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`Input<class_Input>` | :ref:`Input<class_@GlobalScope_property_Input>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`InputMap<class_InputMap>` | :ref:`InputMap<class_@GlobalScope_property_InputMap>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`JSON<class_JSON>` | :ref:`JSON<class_@GlobalScope_property_JSON>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`JavaClassWrapper<class_JavaClassWrapper>` | :ref:`JavaClassWrapper<class_@GlobalScope_property_JavaClassWrapper>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`JavaScript<class_JavaScript>` | :ref:`JavaScript<class_@GlobalScope_property_JavaScript>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`Reference<class_Reference>` | :ref:`Marshalls<class_@GlobalScope_property_Marshalls>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorNavigationMeshGenerator<class_EditorNavigationMeshGenerator>` | :ref:`NavigationMeshGenerator<class_@GlobalScope_property_NavigationMeshGenerator>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`OS<class_OS>` | :ref:`OS<class_@GlobalScope_property_OS>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`Performance<class_Performance>` | :ref:`Performance<class_@GlobalScope_property_Performance>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`Physics2DServer<class_Physics2DServer>` | :ref:`Physics2DServer<class_@GlobalScope_property_Physics2DServer>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`PhysicsServer<class_PhysicsServer>` | :ref:`PhysicsServer<class_@GlobalScope_property_PhysicsServer>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`ProjectSettings<class_ProjectSettings>` | :ref:`ProjectSettings<class_@GlobalScope_property_ProjectSettings>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`ResourceLoader<class_ResourceLoader>` | :ref:`ResourceLoader<class_@GlobalScope_property_ResourceLoader>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`ResourceSaver<class_ResourceSaver>` | :ref:`ResourceSaver<class_@GlobalScope_property_ResourceSaver>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`TranslationServer<class_TranslationServer>` | :ref:`TranslationServer<class_@GlobalScope_property_TranslationServer>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`VisualScriptEditor<class_VisualScriptEditor>` | :ref:`VisualScriptEditor<class_@GlobalScope_property_VisualScriptEditor>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`VisualServer<class_VisualServer>` | :ref:`VisualServer<class_@GlobalScope_property_VisualServer>` |
|
||||
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`ARVRServer<class_ARVRServer>` | :ref:`ARVRServer<class_@GlobalScope_property_ARVRServer>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`AudioServer<class_AudioServer>` | :ref:`AudioServer<class_@GlobalScope_property_AudioServer>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`CameraServer<class_CameraServer>` | :ref:`CameraServer<class_@GlobalScope_property_CameraServer>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`ClassDB<class_ClassDB>` | :ref:`ClassDB<class_@GlobalScope_property_ClassDB>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`Engine<class_Engine>` | :ref:`Engine<class_@GlobalScope_property_Engine>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`Geometry<class_Geometry>` | :ref:`Geometry<class_@GlobalScope_property_Geometry>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`GodotSharp<class_GodotSharp>` | :ref:`GodotSharp<class_@GlobalScope_property_GodotSharp>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`IP<class_IP>` | :ref:`IP<class_@GlobalScope_property_IP>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`Input<class_Input>` | :ref:`Input<class_@GlobalScope_property_Input>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`InputMap<class_InputMap>` | :ref:`InputMap<class_@GlobalScope_property_InputMap>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`JSON<class_JSON>` | :ref:`JSON<class_@GlobalScope_property_JSON>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`JavaClassWrapper<class_JavaClassWrapper>` | :ref:`JavaClassWrapper<class_@GlobalScope_property_JavaClassWrapper>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`JavaScript<class_JavaScript>` | :ref:`JavaScript<class_@GlobalScope_property_JavaScript>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`Marshalls<class_Marshalls>` | :ref:`Marshalls<class_@GlobalScope_property_Marshalls>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`Navigation2DServer<class_Navigation2DServer>` | :ref:`Navigation2DServer<class_@GlobalScope_property_Navigation2DServer>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`NavigationMeshGenerator<class_NavigationMeshGenerator>` | :ref:`NavigationMeshGenerator<class_@GlobalScope_property_NavigationMeshGenerator>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`NavigationServer<class_NavigationServer>` | :ref:`NavigationServer<class_@GlobalScope_property_NavigationServer>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`OS<class_OS>` | :ref:`OS<class_@GlobalScope_property_OS>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`Performance<class_Performance>` | :ref:`Performance<class_@GlobalScope_property_Performance>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`Physics2DServer<class_Physics2DServer>` | :ref:`Physics2DServer<class_@GlobalScope_property_Physics2DServer>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`PhysicsServer<class_PhysicsServer>` | :ref:`PhysicsServer<class_@GlobalScope_property_PhysicsServer>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`ProjectSettings<class_ProjectSettings>` | :ref:`ProjectSettings<class_@GlobalScope_property_ProjectSettings>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`ResourceLoader<class_ResourceLoader>` | :ref:`ResourceLoader<class_@GlobalScope_property_ResourceLoader>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`ResourceSaver<class_ResourceSaver>` | :ref:`ResourceSaver<class_@GlobalScope_property_ResourceSaver>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`TranslationServer<class_TranslationServer>` | :ref:`TranslationServer<class_@GlobalScope_property_TranslationServer>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`VisualScriptEditor<class_VisualScriptEditor>` | :ref:`VisualScriptEditor<class_@GlobalScope_property_VisualScriptEditor>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`VisualServer<class_VisualServer>` | :ref:`VisualServer<class_@GlobalScope_property_VisualServer>` |
|
||||
+---------------------------------------------------------------+-------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
@@ -1855,7 +1861,7 @@ enum **PropertyHint**:
|
||||
|
||||
- **PROPERTY_HINT_GLOBAL_DIR** = **16** --- Hints that a string property is an absolute path to a directory outside the project folder. Editing it will show a file dialog for picking the path.
|
||||
|
||||
- **PROPERTY_HINT_RESOURCE_TYPE** = **17** --- Hints that a property is an instance of a :ref:`Resource<class_Resource>`-derived type, optionally specified via the hint string (e.g. ``"Texture"``). Editing it will show a popup menu of valid resource types to instantiate.
|
||||
- **PROPERTY_HINT_RESOURCE_TYPE** = **17** --- Hints that a property is an instance of a :ref:`Resource<class_Resource>`-derived type, optionally specified via the hint string (e.g. ``"Texture2D"``). Editing it will show a popup menu of valid resource types to instantiate.
|
||||
|
||||
- **PROPERTY_HINT_MULTILINE_TEXT** = **18** --- Hints that a string property is text with line breaks. Editing it will show a text input field where line breaks can be typed.
|
||||
|
||||
@@ -1987,10 +1993,16 @@ enum **MethodFlags**:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_VECTOR2:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_VECTOR2I:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_RECT2:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_RECT2I:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_VECTOR3:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_VECTOR3I:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_TRANSFORM2D:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_PLANE:
|
||||
@@ -2005,21 +2017,31 @@ enum **MethodFlags**:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_COLOR:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_STRING_NAME:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_NODE_PATH:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_RID:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_OBJECT:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_CALLABLE:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_SIGNAL:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_DICTIONARY:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_ARRAY:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_RAW_ARRAY:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_INT_ARRAY:
|
||||
.. _class_@GlobalScope_constant_TYPE_INT32_ARRAY:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_REAL_ARRAY:
|
||||
.. _class_@GlobalScope_constant_TYPE_INT64_ARRAY:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_FLOAT32_ARRAY:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_FLOAT64_ARRAY:
|
||||
|
||||
.. _class_@GlobalScope_constant_TYPE_STRING_ARRAY:
|
||||
|
||||
@@ -2045,49 +2067,65 @@ enum **Variant.Type**:
|
||||
|
||||
- **TYPE_VECTOR2** = **5** --- Variable is of type :ref:`Vector2<class_Vector2>`.
|
||||
|
||||
- **TYPE_RECT2** = **6** --- Variable is of type :ref:`Rect2<class_Rect2>`.
|
||||
- **TYPE_VECTOR2I** = **6** --- Variable is of type :ref:`Vector2i<class_Vector2i>`.
|
||||
|
||||
- **TYPE_VECTOR3** = **7** --- Variable is of type :ref:`Vector3<class_Vector3>`.
|
||||
- **TYPE_RECT2** = **7** --- Variable is of type :ref:`Rect2<class_Rect2>`.
|
||||
|
||||
- **TYPE_TRANSFORM2D** = **8** --- Variable is of type :ref:`Transform2D<class_Transform2D>`.
|
||||
- **TYPE_RECT2I** = **8** --- Variable is of type :ref:`Rect2i<class_Rect2i>`.
|
||||
|
||||
- **TYPE_PLANE** = **9** --- Variable is of type :ref:`Plane<class_Plane>`.
|
||||
- **TYPE_VECTOR3** = **9** --- Variable is of type :ref:`Vector3<class_Vector3>`.
|
||||
|
||||
- **TYPE_QUAT** = **10** --- Variable is of type :ref:`Quat<class_Quat>`.
|
||||
- **TYPE_VECTOR3I** = **10** --- Variable is of type :ref:`Vector3i<class_Vector3i>`.
|
||||
|
||||
- **TYPE_AABB** = **11** --- Variable is of type :ref:`AABB<class_AABB>`.
|
||||
- **TYPE_TRANSFORM2D** = **11** --- Variable is of type :ref:`Transform2D<class_Transform2D>`.
|
||||
|
||||
- **TYPE_BASIS** = **12** --- Variable is of type :ref:`Basis<class_Basis>`.
|
||||
- **TYPE_PLANE** = **12** --- Variable is of type :ref:`Plane<class_Plane>`.
|
||||
|
||||
- **TYPE_TRANSFORM** = **13** --- Variable is of type :ref:`Transform<class_Transform>`.
|
||||
- **TYPE_QUAT** = **13** --- Variable is of type :ref:`Quat<class_Quat>`.
|
||||
|
||||
- **TYPE_COLOR** = **14** --- Variable is of type :ref:`Color<class_Color>`.
|
||||
- **TYPE_AABB** = **14** --- Variable is of type :ref:`AABB<class_AABB>`.
|
||||
|
||||
- **TYPE_NODE_PATH** = **15** --- Variable is of type :ref:`NodePath<class_NodePath>`.
|
||||
- **TYPE_BASIS** = **15** --- Variable is of type :ref:`Basis<class_Basis>`.
|
||||
|
||||
- **TYPE_RID** = **16** --- Variable is of type :ref:`RID<class_RID>`.
|
||||
- **TYPE_TRANSFORM** = **16** --- Variable is of type :ref:`Transform<class_Transform>`.
|
||||
|
||||
- **TYPE_OBJECT** = **17** --- Variable is of type :ref:`Object<class_Object>`.
|
||||
- **TYPE_COLOR** = **17** --- Variable is of type :ref:`Color<class_Color>`.
|
||||
|
||||
- **TYPE_DICTIONARY** = **18** --- Variable is of type :ref:`Dictionary<class_Dictionary>`.
|
||||
- **TYPE_STRING_NAME** = **18** --- Variable is of type :ref:`StringName<class_StringName>`.
|
||||
|
||||
- **TYPE_ARRAY** = **19** --- Variable is of type :ref:`Array<class_Array>`.
|
||||
- **TYPE_NODE_PATH** = **19** --- Variable is of type :ref:`NodePath<class_NodePath>`.
|
||||
|
||||
- **TYPE_RAW_ARRAY** = **20** --- Variable is of type :ref:`PoolByteArray<class_PoolByteArray>`.
|
||||
- **TYPE_RID** = **20** --- Variable is of type :ref:`RID<class_RID>`.
|
||||
|
||||
- **TYPE_INT_ARRAY** = **21** --- Variable is of type :ref:`PoolIntArray<class_PoolIntArray>`.
|
||||
- **TYPE_OBJECT** = **21** --- Variable is of type :ref:`Object<class_Object>`.
|
||||
|
||||
- **TYPE_REAL_ARRAY** = **22** --- Variable is of type :ref:`PoolRealArray<class_PoolRealArray>`.
|
||||
- **TYPE_CALLABLE** = **22** --- Variable is of type :ref:`Callable<class_Callable>`.
|
||||
|
||||
- **TYPE_STRING_ARRAY** = **23** --- Variable is of type :ref:`PoolStringArray<class_PoolStringArray>`.
|
||||
- **TYPE_SIGNAL** = **23** --- Variable is of type :ref:`Signal<class_Signal>`.
|
||||
|
||||
- **TYPE_VECTOR2_ARRAY** = **24** --- Variable is of type :ref:`PoolVector2Array<class_PoolVector2Array>`.
|
||||
- **TYPE_DICTIONARY** = **24** --- Variable is of type :ref:`Dictionary<class_Dictionary>`.
|
||||
|
||||
- **TYPE_VECTOR3_ARRAY** = **25** --- Variable is of type :ref:`PoolVector3Array<class_PoolVector3Array>`.
|
||||
- **TYPE_ARRAY** = **25** --- Variable is of type :ref:`Array<class_Array>`.
|
||||
|
||||
- **TYPE_COLOR_ARRAY** = **26** --- Variable is of type :ref:`PoolColorArray<class_PoolColorArray>`.
|
||||
- **TYPE_RAW_ARRAY** = **26** --- Variable is of type :ref:`PackedByteArray<class_PackedByteArray>`.
|
||||
|
||||
- **TYPE_MAX** = **27** --- Represents the size of the :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` enum.
|
||||
- **TYPE_INT32_ARRAY** = **27** --- Variable is of type :ref:`PackedInt32Array<class_PackedInt32Array>`.
|
||||
|
||||
- **TYPE_INT64_ARRAY** = **28** --- Variable is of type :ref:`PackedInt64Array<class_PackedInt64Array>`.
|
||||
|
||||
- **TYPE_FLOAT32_ARRAY** = **29** --- Variable is of type :ref:`PackedFloat32Array<class_PackedFloat32Array>`.
|
||||
|
||||
- **TYPE_FLOAT64_ARRAY** = **30** --- Variable is of type :ref:`PackedFloat64Array<class_PackedFloat64Array>`.
|
||||
|
||||
- **TYPE_STRING_ARRAY** = **31** --- Variable is of type :ref:`PackedStringArray<class_PackedStringArray>`.
|
||||
|
||||
- **TYPE_VECTOR2_ARRAY** = **32** --- Variable is of type :ref:`PackedVector2Array<class_PackedVector2Array>`.
|
||||
|
||||
- **TYPE_VECTOR3_ARRAY** = **33** --- Variable is of type :ref:`PackedVector3Array<class_PackedVector3Array>`.
|
||||
|
||||
- **TYPE_COLOR_ARRAY** = **34** --- Variable is of type :ref:`PackedColorArray<class_PackedColorArray>`.
|
||||
|
||||
- **TYPE_MAX** = **35** --- Represents the size of the :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` enum.
|
||||
|
||||
----
|
||||
|
||||
@@ -2204,7 +2242,7 @@ Constants
|
||||
|
||||
.. _class_@GlobalScope_constant_SPKEY:
|
||||
|
||||
- **SPKEY** = **16777216** --- Scancodes with this bit applied are non-printable.
|
||||
- **SPKEY** = **16777216** --- Keycodes with this bit applied are non-printable.
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -2257,6 +2295,14 @@ The :ref:`Geometry<class_Geometry>` singleton.
|
||||
|
||||
----
|
||||
|
||||
.. _class_@GlobalScope_property_GodotSharp:
|
||||
|
||||
- :ref:`GodotSharp<class_GodotSharp>` **GodotSharp**
|
||||
|
||||
The :ref:`GodotSharp<class_GodotSharp>` singleton. Only available when using Godot's Mono build.
|
||||
|
||||
----
|
||||
|
||||
.. _class_@GlobalScope_property_IP:
|
||||
|
||||
- :ref:`IP<class_IP>` **IP**
|
||||
@@ -2311,17 +2357,33 @@ The :ref:`JavaScript<class_JavaScript>` singleton.
|
||||
|
||||
.. _class_@GlobalScope_property_Marshalls:
|
||||
|
||||
- :ref:`Reference<class_Reference>` **Marshalls**
|
||||
- :ref:`Marshalls<class_Marshalls>` **Marshalls**
|
||||
|
||||
The :ref:`Marshalls<class_Marshalls>` singleton.
|
||||
|
||||
----
|
||||
|
||||
.. _class_@GlobalScope_property_Navigation2DServer:
|
||||
|
||||
- :ref:`Navigation2DServer<class_Navigation2DServer>` **Navigation2DServer**
|
||||
|
||||
The :ref:`Navigation2DServer<class_Navigation2DServer>` singleton.
|
||||
|
||||
----
|
||||
|
||||
.. _class_@GlobalScope_property_NavigationMeshGenerator:
|
||||
|
||||
- :ref:`EditorNavigationMeshGenerator<class_EditorNavigationMeshGenerator>` **NavigationMeshGenerator**
|
||||
- :ref:`NavigationMeshGenerator<class_NavigationMeshGenerator>` **NavigationMeshGenerator**
|
||||
|
||||
The :ref:`EditorNavigationMeshGenerator<class_EditorNavigationMeshGenerator>` singleton.
|
||||
The :ref:`NavigationMeshGenerator<class_NavigationMeshGenerator>` singleton.
|
||||
|
||||
----
|
||||
|
||||
.. _class_@GlobalScope_property_NavigationServer:
|
||||
|
||||
- :ref:`NavigationServer<class_NavigationServer>` **NavigationServer**
|
||||
|
||||
The :ref:`NavigationServer<class_NavigationServer>` singleton.
|
||||
|
||||
----
|
||||
|
||||
|
||||
@@ -61,7 +61,7 @@ Emitted when the dialog is accepted, i.e. the OK button is pressed.
|
||||
|
||||
.. _class_AcceptDialog_signal_custom_action:
|
||||
|
||||
- **custom_action** **(** :ref:`String<class_String>` action **)**
|
||||
- **custom_action** **(** :ref:`StringName<class_StringName>` action **)**
|
||||
|
||||
Emitted when a custom button is pressed. See :ref:`add_button<class_AcceptDialog_method_add_button>`.
|
||||
|
||||
|
||||
@@ -21,36 +21,40 @@ Animations are created using a :ref:`SpriteFrames<class_SpriteFrames>` resource,
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation<class_AnimatedSprite_property_animation>` | ``"default"`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`centered<class_AnimatedSprite_property_centered>` | ``true`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flip_h<class_AnimatedSprite_property_flip_h>` | ``false`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flip_v<class_AnimatedSprite_property_flip_v>` | ``false`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | :ref:`frame<class_AnimatedSprite_property_frame>` | ``0`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`SpriteFrames<class_SpriteFrames>` | :ref:`frames<class_AnimatedSprite_property_frames>` | |
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_AnimatedSprite_property_offset>` | ``Vector2( 0, 0 )`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AnimatedSprite_property_playing>` | ``false`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`speed_scale<class_AnimatedSprite_property_speed_scale>` | ``1.0`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
+-----------------------------------------+---------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`StringName<class_StringName>` | :ref:`animation<class_AnimatedSprite_property_animation>` | ``@"default"`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`centered<class_AnimatedSprite_property_centered>` | ``true`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flip_h<class_AnimatedSprite_property_flip_h>` | ``false`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flip_v<class_AnimatedSprite_property_flip_v>` | ``false`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`frame<class_AnimatedSprite_property_frame>` | ``0`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`SpriteFrames<class_SpriteFrames>` | :ref:`frames<class_AnimatedSprite_property_frames>` | |
|
||||
+-----------------------------------------+---------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_AnimatedSprite_property_offset>` | ``Vector2( 0, 0 )`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AnimatedSprite_property_playing>` | ``false`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`shininess<class_AnimatedSprite_property_shininess>` | ``1.0`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`specular_color<class_AnimatedSprite_property_specular_color>` | ``Color( 1, 1, 1, 1 )`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`speed_scale<class_AnimatedSprite_property_speed_scale>` | ``1.0`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------------+-------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimatedSprite_method_is_playing>` **(** **)** const |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AnimatedSprite_method_play>` **(** :ref:`String<class_String>` anim="", :ref:`bool<class_bool>` backwards=false **)** |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimatedSprite_method_stop>` **(** **)** |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimatedSprite_method_is_playing>` **(** **)** const |
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AnimatedSprite_method_play>` **(** :ref:`StringName<class_StringName>` anim=@"", :ref:`bool<class_bool>` backwards=false **)** |
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimatedSprite_method_stop>` **(** **)** |
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
@@ -74,10 +78,10 @@ Property Descriptions
|
||||
|
||||
.. _class_AnimatedSprite_property_animation:
|
||||
|
||||
- :ref:`String<class_String>` **animation**
|
||||
- :ref:`StringName<class_StringName>` **animation**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | ``"default"`` |
|
||||
| *Default* | ``@"default"`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_animation(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -194,6 +198,38 @@ If ``true``, the :ref:`animation<class_AnimatedSprite_property_animation>` is cu
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimatedSprite_property_shininess:
|
||||
|
||||
- :ref:`float<class_float>` **shininess**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_shininess(value) |
|
||||
+-----------+----------------------+
|
||||
| *Getter* | get_shininess() |
|
||||
+-----------+----------------------+
|
||||
|
||||
Strength of the specular light effect of this ``AnimatedSprite``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimatedSprite_property_specular_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **specular_color**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | ``Color( 1, 1, 1, 1 )`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_specular_color(value) |
|
||||
+-----------+---------------------------+
|
||||
| *Getter* | get_specular_color() |
|
||||
+-----------+---------------------------+
|
||||
|
||||
The color of the specular light effect.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimatedSprite_property_speed_scale:
|
||||
|
||||
- :ref:`float<class_float>` **speed_scale**
|
||||
@@ -221,7 +257,7 @@ Returns ``true`` if an animation is currently being played.
|
||||
|
||||
.. _class_AnimatedSprite_method_play:
|
||||
|
||||
- void **play** **(** :ref:`String<class_String>` anim="", :ref:`bool<class_bool>` backwards=false **)**
|
||||
- void **play** **(** :ref:`StringName<class_StringName>` anim=@"", :ref:`bool<class_bool>` backwards=false **)**
|
||||
|
||||
Plays the animation named ``anim``. If no ``anim`` is provided, the current animation is played. If ``backwards`` is ``true``, the animation will be played in reverse.
|
||||
|
||||
|
||||
@@ -21,26 +21,26 @@ Animations are created using a :ref:`SpriteFrames<class_SpriteFrames>` resource,
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------+-------------------------------------------------------------+---------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation<class_AnimatedSprite3D_property_animation>` | ``"default"`` |
|
||||
+-----------------------------------------+-------------------------------------------------------------+---------------+
|
||||
| :ref:`int<class_int>` | :ref:`frame<class_AnimatedSprite3D_property_frame>` | ``0`` |
|
||||
+-----------------------------------------+-------------------------------------------------------------+---------------+
|
||||
| :ref:`SpriteFrames<class_SpriteFrames>` | :ref:`frames<class_AnimatedSprite3D_property_frames>` | |
|
||||
+-----------------------------------------+-------------------------------------------------------------+---------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AnimatedSprite3D_property_playing>` | ``false`` |
|
||||
+-----------------------------------------+-------------------------------------------------------------+---------------+
|
||||
+-----------------------------------------+-------------------------------------------------------------+----------------+
|
||||
| :ref:`StringName<class_StringName>` | :ref:`animation<class_AnimatedSprite3D_property_animation>` | ``@"default"`` |
|
||||
+-----------------------------------------+-------------------------------------------------------------+----------------+
|
||||
| :ref:`int<class_int>` | :ref:`frame<class_AnimatedSprite3D_property_frame>` | ``0`` |
|
||||
+-----------------------------------------+-------------------------------------------------------------+----------------+
|
||||
| :ref:`SpriteFrames<class_SpriteFrames>` | :ref:`frames<class_AnimatedSprite3D_property_frames>` | |
|
||||
+-----------------------------------------+-------------------------------------------------------------+----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AnimatedSprite3D_property_playing>` | ``false`` |
|
||||
+-----------------------------------------+-------------------------------------------------------------+----------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimatedSprite3D_method_is_playing>` **(** **)** const |
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AnimatedSprite3D_method_play>` **(** :ref:`String<class_String>` anim="" **)** |
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimatedSprite3D_method_stop>` **(** **)** |
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------+
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimatedSprite3D_method_is_playing>` **(** **)** const |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AnimatedSprite3D_method_play>` **(** :ref:`StringName<class_StringName>` anim=@"" **)** |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimatedSprite3D_method_stop>` **(** **)** |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
@@ -56,10 +56,10 @@ Property Descriptions
|
||||
|
||||
.. _class_AnimatedSprite3D_property_animation:
|
||||
|
||||
- :ref:`String<class_String>` **animation**
|
||||
- :ref:`StringName<class_StringName>` **animation**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | ``"default"`` |
|
||||
| *Default* | ``@"default"`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_animation(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -123,7 +123,7 @@ Returns ``true`` if an animation is currently being played.
|
||||
|
||||
.. _class_AnimatedSprite3D_method_play:
|
||||
|
||||
- void **play** **(** :ref:`String<class_String>` anim="" **)**
|
||||
- void **play** **(** :ref:`StringName<class_StringName>` anim=@"" **)**
|
||||
|
||||
Plays the animation named ``anim``. If no ``anim`` is provided, the current animation is played.
|
||||
|
||||
|
||||
@@ -9,14 +9,14 @@
|
||||
AnimatedTexture
|
||||
===============
|
||||
|
||||
**Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
**Inherits:** :ref:`Texture2D<class_Texture2D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
Proxy texture for simple frame-based animations.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
``AnimatedTexture`` is a resource format for frame-based animations, where multiple textures can be chained automatically with a predefined delay for each frame. Unlike :ref:`AnimationPlayer<class_AnimationPlayer>` or :ref:`AnimatedSprite<class_AnimatedSprite>`, it isn't a :ref:`Node<class_Node>`, but has the advantage of being usable anywhere a :ref:`Texture<class_Texture>` resource can be used, e.g. in a :ref:`TileSet<class_TileSet>`.
|
||||
``AnimatedTexture`` is a resource format for frame-based animations, where multiple textures can be chained automatically with a predefined delay for each frame. Unlike :ref:`AnimationPlayer<class_AnimationPlayer>` or :ref:`AnimatedSprite<class_AnimatedSprite>`, it isn't a :ref:`Node<class_Node>`, but has the advantage of being usable anywhere a :ref:`Texture2D<class_Texture2D>` resource can be used, e.g. in a :ref:`TileSet<class_TileSet>`.
|
||||
|
||||
The playback of the animation is controlled by the :ref:`fps<class_AnimatedTexture_property_fps>` property as well as each frame's optional delay (see :ref:`set_frame_delay<class_AnimatedTexture_method_set_frame_delay>`). The animation loops, i.e. it will restart at frame 0 automatically after playing the last frame.
|
||||
|
||||
@@ -25,26 +25,24 @@ The playback of the animation is controlled by the :ref:`fps<class_AnimatedTextu
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+------------------------------------------------------+--------------+
|
||||
| :ref:`int<class_int>` | flags | **O:** ``0`` |
|
||||
+---------------------------+------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`fps<class_AnimatedTexture_property_fps>` | ``4.0`` |
|
||||
+---------------------------+------------------------------------------------------+--------------+
|
||||
| :ref:`int<class_int>` | :ref:`frames<class_AnimatedTexture_property_frames>` | ``1`` |
|
||||
+---------------------------+------------------------------------------------------+--------------+
|
||||
+---------------------------+------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`fps<class_AnimatedTexture_property_fps>` | ``4.0`` |
|
||||
+---------------------------+------------------------------------------------------+---------+
|
||||
| :ref:`int<class_int>` | :ref:`frames<class_AnimatedTexture_property_frames>` | ``1`` |
|
||||
+---------------------------+------------------------------------------------------+---------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_frame_delay<class_AnimatedTexture_method_get_frame_delay>` **(** :ref:`int<class_int>` frame **)** const |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`get_frame_texture<class_AnimatedTexture_method_get_frame_texture>` **(** :ref:`int<class_int>` frame **)** const |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_frame_delay<class_AnimatedTexture_method_set_frame_delay>` **(** :ref:`int<class_int>` frame, :ref:`float<class_float>` delay **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_frame_texture<class_AnimatedTexture_method_set_frame_texture>` **(** :ref:`int<class_int>` frame, :ref:`Texture<class_Texture>` texture **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_frame_delay<class_AnimatedTexture_method_get_frame_delay>` **(** :ref:`int<class_int>` frame **)** const |
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`get_frame_texture<class_AnimatedTexture_method_get_frame_texture>` **(** :ref:`int<class_int>` frame **)** const |
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_frame_delay<class_AnimatedTexture_method_set_frame_delay>` **(** :ref:`int<class_int>` frame, :ref:`float<class_float>` delay **)** |
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_frame_texture<class_AnimatedTexture_method_set_frame_texture>` **(** :ref:`int<class_int>` frame, :ref:`Texture2D<class_Texture2D>` texture **)** |
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Constants
|
||||
---------
|
||||
@@ -101,9 +99,9 @@ Returns the given frame's delay value.
|
||||
|
||||
.. _class_AnimatedTexture_method_get_frame_texture:
|
||||
|
||||
- :ref:`Texture<class_Texture>` **get_frame_texture** **(** :ref:`int<class_int>` frame **)** const
|
||||
- :ref:`Texture2D<class_Texture2D>` **get_frame_texture** **(** :ref:`int<class_int>` frame **)** const
|
||||
|
||||
Returns the given frame's :ref:`Texture<class_Texture>`.
|
||||
Returns the given frame's :ref:`Texture2D<class_Texture2D>`.
|
||||
|
||||
----
|
||||
|
||||
@@ -126,9 +124,9 @@ For example, for an animation with 3 frames, 2 FPS and a frame delay on the seco
|
||||
|
||||
.. _class_AnimatedTexture_method_set_frame_texture:
|
||||
|
||||
- void **set_frame_texture** **(** :ref:`int<class_int>` frame, :ref:`Texture<class_Texture>` texture **)**
|
||||
- void **set_frame_texture** **(** :ref:`int<class_int>` frame, :ref:`Texture2D<class_Texture2D>` texture **)**
|
||||
|
||||
Assigns a :ref:`Texture<class_Texture>` to the given frame. Frame IDs start at 0, so the first frame has ID 0, and the last frame of the animation has ID :ref:`frames<class_AnimatedTexture_property_frames>` - 1.
|
||||
Assigns a :ref:`Texture2D<class_Texture2D>` to the given frame. Frame IDs start at 0, so the first frame has ID 0, and the last frame of the animation has ID :ref:`frames<class_AnimatedTexture_property_frames>` - 1.
|
||||
|
||||
You can define any number of textures up to :ref:`MAX_FRAMES<class_AnimatedTexture_constant_MAX_FRAMES>`, but keep in mind that only frames from 0 to :ref:`frames<class_AnimatedTexture_property_frames>` - 1 will be part of the animation.
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ An Animation resource contains data used to animate everything in the engine. An
|
||||
animation.track_insert_key(track_index, 0.0, 0)
|
||||
animation.track_insert_key(track_index, 0.5, 100)
|
||||
|
||||
Animations are just data containers, and must be added to nodes such as an :ref:`AnimationPlayer<class_AnimationPlayer>` or :ref:`AnimationTreePlayer<class_AnimationTreePlayer>` to be played back.
|
||||
Animations are just data containers, and must be added to nodes such as an :ref:`AnimationPlayer<class_AnimationPlayer>` to be played back. Animation tracks have different types, each with its own set of dedicated methods. Check :ref:`TrackType<enum_Animation_TrackType>` to see available types.
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
@@ -52,11 +52,11 @@ Methods
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`add_track<class_Animation_method_add_track>` **(** :ref:`TrackType<enum_Animation_TrackType>` type, :ref:`int<class_int>` at_position=-1 **)** |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation_track_get_key_animation<class_Animation_method_animation_track_get_key_animation>` **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
| :ref:`StringName<class_StringName>` | :ref:`animation_track_get_key_animation<class_Animation_method_animation_track_get_key_animation>` **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`animation_track_insert_key<class_Animation_method_animation_track_insert_key>` **(** :ref:`int<class_int>` track_idx, :ref:`float<class_float>` time, :ref:`String<class_String>` animation **)** |
|
||||
| :ref:`int<class_int>` | :ref:`animation_track_insert_key<class_Animation_method_animation_track_insert_key>` **(** :ref:`int<class_int>` track_idx, :ref:`float<class_float>` time, :ref:`StringName<class_StringName>` animation **)** |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_track_set_key_animation<class_Animation_method_animation_track_set_key_animation>` **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx, :ref:`String<class_String>` animation **)** |
|
||||
| void | :ref:`animation_track_set_key_animation<class_Animation_method_animation_track_set_key_animation>` **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx, :ref:`StringName<class_StringName>` animation **)** |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`audio_track_get_key_end_offset<class_Animation_method_audio_track_get_key_end_offset>` **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -96,9 +96,9 @@ Methods
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_track_count<class_Animation_method_get_track_count>` **(** **)** const |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`method_track_get_key_indices<class_Animation_method_method_track_get_key_indices>` **(** :ref:`int<class_int>` track_idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
|
||||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`method_track_get_key_indices<class_Animation_method_method_track_get_key_indices>` **(** :ref:`int<class_int>` track_idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`method_track_get_name<class_Animation_method_method_track_get_name>` **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
| :ref:`StringName<class_StringName>` | :ref:`method_track_get_name<class_Animation_method_method_track_get_name>` **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`method_track_get_params<class_Animation_method_method_track_get_params>` **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -160,7 +160,7 @@ Methods
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`transform_track_interpolate<class_Animation_method_transform_track_interpolate>` **(** :ref:`int<class_int>` track_idx, :ref:`float<class_float>` time_sec **)** const |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`value_track_get_key_indices<class_Animation_method_value_track_get_key_indices>` **(** :ref:`int<class_int>` track_idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
|
||||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`value_track_get_key_indices<class_Animation_method_value_track_get_key_indices>` **(** :ref:`int<class_int>` track_idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`UpdateMode<enum_Animation_UpdateMode>` | :ref:`value_track_get_update_mode<class_Animation_method_value_track_get_update_mode>` **(** :ref:`int<class_int>` track_idx **)** const |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -174,6 +174,8 @@ Signals
|
||||
|
||||
- **tracks_changed** **(** **)**
|
||||
|
||||
Emitted when there's a change in the list of tracks, e.g. tracks are added, moved or have changed paths.
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
@@ -199,11 +201,11 @@ enum **TrackType**:
|
||||
|
||||
- **TYPE_METHOD** = **2** --- Method tracks call functions with given arguments per key.
|
||||
|
||||
- **TYPE_BEZIER** = **3**
|
||||
- **TYPE_BEZIER** = **3** --- Bezier tracks are used to interpolate a value using custom curves. They can also be used to animate sub-properties of vectors and colors (e.g. alpha value of a :ref:`Color<class_Color>`).
|
||||
|
||||
- **TYPE_AUDIO** = **4**
|
||||
- **TYPE_AUDIO** = **4** --- Audio tracks are used to play an audio stream with either type of :ref:`AudioStreamPlayer<class_AudioStreamPlayer>`. The stream can be trimmed and previewed in the animation.
|
||||
|
||||
- **TYPE_ANIMATION** = **5**
|
||||
- **TYPE_ANIMATION** = **5** --- Animation tracks play animations in other :ref:`AnimationPlayer<class_AnimationPlayer>` nodes.
|
||||
|
||||
----
|
||||
|
||||
@@ -243,7 +245,7 @@ enum **UpdateMode**:
|
||||
|
||||
- **UPDATE_TRIGGER** = **2** --- Update at the keyframes.
|
||||
|
||||
- **UPDATE_CAPTURE** = **3**
|
||||
- **UPDATE_CAPTURE** = **3** --- Same as linear interpolation, but also interpolates from the current value (i.e. dynamically at runtime) if the first key isn't at 0 seconds.
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -309,19 +311,25 @@ Adds a track to the Animation.
|
||||
|
||||
.. _class_Animation_method_animation_track_get_key_animation:
|
||||
|
||||
- :ref:`String<class_String>` **animation_track_get_key_animation** **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx **)** const
|
||||
- :ref:`StringName<class_StringName>` **animation_track_get_key_animation** **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
Returns the animation name at the key identified by ``key_idx``. The ``track_idx`` must be the index of an Animation Track.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Animation_method_animation_track_insert_key:
|
||||
|
||||
- :ref:`int<class_int>` **animation_track_insert_key** **(** :ref:`int<class_int>` track_idx, :ref:`float<class_float>` time, :ref:`String<class_String>` animation **)**
|
||||
- :ref:`int<class_int>` **animation_track_insert_key** **(** :ref:`int<class_int>` track_idx, :ref:`float<class_float>` time, :ref:`StringName<class_StringName>` animation **)**
|
||||
|
||||
Inserts a key with value ``animation`` at the given ``time`` (in seconds). The ``track_idx`` must be the index of an Animation Track.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Animation_method_animation_track_set_key_animation:
|
||||
|
||||
- void **animation_track_set_key_animation** **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx, :ref:`String<class_String>` animation **)**
|
||||
- void **animation_track_set_key_animation** **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx, :ref:`StringName<class_StringName>` animation **)**
|
||||
|
||||
Sets the key identified by ``key_idx`` to value ``animation``. The ``track_idx`` must be the index of an Animation Track.
|
||||
|
||||
----
|
||||
|
||||
@@ -329,90 +337,128 @@ Adds a track to the Animation.
|
||||
|
||||
- :ref:`float<class_float>` **audio_track_get_key_end_offset** **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
Returns the end offset of the key identified by ``key_idx``. The ``track_idx`` must be the index of an Audio Track.
|
||||
|
||||
End offset is the number of seconds cut off at the ending of the audio stream.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Animation_method_audio_track_get_key_start_offset:
|
||||
|
||||
- :ref:`float<class_float>` **audio_track_get_key_start_offset** **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
Returns the start offset of the key identified by ``key_idx``. The ``track_idx`` must be the index of an Audio Track.
|
||||
|
||||
Start offset is the number of seconds cut off at the beginning of the audio stream.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Animation_method_audio_track_get_key_stream:
|
||||
|
||||
- :ref:`Resource<class_Resource>` **audio_track_get_key_stream** **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
Returns the audio stream of the key identified by ``key_idx``. The ``track_idx`` must be the index of an Audio Track.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Animation_method_audio_track_insert_key:
|
||||
|
||||
- :ref:`int<class_int>` **audio_track_insert_key** **(** :ref:`int<class_int>` track_idx, :ref:`float<class_float>` time, :ref:`Resource<class_Resource>` stream, :ref:`float<class_float>` start_offset=0, :ref:`float<class_float>` end_offset=0 **)**
|
||||
|
||||
Inserts an Audio Track key at the given ``time`` in seconds. The ``track_idx`` must be the index of an Audio Track.
|
||||
|
||||
``stream`` is the :ref:`AudioStream<class_AudioStream>` resource to play. ``start_offset`` is the number of seconds cut off at the beginning of the audio stream, while ``end_offset`` is at the ending.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Animation_method_audio_track_set_key_end_offset:
|
||||
|
||||
- void **audio_track_set_key_end_offset** **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` offset **)**
|
||||
|
||||
Sets the end offset of the key identified by ``key_idx`` to value ``offset``. The ``track_idx`` must be the index of an Audio Track.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Animation_method_audio_track_set_key_start_offset:
|
||||
|
||||
- void **audio_track_set_key_start_offset** **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` offset **)**
|
||||
|
||||
Sets the start offset of the key identified by ``key_idx`` to value ``offset``. The ``track_idx`` must be the index of an Audio Track.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Animation_method_audio_track_set_key_stream:
|
||||
|
||||
- void **audio_track_set_key_stream** **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx, :ref:`Resource<class_Resource>` stream **)**
|
||||
|
||||
Sets the stream of the key identified by ``key_idx`` to value ``offset``. The ``track_idx`` must be the index of an Audio Track.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Animation_method_bezier_track_get_key_in_handle:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **bezier_track_get_key_in_handle** **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
Returns the in handle of the key identified by ``key_idx``. The ``track_idx`` must be the index of a Bezier Track.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Animation_method_bezier_track_get_key_out_handle:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **bezier_track_get_key_out_handle** **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
Returns the out handle of the key identified by ``key_idx``. The ``track_idx`` must be the index of a Bezier Track.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Animation_method_bezier_track_get_key_value:
|
||||
|
||||
- :ref:`float<class_float>` **bezier_track_get_key_value** **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
Returns the value of the key identified by ``key_idx``. The ``track_idx`` must be the index of a Bezier Track.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Animation_method_bezier_track_insert_key:
|
||||
|
||||
- :ref:`int<class_int>` **bezier_track_insert_key** **(** :ref:`int<class_int>` track_idx, :ref:`float<class_float>` time, :ref:`float<class_float>` value, :ref:`Vector2<class_Vector2>` in_handle=Vector2( 0, 0 ), :ref:`Vector2<class_Vector2>` out_handle=Vector2( 0, 0 ) **)**
|
||||
|
||||
Inserts a Bezier Track key at the given ``time`` in seconds. The ``track_idx`` must be the index of a Bezier Track.
|
||||
|
||||
``in_handle`` is the left-side weight of the added Bezier curve point, ``out_handle`` is the right-side one, while ``value`` is the actual value at this point.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Animation_method_bezier_track_interpolate:
|
||||
|
||||
- :ref:`float<class_float>` **bezier_track_interpolate** **(** :ref:`int<class_int>` track_idx, :ref:`float<class_float>` time **)** const
|
||||
|
||||
Returns the interpolated value at the given ``time`` (in seconds). The ``track_idx`` must be the index of a Bezier Track.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Animation_method_bezier_track_set_key_in_handle:
|
||||
|
||||
- void **bezier_track_set_key_in_handle** **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx, :ref:`Vector2<class_Vector2>` in_handle **)**
|
||||
|
||||
Sets the in handle of the key identified by ``key_idx`` to value ``in_handle``. The ``track_idx`` must be the index of a Bezier Track.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Animation_method_bezier_track_set_key_out_handle:
|
||||
|
||||
- void **bezier_track_set_key_out_handle** **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx, :ref:`Vector2<class_Vector2>` out_handle **)**
|
||||
|
||||
Sets the out handle of the key identified by ``key_idx`` to value ``out_handle``. The ``track_idx`` must be the index of a Bezier Track.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Animation_method_bezier_track_set_key_value:
|
||||
|
||||
- void **bezier_track_set_key_value** **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` value **)**
|
||||
|
||||
Sets the value of the key identified by ``key_idx`` to the given value. The ``track_idx`` must be the index of a Bezier Track.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Animation_method_clear:
|
||||
@@ -449,7 +495,7 @@ Returns the amount of tracks in the animation.
|
||||
|
||||
.. _class_Animation_method_method_track_get_key_indices:
|
||||
|
||||
- :ref:`PoolIntArray<class_PoolIntArray>` **method_track_get_key_indices** **(** :ref:`int<class_int>` track_idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const
|
||||
- :ref:`PackedInt32Array<class_PackedInt32Array>` **method_track_get_key_indices** **(** :ref:`int<class_int>` track_idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const
|
||||
|
||||
Returns all the key indices of a method track, given a position and delta time.
|
||||
|
||||
@@ -457,7 +503,7 @@ Returns all the key indices of a method track, given a position and delta time.
|
||||
|
||||
.. _class_Animation_method_method_track_get_name:
|
||||
|
||||
- :ref:`String<class_String>` **method_track_get_name** **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx **)** const
|
||||
- :ref:`StringName<class_StringName>` **method_track_get_name** **(** :ref:`int<class_int>` track_idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
Returns the method name of a method track.
|
||||
|
||||
@@ -707,7 +753,7 @@ Returns the interpolated value of a transform track at a given time (in seconds)
|
||||
|
||||
.. _class_Animation_method_value_track_get_key_indices:
|
||||
|
||||
- :ref:`PoolIntArray<class_PoolIntArray>` **value_track_get_key_indices** **(** :ref:`int<class_int>` track_idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const
|
||||
- :ref:`PackedInt32Array<class_PackedInt32Array>` **value_track_get_key_indices** **(** :ref:`int<class_int>` track_idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const
|
||||
|
||||
Returns all the key indices of a value track, given a position and delta time.
|
||||
|
||||
|
||||
@@ -37,43 +37,43 @@ Properties
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_input<class_AnimationNode_method_add_input>` **(** :ref:`String<class_String>` name **)** |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend_animation<class_AnimationNode_method_blend_animation>` **(** :ref:`String<class_String>` animation, :ref:`float<class_float>` time, :ref:`float<class_float>` delta, :ref:`bool<class_bool>` seeked, :ref:`float<class_float>` blend **)** |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`blend_input<class_AnimationNode_method_blend_input>` **(** :ref:`int<class_int>` input_index, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)** |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`blend_node<class_AnimationNode_method_blend_node>` **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)** |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_caption<class_AnimationNode_method_get_caption>` **(** **)** virtual |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_Object>` | :ref:`get_child_by_name<class_AnimationNode_method_get_child_by_name>` **(** :ref:`String<class_String>` name **)** virtual |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_child_nodes<class_AnimationNode_method_get_child_nodes>` **(** **)** virtual |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_input_count<class_AnimationNode_method_get_input_count>` **(** **)** const |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_input_name<class_AnimationNode_method_get_input_name>` **(** :ref:`int<class_int>` input **)** |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`get_parameter<class_AnimationNode_method_get_parameter>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`get_parameter_default_value<class_AnimationNode_method_get_parameter_default_value>` **(** :ref:`String<class_String>` name **)** virtual |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_parameter_list<class_AnimationNode_method_get_parameter_list>` **(** **)** virtual |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`has_filter<class_AnimationNode_method_has_filter>` **(** **)** virtual |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_path_filtered<class_AnimationNode_method_is_path_filtered>` **(** :ref:`NodePath<class_NodePath>` path **)** const |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`process<class_AnimationNode_method_process>` **(** :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek **)** virtual |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_input<class_AnimationNode_method_remove_input>` **(** :ref:`int<class_int>` index **)** |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_filter_path<class_AnimationNode_method_set_filter_path>` **(** :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)** |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_parameter<class_AnimationNode_method_set_parameter>` **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_input<class_AnimationNode_method_add_input>` **(** :ref:`String<class_String>` name **)** |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend_animation<class_AnimationNode_method_blend_animation>` **(** :ref:`StringName<class_StringName>` animation, :ref:`float<class_float>` time, :ref:`float<class_float>` delta, :ref:`bool<class_bool>` seeked, :ref:`float<class_float>` blend **)** |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`blend_input<class_AnimationNode_method_blend_input>` **(** :ref:`int<class_int>` input_index, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)** |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`blend_node<class_AnimationNode_method_blend_node>` **(** :ref:`StringName<class_StringName>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)** |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_caption<class_AnimationNode_method_get_caption>` **(** **)** virtual |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_Object>` | :ref:`get_child_by_name<class_AnimationNode_method_get_child_by_name>` **(** :ref:`String<class_String>` name **)** virtual |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_child_nodes<class_AnimationNode_method_get_child_nodes>` **(** **)** virtual |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_input_count<class_AnimationNode_method_get_input_count>` **(** **)** const |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_input_name<class_AnimationNode_method_get_input_name>` **(** :ref:`int<class_int>` input **)** |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`get_parameter<class_AnimationNode_method_get_parameter>` **(** :ref:`StringName<class_StringName>` name **)** const |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`get_parameter_default_value<class_AnimationNode_method_get_parameter_default_value>` **(** :ref:`StringName<class_StringName>` name **)** virtual |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_parameter_list<class_AnimationNode_method_get_parameter_list>` **(** **)** virtual |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_filter<class_AnimationNode_method_has_filter>` **(** **)** virtual |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_path_filtered<class_AnimationNode_method_is_path_filtered>` **(** :ref:`NodePath<class_NodePath>` path **)** const |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`process<class_AnimationNode_method_process>` **(** :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek **)** virtual |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_input<class_AnimationNode_method_remove_input>` **(** :ref:`int<class_int>` index **)** |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_filter_path<class_AnimationNode_method_set_filter_path>` **(** :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)** |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_parameter<class_AnimationNode_method_set_parameter>` **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
@@ -143,7 +143,7 @@ Adds an input to the node. This is only useful for nodes created for use in an :
|
||||
|
||||
.. _class_AnimationNode_method_blend_animation:
|
||||
|
||||
- void **blend_animation** **(** :ref:`String<class_String>` animation, :ref:`float<class_float>` time, :ref:`float<class_float>` delta, :ref:`bool<class_bool>` seeked, :ref:`float<class_float>` blend **)**
|
||||
- void **blend_animation** **(** :ref:`StringName<class_StringName>` animation, :ref:`float<class_float>` time, :ref:`float<class_float>` delta, :ref:`bool<class_bool>` seeked, :ref:`float<class_float>` blend **)**
|
||||
|
||||
Blend an animation by ``blend`` amount (name must be valid in the linked :ref:`AnimationPlayer<class_AnimationPlayer>`). A ``time`` and ``delta`` may be passed, as well as whether ``seek`` happened.
|
||||
|
||||
@@ -159,7 +159,7 @@ Blend an input. This is only useful for nodes created for an :ref:`AnimationNode
|
||||
|
||||
.. _class_AnimationNode_method_blend_node:
|
||||
|
||||
- :ref:`float<class_float>` **blend_node** **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)**
|
||||
- :ref:`float<class_float>` **blend_node** **(** :ref:`StringName<class_StringName>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)**
|
||||
|
||||
Blend another animation node (in case this node contains children animation nodes). This function is only useful if you inherit from :ref:`AnimationRootNode<class_AnimationRootNode>` instead, else editors will not display your node for addition.
|
||||
|
||||
@@ -207,7 +207,7 @@ Gets the name of an input by index.
|
||||
|
||||
.. _class_AnimationNode_method_get_parameter:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **get_parameter** **(** :ref:`String<class_String>` name **)** const
|
||||
- :ref:`Variant<class_Variant>` **get_parameter** **(** :ref:`StringName<class_StringName>` name **)** const
|
||||
|
||||
Gets the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
|
||||
|
||||
@@ -215,7 +215,7 @@ Gets the value of a parameter. Parameters are custom local memory used for your
|
||||
|
||||
.. _class_AnimationNode_method_get_parameter_default_value:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **get_parameter_default_value** **(** :ref:`String<class_String>` name **)** virtual
|
||||
- :ref:`Variant<class_Variant>` **get_parameter_default_value** **(** :ref:`StringName<class_StringName>` name **)** virtual
|
||||
|
||||
Gets the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
|
||||
|
||||
@@ -231,7 +231,7 @@ Gets the property information for parameter. Parameters are custom local memory
|
||||
|
||||
.. _class_AnimationNode_method_has_filter:
|
||||
|
||||
- :ref:`String<class_String>` **has_filter** **(** **)** virtual
|
||||
- :ref:`bool<class_bool>` **has_filter** **(** **)** virtual
|
||||
|
||||
Returns ``true`` whether you want the blend tree editor to display filter editing on this node.
|
||||
|
||||
@@ -275,7 +275,7 @@ Adds or removes a path for the filter.
|
||||
|
||||
.. _class_AnimationNode_method_set_parameter:
|
||||
|
||||
- void **set_parameter** **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` value **)**
|
||||
- void **set_parameter** **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)**
|
||||
|
||||
Sets a custom parameter. These are used as local storage, because resources can be reused across the tree or scenes.
|
||||
|
||||
|
||||
@@ -26,19 +26,19 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------+-------------------------------------------------------------------+--------+
|
||||
| :ref:`String<class_String>` | :ref:`animation<class_AnimationNodeAnimation_property_animation>` | ``""`` |
|
||||
+-----------------------------+-------------------------------------------------------------------+--------+
|
||||
+-------------------------------------+-------------------------------------------------------------------+---------+
|
||||
| :ref:`StringName<class_StringName>` | :ref:`animation<class_AnimationNodeAnimation_property_animation>` | ``@""`` |
|
||||
+-------------------------------------+-------------------------------------------------------------------+---------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimationNodeAnimation_property_animation:
|
||||
|
||||
- :ref:`String<class_String>` **animation**
|
||||
- :ref:`StringName<class_StringName>` **animation**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | ``""`` |
|
||||
| *Default* | ``@""`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_animation(value) |
|
||||
+-----------+----------------------+
|
||||
|
||||
@@ -11,7 +11,12 @@ AnimationNodeBlendTree
|
||||
|
||||
**Inherits:** :ref:`AnimationRootNode<class_AnimationRootNode>` **<** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
:ref:`AnimationTree<class_AnimationTree>` node resource that contains many blend type nodes.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
This node may contain a sub-tree of any other blend type nodes, such as mix, blend2, blend3, one shot, etc. This is one of the most commonly used roots.
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
@@ -28,25 +33,25 @@ Properties
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_node<class_AnimationNodeBlendTree_method_add_node>` **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)** |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`connect_node<class_AnimationNodeBlendTree_method_connect_node>` **(** :ref:`String<class_String>` input_node, :ref:`int<class_int>` input_index, :ref:`String<class_String>` output_node **)** |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect_node<class_AnimationNodeBlendTree_method_disconnect_node>` **(** :ref:`String<class_String>` input_node, :ref:`int<class_int>` input_index **)** |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationNode<class_AnimationNode>` | :ref:`get_node<class_AnimationNodeBlendTree_method_get_node>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_node_position<class_AnimationNodeBlendTree_method_get_node_position>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_node<class_AnimationNodeBlendTree_method_has_node>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_node<class_AnimationNodeBlendTree_method_remove_node>` **(** :ref:`String<class_String>` name **)** |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rename_node<class_AnimationNodeBlendTree_method_rename_node>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)** |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_node_position<class_AnimationNodeBlendTree_method_set_node_position>` **(** :ref:`String<class_String>` name, :ref:`Vector2<class_Vector2>` position **)** |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_node<class_AnimationNodeBlendTree_method_add_node>` **(** :ref:`StringName<class_StringName>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)** |
|
||||
+-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`connect_node<class_AnimationNodeBlendTree_method_connect_node>` **(** :ref:`StringName<class_StringName>` input_node, :ref:`int<class_int>` input_index, :ref:`StringName<class_StringName>` output_node **)** |
|
||||
+-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect_node<class_AnimationNodeBlendTree_method_disconnect_node>` **(** :ref:`StringName<class_StringName>` input_node, :ref:`int<class_int>` input_index **)** |
|
||||
+-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationNode<class_AnimationNode>` | :ref:`get_node<class_AnimationNodeBlendTree_method_get_node>` **(** :ref:`StringName<class_StringName>` name **)** const |
|
||||
+-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_node_position<class_AnimationNodeBlendTree_method_get_node_position>` **(** :ref:`StringName<class_StringName>` name **)** const |
|
||||
+-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_node<class_AnimationNodeBlendTree_method_has_node>` **(** :ref:`StringName<class_StringName>` name **)** const |
|
||||
+-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_node<class_AnimationNodeBlendTree_method_remove_node>` **(** :ref:`StringName<class_StringName>` name **)** |
|
||||
+-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rename_node<class_AnimationNodeBlendTree_method_rename_node>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` new_name **)** |
|
||||
+-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_node_position<class_AnimationNodeBlendTree_method_set_node_position>` **(** :ref:`StringName<class_StringName>` name, :ref:`Vector2<class_Vector2>` position **)** |
|
||||
+-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Constants
|
||||
---------
|
||||
@@ -63,17 +68,17 @@ Constants
|
||||
|
||||
.. _class_AnimationNodeBlendTree_constant_CONNECTION_ERROR_CONNECTION_EXISTS:
|
||||
|
||||
- **CONNECTION_OK** = **0**
|
||||
- **CONNECTION_OK** = **0** --- The connection was successful.
|
||||
|
||||
- **CONNECTION_ERROR_NO_INPUT** = **1**
|
||||
- **CONNECTION_ERROR_NO_INPUT** = **1** --- The input node is ``null``.
|
||||
|
||||
- **CONNECTION_ERROR_NO_INPUT_INDEX** = **2**
|
||||
- **CONNECTION_ERROR_NO_INPUT_INDEX** = **2** --- The specified input port is out of range.
|
||||
|
||||
- **CONNECTION_ERROR_NO_OUTPUT** = **3**
|
||||
- **CONNECTION_ERROR_NO_OUTPUT** = **3** --- The output node is ``null``.
|
||||
|
||||
- **CONNECTION_ERROR_SAME_NODE** = **4**
|
||||
- **CONNECTION_ERROR_SAME_NODE** = **4** --- Input and output nodes are the same.
|
||||
|
||||
- **CONNECTION_ERROR_CONNECTION_EXISTS** = **5**
|
||||
- **CONNECTION_ERROR_CONNECTION_EXISTS** = **5** --- The specified connection already exists.
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -90,58 +95,78 @@ Property Descriptions
|
||||
| *Getter* | get_graph_offset() |
|
||||
+-----------+-------------------------+
|
||||
|
||||
The global offset of all sub-nodes.
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AnimationNodeBlendTree_method_add_node:
|
||||
|
||||
- void **add_node** **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)**
|
||||
- void **add_node** **(** :ref:`StringName<class_StringName>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)**
|
||||
|
||||
Adds an :ref:`AnimationNode<class_AnimationNode>` at the given ``position``. The ``name`` is used to identify the created sub-node later.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationNodeBlendTree_method_connect_node:
|
||||
|
||||
- void **connect_node** **(** :ref:`String<class_String>` input_node, :ref:`int<class_int>` input_index, :ref:`String<class_String>` output_node **)**
|
||||
- void **connect_node** **(** :ref:`StringName<class_StringName>` input_node, :ref:`int<class_int>` input_index, :ref:`StringName<class_StringName>` output_node **)**
|
||||
|
||||
Connects the output of an :ref:`AnimationNode<class_AnimationNode>` as input for another :ref:`AnimationNode<class_AnimationNode>`, at the input port specified by ``input_index``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationNodeBlendTree_method_disconnect_node:
|
||||
|
||||
- void **disconnect_node** **(** :ref:`String<class_String>` input_node, :ref:`int<class_int>` input_index **)**
|
||||
- void **disconnect_node** **(** :ref:`StringName<class_StringName>` input_node, :ref:`int<class_int>` input_index **)**
|
||||
|
||||
Disconnects the node connected to the specified input.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationNodeBlendTree_method_get_node:
|
||||
|
||||
- :ref:`AnimationNode<class_AnimationNode>` **get_node** **(** :ref:`String<class_String>` name **)** const
|
||||
- :ref:`AnimationNode<class_AnimationNode>` **get_node** **(** :ref:`StringName<class_StringName>` name **)** const
|
||||
|
||||
Returns the sub-node with the specified ``name``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationNodeBlendTree_method_get_node_position:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **get_node_position** **(** :ref:`String<class_String>` name **)** const
|
||||
- :ref:`Vector2<class_Vector2>` **get_node_position** **(** :ref:`StringName<class_StringName>` name **)** const
|
||||
|
||||
Returns the position of the sub-node with the specified ``name``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationNodeBlendTree_method_has_node:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_node** **(** :ref:`String<class_String>` name **)** const
|
||||
- :ref:`bool<class_bool>` **has_node** **(** :ref:`StringName<class_StringName>` name **)** const
|
||||
|
||||
Returns ``true`` if a sub-node with specified ``name`` exists.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationNodeBlendTree_method_remove_node:
|
||||
|
||||
- void **remove_node** **(** :ref:`String<class_String>` name **)**
|
||||
- void **remove_node** **(** :ref:`StringName<class_StringName>` name **)**
|
||||
|
||||
Removes a sub-node.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationNodeBlendTree_method_rename_node:
|
||||
|
||||
- void **rename_node** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)**
|
||||
- void **rename_node** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` new_name **)**
|
||||
|
||||
Changes the name of a sub-node.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationNodeBlendTree_method_set_node_position:
|
||||
|
||||
- void **set_node_position** **(** :ref:`String<class_String>` name, :ref:`Vector2<class_Vector2>` position **)**
|
||||
- void **set_node_position** **(** :ref:`StringName<class_StringName>` name, :ref:`Vector2<class_Vector2>` position **)**
|
||||
|
||||
Modifies the position of a sub-node.
|
||||
|
||||
|
||||
@@ -11,7 +11,12 @@ AnimationNodeOneShot
|
||||
|
||||
**Inherits:** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
Plays an animation once in :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`. This node will execute a sub-animation and return once it finishes. Blend times for fading in and out can be customized, as well as filters.
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
@@ -74,6 +79,8 @@ Property Descriptions
|
||||
| *Getter* | has_autorestart() |
|
||||
+-----------+------------------------+
|
||||
|
||||
If ``true``, the sub-animation will restart automatically after finishing.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationNodeOneShot_property_autorestart_delay:
|
||||
@@ -88,6 +95,8 @@ Property Descriptions
|
||||
| *Getter* | get_autorestart_delay() |
|
||||
+-----------+------------------------------+
|
||||
|
||||
The delay after which the automatic restart is triggered, in seconds.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationNodeOneShot_property_autorestart_random_delay:
|
||||
@@ -102,6 +111,8 @@ Property Descriptions
|
||||
| *Getter* | get_autorestart_random_delay() |
|
||||
+-----------+-------------------------------------+
|
||||
|
||||
If :ref:`autorestart<class_AnimationNodeOneShot_property_autorestart>` is ``true``, a random additional delay (in seconds) between 0 and this value will be added to :ref:`autorestart_delay<class_AnimationNodeOneShot_property_autorestart_delay>`.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationNodeOneShot_property_fadein_time:
|
||||
|
||||
@@ -11,7 +11,7 @@ AnimationNodeOutput
|
||||
|
||||
**Inherits:** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
|
||||
Generic output node to be added to :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
|
||||
@@ -33,58 +33,58 @@ Tutorials
|
||||
Methods
|
||||
-------
|
||||
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_node<class_AnimationNodeStateMachine_method_add_node>` **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_transition<class_AnimationNodeStateMachine_method_add_transition>` **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to, :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` transition **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_end_node<class_AnimationNodeStateMachine_method_get_end_node>` **(** **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_graph_offset<class_AnimationNodeStateMachine_method_get_graph_offset>` **(** **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationNode<class_AnimationNode>` | :ref:`get_node<class_AnimationNodeStateMachine_method_get_node>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_node_name<class_AnimationNodeStateMachine_method_get_node_name>` **(** :ref:`AnimationNode<class_AnimationNode>` node **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_node_position<class_AnimationNodeStateMachine_method_get_node_position>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_start_node<class_AnimationNodeStateMachine_method_get_start_node>` **(** **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` | :ref:`get_transition<class_AnimationNodeStateMachine_method_get_transition>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_transition_count<class_AnimationNodeStateMachine_method_get_transition_count>` **(** **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_transition_from<class_AnimationNodeStateMachine_method_get_transition_from>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_transition_to<class_AnimationNodeStateMachine_method_get_transition_to>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_node<class_AnimationNodeStateMachine_method_has_node>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_transition<class_AnimationNodeStateMachine_method_has_transition>` **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_node<class_AnimationNodeStateMachine_method_remove_node>` **(** :ref:`String<class_String>` name **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_transition<class_AnimationNodeStateMachine_method_remove_transition>` **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_transition_by_index<class_AnimationNodeStateMachine_method_remove_transition_by_index>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rename_node<class_AnimationNodeStateMachine_method_rename_node>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_end_node<class_AnimationNodeStateMachine_method_set_end_node>` **(** :ref:`String<class_String>` name **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_graph_offset<class_AnimationNodeStateMachine_method_set_graph_offset>` **(** :ref:`Vector2<class_Vector2>` offset **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_node_position<class_AnimationNodeStateMachine_method_set_node_position>` **(** :ref:`String<class_String>` name, :ref:`Vector2<class_Vector2>` position **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_start_node<class_AnimationNodeStateMachine_method_set_start_node>` **(** :ref:`String<class_String>` name **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_node<class_AnimationNodeStateMachine_method_add_node>` **(** :ref:`StringName<class_StringName>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)** |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_transition<class_AnimationNodeStateMachine_method_add_transition>` **(** :ref:`StringName<class_StringName>` from, :ref:`StringName<class_StringName>` to, :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` transition **)** |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_end_node<class_AnimationNodeStateMachine_method_get_end_node>` **(** **)** const |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_graph_offset<class_AnimationNodeStateMachine_method_get_graph_offset>` **(** **)** const |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationNode<class_AnimationNode>` | :ref:`get_node<class_AnimationNodeStateMachine_method_get_node>` **(** :ref:`StringName<class_StringName>` name **)** const |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`StringName<class_StringName>` | :ref:`get_node_name<class_AnimationNodeStateMachine_method_get_node_name>` **(** :ref:`AnimationNode<class_AnimationNode>` node **)** const |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_node_position<class_AnimationNodeStateMachine_method_get_node_position>` **(** :ref:`StringName<class_StringName>` name **)** const |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_start_node<class_AnimationNodeStateMachine_method_get_start_node>` **(** **)** const |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` | :ref:`get_transition<class_AnimationNodeStateMachine_method_get_transition>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_transition_count<class_AnimationNodeStateMachine_method_get_transition_count>` **(** **)** const |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`StringName<class_StringName>` | :ref:`get_transition_from<class_AnimationNodeStateMachine_method_get_transition_from>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`StringName<class_StringName>` | :ref:`get_transition_to<class_AnimationNodeStateMachine_method_get_transition_to>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_node<class_AnimationNodeStateMachine_method_has_node>` **(** :ref:`StringName<class_StringName>` name **)** const |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_transition<class_AnimationNodeStateMachine_method_has_transition>` **(** :ref:`StringName<class_StringName>` from, :ref:`StringName<class_StringName>` to **)** const |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_node<class_AnimationNodeStateMachine_method_remove_node>` **(** :ref:`StringName<class_StringName>` name **)** |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_transition<class_AnimationNodeStateMachine_method_remove_transition>` **(** :ref:`StringName<class_StringName>` from, :ref:`StringName<class_StringName>` to **)** |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_transition_by_index<class_AnimationNodeStateMachine_method_remove_transition_by_index>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rename_node<class_AnimationNodeStateMachine_method_rename_node>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` new_name **)** |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_end_node<class_AnimationNodeStateMachine_method_set_end_node>` **(** :ref:`StringName<class_StringName>` name **)** |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_graph_offset<class_AnimationNodeStateMachine_method_set_graph_offset>` **(** :ref:`Vector2<class_Vector2>` offset **)** |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_node_position<class_AnimationNodeStateMachine_method_set_node_position>` **(** :ref:`StringName<class_StringName>` name, :ref:`Vector2<class_Vector2>` position **)** |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_start_node<class_AnimationNodeStateMachine_method_set_start_node>` **(** :ref:`StringName<class_StringName>` name **)** |
|
||||
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AnimationNodeStateMachine_method_add_node:
|
||||
|
||||
- void **add_node** **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)**
|
||||
- void **add_node** **(** :ref:`StringName<class_StringName>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)**
|
||||
|
||||
Adds a new node to the graph. The ``position`` is used for display in the editor.
|
||||
|
||||
@@ -92,7 +92,7 @@ Adds a new node to the graph. The ``position`` is used for display in the editor
|
||||
|
||||
.. _class_AnimationNodeStateMachine_method_add_transition:
|
||||
|
||||
- void **add_transition** **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to, :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` transition **)**
|
||||
- void **add_transition** **(** :ref:`StringName<class_StringName>` from, :ref:`StringName<class_StringName>` to, :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` transition **)**
|
||||
|
||||
Adds a transition between the given nodes.
|
||||
|
||||
@@ -116,7 +116,7 @@ Returns the draw offset of the graph. Used for display in the editor.
|
||||
|
||||
.. _class_AnimationNodeStateMachine_method_get_node:
|
||||
|
||||
- :ref:`AnimationNode<class_AnimationNode>` **get_node** **(** :ref:`String<class_String>` name **)** const
|
||||
- :ref:`AnimationNode<class_AnimationNode>` **get_node** **(** :ref:`StringName<class_StringName>` name **)** const
|
||||
|
||||
Returns the animation node with the given name.
|
||||
|
||||
@@ -124,7 +124,7 @@ Returns the animation node with the given name.
|
||||
|
||||
.. _class_AnimationNodeStateMachine_method_get_node_name:
|
||||
|
||||
- :ref:`String<class_String>` **get_node_name** **(** :ref:`AnimationNode<class_AnimationNode>` node **)** const
|
||||
- :ref:`StringName<class_StringName>` **get_node_name** **(** :ref:`AnimationNode<class_AnimationNode>` node **)** const
|
||||
|
||||
Returns the given animation node's name.
|
||||
|
||||
@@ -132,7 +132,7 @@ Returns the given animation node's name.
|
||||
|
||||
.. _class_AnimationNodeStateMachine_method_get_node_position:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **get_node_position** **(** :ref:`String<class_String>` name **)** const
|
||||
- :ref:`Vector2<class_Vector2>` **get_node_position** **(** :ref:`StringName<class_StringName>` name **)** const
|
||||
|
||||
Returns the given node's coordinates. Used for display in the editor.
|
||||
|
||||
@@ -164,7 +164,7 @@ Returns the number of connections in the graph.
|
||||
|
||||
.. _class_AnimationNodeStateMachine_method_get_transition_from:
|
||||
|
||||
- :ref:`String<class_String>` **get_transition_from** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`StringName<class_StringName>` **get_transition_from** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Returns the given transition's start node.
|
||||
|
||||
@@ -172,7 +172,7 @@ Returns the given transition's start node.
|
||||
|
||||
.. _class_AnimationNodeStateMachine_method_get_transition_to:
|
||||
|
||||
- :ref:`String<class_String>` **get_transition_to** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`StringName<class_StringName>` **get_transition_to** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Returns the given transition's end node.
|
||||
|
||||
@@ -180,7 +180,7 @@ Returns the given transition's end node.
|
||||
|
||||
.. _class_AnimationNodeStateMachine_method_has_node:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_node** **(** :ref:`String<class_String>` name **)** const
|
||||
- :ref:`bool<class_bool>` **has_node** **(** :ref:`StringName<class_StringName>` name **)** const
|
||||
|
||||
Returns ``true`` if the graph contains the given node.
|
||||
|
||||
@@ -188,7 +188,7 @@ Returns ``true`` if the graph contains the given node.
|
||||
|
||||
.. _class_AnimationNodeStateMachine_method_has_transition:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_transition** **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to **)** const
|
||||
- :ref:`bool<class_bool>` **has_transition** **(** :ref:`StringName<class_StringName>` from, :ref:`StringName<class_StringName>` to **)** const
|
||||
|
||||
Returns ``true`` if there is a transition between the given nodes.
|
||||
|
||||
@@ -196,7 +196,7 @@ Returns ``true`` if there is a transition between the given nodes.
|
||||
|
||||
.. _class_AnimationNodeStateMachine_method_remove_node:
|
||||
|
||||
- void **remove_node** **(** :ref:`String<class_String>` name **)**
|
||||
- void **remove_node** **(** :ref:`StringName<class_StringName>` name **)**
|
||||
|
||||
Deletes the given node from the graph.
|
||||
|
||||
@@ -204,7 +204,7 @@ Deletes the given node from the graph.
|
||||
|
||||
.. _class_AnimationNodeStateMachine_method_remove_transition:
|
||||
|
||||
- void **remove_transition** **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to **)**
|
||||
- void **remove_transition** **(** :ref:`StringName<class_StringName>` from, :ref:`StringName<class_StringName>` to **)**
|
||||
|
||||
Deletes the transition between the two specified nodes.
|
||||
|
||||
@@ -220,7 +220,7 @@ Deletes the given transition by index.
|
||||
|
||||
.. _class_AnimationNodeStateMachine_method_rename_node:
|
||||
|
||||
- void **rename_node** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)**
|
||||
- void **rename_node** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` new_name **)**
|
||||
|
||||
Renames the given node.
|
||||
|
||||
@@ -228,7 +228,7 @@ Renames the given node.
|
||||
|
||||
.. _class_AnimationNodeStateMachine_method_set_end_node:
|
||||
|
||||
- void **set_end_node** **(** :ref:`String<class_String>` name **)**
|
||||
- void **set_end_node** **(** :ref:`StringName<class_StringName>` name **)**
|
||||
|
||||
Sets the given node as the graph end point.
|
||||
|
||||
@@ -244,7 +244,7 @@ Sets the draw offset of the graph. Used for display in the editor.
|
||||
|
||||
.. _class_AnimationNodeStateMachine_method_set_node_position:
|
||||
|
||||
- void **set_node_position** **(** :ref:`String<class_String>` name, :ref:`Vector2<class_Vector2>` position **)**
|
||||
- void **set_node_position** **(** :ref:`StringName<class_StringName>` name, :ref:`Vector2<class_Vector2>` position **)**
|
||||
|
||||
Sets the node's coordinates. Used for display in the editor.
|
||||
|
||||
@@ -252,7 +252,7 @@ Sets the node's coordinates. Used for display in the editor.
|
||||
|
||||
.. _class_AnimationNodeStateMachine_method_set_start_node:
|
||||
|
||||
- void **set_start_node** **(** :ref:`String<class_String>` name **)**
|
||||
- void **set_start_node** **(** :ref:`StringName<class_StringName>` name **)**
|
||||
|
||||
Sets the given node as the graph start point.
|
||||
|
||||
|
||||
@@ -40,26 +40,26 @@ Properties
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_current_node<class_AnimationNodeStateMachinePlayback_method_get_current_node>` **(** **)** const |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_travel_path<class_AnimationNodeStateMachinePlayback_method_get_travel_path>` **(** **)** const |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationNodeStateMachinePlayback_method_is_playing>` **(** **)** const |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`start<class_AnimationNodeStateMachinePlayback_method_start>` **(** :ref:`String<class_String>` node **)** |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimationNodeStateMachinePlayback_method_stop>` **(** **)** |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`travel<class_AnimationNodeStateMachinePlayback_method_travel>` **(** :ref:`String<class_String>` to_node **)** |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`StringName<class_StringName>` | :ref:`get_current_node<class_AnimationNodeStateMachinePlayback_method_get_current_node>` **(** **)** const |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_travel_path<class_AnimationNodeStateMachinePlayback_method_get_travel_path>` **(** **)** const |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationNodeStateMachinePlayback_method_is_playing>` **(** **)** const |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`start<class_AnimationNodeStateMachinePlayback_method_start>` **(** :ref:`StringName<class_StringName>` node **)** |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimationNodeStateMachinePlayback_method_stop>` **(** **)** |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`travel<class_AnimationNodeStateMachinePlayback_method_travel>` **(** :ref:`StringName<class_StringName>` to_node **)** |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AnimationNodeStateMachinePlayback_method_get_current_node:
|
||||
|
||||
- :ref:`String<class_String>` **get_current_node** **(** **)** const
|
||||
- :ref:`StringName<class_StringName>` **get_current_node** **(** **)** const
|
||||
|
||||
Returns the currently playing animation state.
|
||||
|
||||
@@ -67,7 +67,7 @@ Returns the currently playing animation state.
|
||||
|
||||
.. _class_AnimationNodeStateMachinePlayback_method_get_travel_path:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **get_travel_path** **(** **)** const
|
||||
- :ref:`PackedStringArray<class_PackedStringArray>` **get_travel_path** **(** **)** const
|
||||
|
||||
Returns the current travel path as computed internally by the A\* algorithm.
|
||||
|
||||
@@ -83,7 +83,7 @@ Returns ``true`` if an animation is playing.
|
||||
|
||||
.. _class_AnimationNodeStateMachinePlayback_method_start:
|
||||
|
||||
- void **start** **(** :ref:`String<class_String>` node **)**
|
||||
- void **start** **(** :ref:`StringName<class_StringName>` node **)**
|
||||
|
||||
Starts playing the given animation.
|
||||
|
||||
@@ -99,7 +99,7 @@ Stops the currently playing animation.
|
||||
|
||||
.. _class_AnimationNodeStateMachinePlayback_method_travel:
|
||||
|
||||
- void **travel** **(** :ref:`String<class_String>` to_node **)**
|
||||
- void **travel** **(** :ref:`StringName<class_StringName>` to_node **)**
|
||||
|
||||
Transitions from the current state to another one, following the shortest path.
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ Properties
|
||||
----------
|
||||
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`String<class_String>` | :ref:`advance_condition<class_AnimationNodeStateMachineTransition_property_advance_condition>` | ``""`` |
|
||||
| :ref:`StringName<class_StringName>` | :ref:`advance_condition<class_AnimationNodeStateMachineTransition_property_advance_condition>` | ``@""`` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`auto_advance<class_AnimationNodeStateMachineTransition_property_auto_advance>` | ``false`` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-----------+
|
||||
@@ -68,10 +68,10 @@ Property Descriptions
|
||||
|
||||
.. _class_AnimationNodeStateMachineTransition_property_advance_condition:
|
||||
|
||||
- :ref:`String<class_String>` **advance_condition**
|
||||
- :ref:`StringName<class_StringName>` **advance_condition**
|
||||
|
||||
+-----------+------------------------------+
|
||||
| *Default* | ``""`` |
|
||||
| *Default* | ``@""`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_advance_condition(value) |
|
||||
+-----------+------------------------------+
|
||||
|
||||
@@ -11,7 +11,12 @@ AnimationNodeTimeScale
|
||||
|
||||
**Inherits:** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
A time-scaling animation node to be used with :ref:`AnimationTree<class_AnimationTree>`.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Allows scaling the speed of the animation (or reversing it) in any children nodes. Setting it to 0 will pause the animation.
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
|
||||
@@ -11,7 +11,12 @@ AnimationNodeTimeSeek
|
||||
|
||||
**Inherits:** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
A time-seeking animation node to be used with :ref:`AnimationTree<class_AnimationTree>`.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
This node can be used to cause a seek command to happen to any sub-children of the graph. After setting the time, this value returns to -1.
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
|
||||
@@ -11,7 +11,12 @@ AnimationNodeTransition
|
||||
|
||||
**Inherits:** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
A generic animation transition node for :ref:`AnimationTree<class_AnimationTree>`.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Simple state machine for cases which don't require a more advanced :ref:`AnimationNodeStateMachine<class_AnimationNodeStateMachine>`. Animations can be connected to the inputs and transition times can be specified.
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
@@ -55,6 +60,8 @@ Property Descriptions
|
||||
| *Getter* | get_enabled_inputs() |
|
||||
+-----------+---------------------------+
|
||||
|
||||
The number of available input ports for this node.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationNodeTransition_property_xfade_time:
|
||||
@@ -69,6 +76,8 @@ Property Descriptions
|
||||
| *Getter* | get_cross_fade_time() |
|
||||
+-----------+----------------------------+
|
||||
|
||||
Cross-fading time (in seconds) between each animation connected to the inputs.
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
|
||||
@@ -18,6 +18,8 @@ Description
|
||||
|
||||
An animation player is used for general-purpose playback of :ref:`Animation<class_Animation>` resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels.
|
||||
|
||||
``AnimationPlayer`` is more suited than :ref:`Tween<class_Tween>` for animations where you know the final values in advance. For example, fading a screen in and out is more easily done with an ``AnimationPlayer`` node thanks to the animation tools provided by the editor. That particular example can also be implemented with a :ref:`Tween<class_Tween>` node, but it requires doing everything by code.
|
||||
|
||||
Updating the target properties of animations occurs at process time.
|
||||
|
||||
Tutorials
|
||||
@@ -57,58 +59,58 @@ Properties
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`add_animation<class_AnimationPlayer_method_add_animation>` **(** :ref:`String<class_String>` name, :ref:`Animation<class_Animation>` animation **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`advance<class_AnimationPlayer_method_advance>` **(** :ref:`float<class_float>` delta **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation_get_next<class_AnimationPlayer_method_animation_get_next>` **(** :ref:`String<class_String>` anim_from **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_set_next<class_AnimationPlayer_method_animation_set_next>` **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_caches<class_AnimationPlayer_method_clear_caches>` **(** **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_queue<class_AnimationPlayer_method_clear_queue>` **(** **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`find_animation<class_AnimationPlayer_method_find_animation>` **(** :ref:`Animation<class_Animation>` animation **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Animation<class_Animation>` | :ref:`get_animation<class_AnimationPlayer_method_get_animation>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_animation_list<class_AnimationPlayer_method_get_animation_list>` **(** **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_blend_time<class_AnimationPlayer_method_get_blend_time>` **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_playing_speed<class_AnimationPlayer_method_get_playing_speed>` **(** **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_queue<class_AnimationPlayer_method_get_queue>` **(** **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_animation<class_AnimationPlayer_method_has_animation>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationPlayer_method_is_playing>` **(** **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AnimationPlayer_method_play>` **(** :ref:`String<class_String>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1.0, :ref:`bool<class_bool>` from_end=false **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play_backwards<class_AnimationPlayer_method_play_backwards>` **(** :ref:`String<class_String>` name="", :ref:`float<class_float>` custom_blend=-1 **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`queue<class_AnimationPlayer_method_queue>` **(** :ref:`String<class_String>` name **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_animation<class_AnimationPlayer_method_remove_animation>` **(** :ref:`String<class_String>` name **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rename_animation<class_AnimationPlayer_method_rename_animation>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` newname **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seek<class_AnimationPlayer_method_seek>` **(** :ref:`float<class_float>` seconds, :ref:`bool<class_bool>` update=false **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_blend_time<class_AnimationPlayer_method_set_blend_time>` **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to, :ref:`float<class_float>` sec **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimationPlayer_method_stop>` **(** :ref:`bool<class_bool>` reset=true **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`add_animation<class_AnimationPlayer_method_add_animation>` **(** :ref:`StringName<class_StringName>` name, :ref:`Animation<class_Animation>` animation **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`advance<class_AnimationPlayer_method_advance>` **(** :ref:`float<class_float>` delta **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`StringName<class_StringName>` | :ref:`animation_get_next<class_AnimationPlayer_method_animation_get_next>` **(** :ref:`StringName<class_StringName>` anim_from **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_set_next<class_AnimationPlayer_method_animation_set_next>` **(** :ref:`StringName<class_StringName>` anim_from, :ref:`StringName<class_StringName>` anim_to **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_caches<class_AnimationPlayer_method_clear_caches>` **(** **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_queue<class_AnimationPlayer_method_clear_queue>` **(** **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`StringName<class_StringName>` | :ref:`find_animation<class_AnimationPlayer_method_find_animation>` **(** :ref:`Animation<class_Animation>` animation **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Animation<class_Animation>` | :ref:`get_animation<class_AnimationPlayer_method_get_animation>` **(** :ref:`StringName<class_StringName>` name **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_animation_list<class_AnimationPlayer_method_get_animation_list>` **(** **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_blend_time<class_AnimationPlayer_method_get_blend_time>` **(** :ref:`StringName<class_StringName>` anim_from, :ref:`StringName<class_StringName>` anim_to **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_playing_speed<class_AnimationPlayer_method_get_playing_speed>` **(** **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_queue<class_AnimationPlayer_method_get_queue>` **(** **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_animation<class_AnimationPlayer_method_has_animation>` **(** :ref:`StringName<class_StringName>` name **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationPlayer_method_is_playing>` **(** **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AnimationPlayer_method_play>` **(** :ref:`StringName<class_StringName>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1.0, :ref:`bool<class_bool>` from_end=false **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play_backwards<class_AnimationPlayer_method_play_backwards>` **(** :ref:`StringName<class_StringName>` name="", :ref:`float<class_float>` custom_blend=-1 **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`queue<class_AnimationPlayer_method_queue>` **(** :ref:`StringName<class_StringName>` name **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_animation<class_AnimationPlayer_method_remove_animation>` **(** :ref:`StringName<class_StringName>` name **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rename_animation<class_AnimationPlayer_method_rename_animation>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` newname **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seek<class_AnimationPlayer_method_seek>` **(** :ref:`float<class_float>` seconds, :ref:`bool<class_bool>` update=false **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_blend_time<class_AnimationPlayer_method_set_blend_time>` **(** :ref:`StringName<class_StringName>` anim_from, :ref:`StringName<class_StringName>` anim_to, :ref:`float<class_float>` sec **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimationPlayer_method_stop>` **(** :ref:`bool<class_bool>` reset=true **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_AnimationPlayer_signal_animation_changed:
|
||||
|
||||
- **animation_changed** **(** :ref:`String<class_String>` old_name, :ref:`String<class_String>` new_name **)**
|
||||
- **animation_changed** **(** :ref:`StringName<class_StringName>` old_name, :ref:`StringName<class_StringName>` new_name **)**
|
||||
|
||||
If the currently being played animation changes, this signal will notify of such change.
|
||||
|
||||
@@ -116,7 +118,7 @@ If the currently being played animation changes, this signal will notify of such
|
||||
|
||||
.. _class_AnimationPlayer_signal_animation_finished:
|
||||
|
||||
- **animation_finished** **(** :ref:`String<class_String>` anim_name **)**
|
||||
- **animation_finished** **(** :ref:`StringName<class_StringName>` anim_name **)**
|
||||
|
||||
Notifies when an animation finished playing.
|
||||
|
||||
@@ -124,7 +126,7 @@ Notifies when an animation finished playing.
|
||||
|
||||
.. _class_AnimationPlayer_signal_animation_started:
|
||||
|
||||
- **animation_started** **(** :ref:`String<class_String>` anim_name **)**
|
||||
- **animation_started** **(** :ref:`StringName<class_StringName>` anim_name **)**
|
||||
|
||||
Notifies when an animation starts playing.
|
||||
|
||||
@@ -339,7 +341,7 @@ Method Descriptions
|
||||
|
||||
.. _class_AnimationPlayer_method_add_animation:
|
||||
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **add_animation** **(** :ref:`String<class_String>` name, :ref:`Animation<class_Animation>` animation **)**
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **add_animation** **(** :ref:`StringName<class_StringName>` name, :ref:`Animation<class_Animation>` animation **)**
|
||||
|
||||
Adds ``animation`` to the player accessible with the key ``name``.
|
||||
|
||||
@@ -355,7 +357,7 @@ Shifts position in the animation timeline and immediately updates the animation.
|
||||
|
||||
.. _class_AnimationPlayer_method_animation_get_next:
|
||||
|
||||
- :ref:`String<class_String>` **animation_get_next** **(** :ref:`String<class_String>` anim_from **)** const
|
||||
- :ref:`StringName<class_StringName>` **animation_get_next** **(** :ref:`StringName<class_StringName>` anim_from **)** const
|
||||
|
||||
Returns the name of the next animation in the queue.
|
||||
|
||||
@@ -363,7 +365,7 @@ Returns the name of the next animation in the queue.
|
||||
|
||||
.. _class_AnimationPlayer_method_animation_set_next:
|
||||
|
||||
- void **animation_set_next** **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to **)**
|
||||
- void **animation_set_next** **(** :ref:`StringName<class_StringName>` anim_from, :ref:`StringName<class_StringName>` anim_to **)**
|
||||
|
||||
Triggers the ``anim_to`` animation when the ``anim_from`` animation completes.
|
||||
|
||||
@@ -387,7 +389,7 @@ Clears all queued, unplayed animations.
|
||||
|
||||
.. _class_AnimationPlayer_method_find_animation:
|
||||
|
||||
- :ref:`String<class_String>` **find_animation** **(** :ref:`Animation<class_Animation>` animation **)** const
|
||||
- :ref:`StringName<class_StringName>` **find_animation** **(** :ref:`Animation<class_Animation>` animation **)** const
|
||||
|
||||
Returns the name of ``animation`` or an empty string if not found.
|
||||
|
||||
@@ -395,7 +397,7 @@ Returns the name of ``animation`` or an empty string if not found.
|
||||
|
||||
.. _class_AnimationPlayer_method_get_animation:
|
||||
|
||||
- :ref:`Animation<class_Animation>` **get_animation** **(** :ref:`String<class_String>` name **)** const
|
||||
- :ref:`Animation<class_Animation>` **get_animation** **(** :ref:`StringName<class_StringName>` name **)** const
|
||||
|
||||
Returns the :ref:`Animation<class_Animation>` with key ``name`` or ``null`` if not found.
|
||||
|
||||
@@ -403,7 +405,7 @@ Returns the :ref:`Animation<class_Animation>` with key ``name`` or ``null`` if n
|
||||
|
||||
.. _class_AnimationPlayer_method_get_animation_list:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **get_animation_list** **(** **)** const
|
||||
- :ref:`PackedStringArray<class_PackedStringArray>` **get_animation_list** **(** **)** const
|
||||
|
||||
Returns the list of stored animation names.
|
||||
|
||||
@@ -411,7 +413,7 @@ Returns the list of stored animation names.
|
||||
|
||||
.. _class_AnimationPlayer_method_get_blend_time:
|
||||
|
||||
- :ref:`float<class_float>` **get_blend_time** **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to **)** const
|
||||
- :ref:`float<class_float>` **get_blend_time** **(** :ref:`StringName<class_StringName>` anim_from, :ref:`StringName<class_StringName>` anim_to **)** const
|
||||
|
||||
Gets the blend time (in seconds) between two animations, referenced by their names.
|
||||
|
||||
@@ -427,7 +429,7 @@ Gets the actual playing speed of current animation or 0 if not playing. This spe
|
||||
|
||||
.. _class_AnimationPlayer_method_get_queue:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **get_queue** **(** **)**
|
||||
- :ref:`PackedStringArray<class_PackedStringArray>` **get_queue** **(** **)**
|
||||
|
||||
Returns a list of the animation names that are currently queued to play.
|
||||
|
||||
@@ -435,7 +437,7 @@ Returns a list of the animation names that are currently queued to play.
|
||||
|
||||
.. _class_AnimationPlayer_method_has_animation:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_animation** **(** :ref:`String<class_String>` name **)** const
|
||||
- :ref:`bool<class_bool>` **has_animation** **(** :ref:`StringName<class_StringName>` name **)** const
|
||||
|
||||
Returns ``true`` if the ``AnimationPlayer`` stores an :ref:`Animation<class_Animation>` with key ``name``.
|
||||
|
||||
@@ -451,7 +453,7 @@ Returns ``true`` if playing an animation.
|
||||
|
||||
.. _class_AnimationPlayer_method_play:
|
||||
|
||||
- void **play** **(** :ref:`String<class_String>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1.0, :ref:`bool<class_bool>` from_end=false **)**
|
||||
- void **play** **(** :ref:`StringName<class_StringName>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1.0, :ref:`bool<class_bool>` from_end=false **)**
|
||||
|
||||
Plays the animation with key ``name``. Custom blend times and speed can be set. If ``custom_speed`` is negative and ``from_end`` is ``true``, the animation will play backwards (which is equivalent to calling :ref:`play_backwards<class_AnimationPlayer_method_play_backwards>`).
|
||||
|
||||
@@ -463,7 +465,7 @@ The ``AnimationPlayer`` keeps track of its current or last played animation with
|
||||
|
||||
.. _class_AnimationPlayer_method_play_backwards:
|
||||
|
||||
- void **play_backwards** **(** :ref:`String<class_String>` name="", :ref:`float<class_float>` custom_blend=-1 **)**
|
||||
- void **play_backwards** **(** :ref:`StringName<class_StringName>` name="", :ref:`float<class_float>` custom_blend=-1 **)**
|
||||
|
||||
Plays the animation with key ``name`` in reverse.
|
||||
|
||||
@@ -473,7 +475,7 @@ This method is a shorthand for :ref:`play<class_AnimationPlayer_method_play>` wi
|
||||
|
||||
.. _class_AnimationPlayer_method_queue:
|
||||
|
||||
- void **queue** **(** :ref:`String<class_String>` name **)**
|
||||
- void **queue** **(** :ref:`StringName<class_StringName>` name **)**
|
||||
|
||||
Queues an animation for playback once the current one is done.
|
||||
|
||||
@@ -483,7 +485,7 @@ Queues an animation for playback once the current one is done.
|
||||
|
||||
.. _class_AnimationPlayer_method_remove_animation:
|
||||
|
||||
- void **remove_animation** **(** :ref:`String<class_String>` name **)**
|
||||
- void **remove_animation** **(** :ref:`StringName<class_StringName>` name **)**
|
||||
|
||||
Removes the animation with key ``name``.
|
||||
|
||||
@@ -491,7 +493,7 @@ Removes the animation with key ``name``.
|
||||
|
||||
.. _class_AnimationPlayer_method_rename_animation:
|
||||
|
||||
- void **rename_animation** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` newname **)**
|
||||
- void **rename_animation** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` newname **)**
|
||||
|
||||
Renames an existing animation with key ``name`` to ``newname``.
|
||||
|
||||
@@ -507,7 +509,7 @@ Seeks the animation to the ``seconds`` point in time (in seconds). If ``update``
|
||||
|
||||
.. _class_AnimationPlayer_method_set_blend_time:
|
||||
|
||||
- void **set_blend_time** **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to, :ref:`float<class_float>` sec **)**
|
||||
- void **set_blend_time** **(** :ref:`StringName<class_StringName>` anim_from, :ref:`StringName<class_StringName>` anim_to, :ref:`float<class_float>` sec **)**
|
||||
|
||||
Specifies a blend time (in seconds) between two animations, referenced by their names.
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ AnimationTree
|
||||
|
||||
**Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
|
||||
A node to be used for advanced animation transitions in an :ref:`AnimationPlayer<class_AnimationPlayer>`.
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
@@ -59,11 +59,11 @@ Enumerations
|
||||
|
||||
enum **AnimationProcessMode**:
|
||||
|
||||
- **ANIMATION_PROCESS_PHYSICS** = **0**
|
||||
- **ANIMATION_PROCESS_PHYSICS** = **0** --- The animations will progress during the physics frame (i.e. :ref:`Node._physics_process<class_Node_method__physics_process>`).
|
||||
|
||||
- **ANIMATION_PROCESS_IDLE** = **1**
|
||||
- **ANIMATION_PROCESS_IDLE** = **1** --- The animations will progress during the idle frame (i.e. :ref:`Node._process<class_Node_method__process>`).
|
||||
|
||||
- **ANIMATION_PROCESS_MANUAL** = **2**
|
||||
- **ANIMATION_PROCESS_MANUAL** = **2** --- The animations will only progress manually (see :ref:`advance<class_AnimationTree_method_advance>`).
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -80,6 +80,8 @@ Property Descriptions
|
||||
| *Getter* | is_active() |
|
||||
+-----------+-------------------+
|
||||
|
||||
If ``true``, the ``AnimationTree`` will be processing.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTree_property_anim_player:
|
||||
@@ -94,6 +96,8 @@ Property Descriptions
|
||||
| *Getter* | get_animation_player() |
|
||||
+-----------+-----------------------------+
|
||||
|
||||
The path to the :ref:`AnimationPlayer<class_AnimationPlayer>` used for animating.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTree_property_process_mode:
|
||||
@@ -108,6 +112,8 @@ Property Descriptions
|
||||
| *Getter* | get_process_mode() |
|
||||
+-----------+-------------------------+
|
||||
|
||||
The process mode of this ``AnimationTree``. See :ref:`AnimationProcessMode<enum_AnimationTree_AnimationProcessMode>` for available modes.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTree_property_root_motion_track:
|
||||
@@ -134,6 +140,8 @@ Property Descriptions
|
||||
| *Getter* | get_tree_root() |
|
||||
+----------+----------------------+
|
||||
|
||||
The root animation node of this ``AnimationTree``. See :ref:`AnimationNode<class_AnimationNode>`.
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
@@ -141,6 +149,8 @@ Method Descriptions
|
||||
|
||||
- void **advance** **(** :ref:`float<class_float>` delta **)**
|
||||
|
||||
Manually advance the animations by the specified time (in seconds).
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTree_method_get_root_motion_transform:
|
||||
|
||||
@@ -1,766 +0,0 @@
|
||||
:github_url: hide
|
||||
|
||||
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||
.. DO NOT EDIT THIS FILE, but the AnimationTreePlayer.xml source instead.
|
||||
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||||
|
||||
.. _class_AnimationTreePlayer:
|
||||
|
||||
AnimationTreePlayer
|
||||
===================
|
||||
|
||||
**Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
Animation player that uses a node graph for blending animations.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
A node graph tool for blending multiple animations bound to an :ref:`AnimationPlayer<class_AnimationPlayer>`. Especially useful for animating characters or other skeleton-based rigs. It can combine several animations to form a desired pose.
|
||||
|
||||
It takes :ref:`Animation<class_Animation>`\ s from an :ref:`AnimationPlayer<class_AnimationPlayer>` node and mixes them depending on the graph.
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
|
||||
- :doc:`../tutorials/animation/animation_tree`
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`active<class_AnimationTreePlayer_property_active>` | ``false`` |
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`base_path<class_AnimationTreePlayer_property_base_path>` | ``NodePath("..")`` |
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`master_player<class_AnimationTreePlayer_property_master_player>` | ``NodePath("")`` |
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+
|
||||
| :ref:`AnimationProcessMode<enum_AnimationTreePlayer_AnimationProcessMode>` | :ref:`playback_process_mode<class_AnimationTreePlayer_property_playback_process_mode>` | ``1`` |
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_node<class_AnimationTreePlayer_method_add_node>` **(** :ref:`NodeType<enum_AnimationTreePlayer_NodeType>` type, :ref:`String<class_String>` id **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`advance<class_AnimationTreePlayer_method_advance>` **(** :ref:`float<class_float>` delta **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Animation<class_Animation>` | :ref:`animation_node_get_animation<class_AnimationTreePlayer_method_animation_node_get_animation>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation_node_get_master_animation<class_AnimationTreePlayer_method_animation_node_get_master_animation>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`animation_node_get_position<class_AnimationTreePlayer_method_animation_node_get_position>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_node_set_animation<class_AnimationTreePlayer_method_animation_node_set_animation>` **(** :ref:`String<class_String>` id, :ref:`Animation<class_Animation>` animation **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_node_set_filter_path<class_AnimationTreePlayer_method_animation_node_set_filter_path>` **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_node_set_master_animation<class_AnimationTreePlayer_method_animation_node_set_master_animation>` **(** :ref:`String<class_String>` id, :ref:`String<class_String>` source **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`are_nodes_connected<class_AnimationTreePlayer_method_are_nodes_connected>` **(** :ref:`String<class_String>` id, :ref:`String<class_String>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`blend2_node_get_amount<class_AnimationTreePlayer_method_blend2_node_get_amount>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend2_node_set_amount<class_AnimationTreePlayer_method_blend2_node_set_amount>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` blend **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend2_node_set_filter_path<class_AnimationTreePlayer_method_blend2_node_set_filter_path>` **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`blend3_node_get_amount<class_AnimationTreePlayer_method_blend3_node_get_amount>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend3_node_set_amount<class_AnimationTreePlayer_method_blend3_node_set_amount>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` blend **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`blend4_node_get_amount<class_AnimationTreePlayer_method_blend4_node_get_amount>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend4_node_set_amount<class_AnimationTreePlayer_method_blend4_node_set_amount>` **(** :ref:`String<class_String>` id, :ref:`Vector2<class_Vector2>` blend **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`connect_nodes<class_AnimationTreePlayer_method_connect_nodes>` **(** :ref:`String<class_String>` id, :ref:`String<class_String>` dst_id, :ref:`int<class_int>` dst_input_idx **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect_nodes<class_AnimationTreePlayer_method_disconnect_nodes>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` dst_input_idx **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_node_list<class_AnimationTreePlayer_method_get_node_list>` **(** **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`mix_node_get_amount<class_AnimationTreePlayer_method_mix_node_get_amount>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`mix_node_set_amount<class_AnimationTreePlayer_method_mix_node_set_amount>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` ratio **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`node_exists<class_AnimationTreePlayer_method_node_exists>` **(** :ref:`String<class_String>` node **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`node_get_input_count<class_AnimationTreePlayer_method_node_get_input_count>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`node_get_input_source<class_AnimationTreePlayer_method_node_get_input_source>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` idx **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`node_get_position<class_AnimationTreePlayer_method_node_get_position>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodeType<enum_AnimationTreePlayer_NodeType>` | :ref:`node_get_type<class_AnimationTreePlayer_method_node_get_type>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`node_rename<class_AnimationTreePlayer_method_node_rename>` **(** :ref:`String<class_String>` node, :ref:`String<class_String>` new_name **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`node_set_position<class_AnimationTreePlayer_method_node_set_position>` **(** :ref:`String<class_String>` id, :ref:`Vector2<class_Vector2>` screen_position **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_delay<class_AnimationTreePlayer_method_oneshot_node_get_autorestart_delay>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_random_delay<class_AnimationTreePlayer_method_oneshot_node_get_autorestart_random_delay>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadein_time<class_AnimationTreePlayer_method_oneshot_node_get_fadein_time>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadeout_time<class_AnimationTreePlayer_method_oneshot_node_get_fadeout_time>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`oneshot_node_has_autorestart<class_AnimationTreePlayer_method_oneshot_node_has_autorestart>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`oneshot_node_is_active<class_AnimationTreePlayer_method_oneshot_node_is_active>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_autorestart<class_AnimationTreePlayer_method_oneshot_node_set_autorestart>` **(** :ref:`String<class_String>` id, :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_autorestart_delay<class_AnimationTreePlayer_method_oneshot_node_set_autorestart_delay>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` delay_sec **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_autorestart_random_delay<class_AnimationTreePlayer_method_oneshot_node_set_autorestart_random_delay>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` rand_sec **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_fadein_time<class_AnimationTreePlayer_method_oneshot_node_set_fadein_time>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_fadeout_time<class_AnimationTreePlayer_method_oneshot_node_set_fadeout_time>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_filter_path<class_AnimationTreePlayer_method_oneshot_node_set_filter_path>` **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_start<class_AnimationTreePlayer_method_oneshot_node_start>` **(** :ref:`String<class_String>` id **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_stop<class_AnimationTreePlayer_method_oneshot_node_stop>` **(** :ref:`String<class_String>` id **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`recompute_caches<class_AnimationTreePlayer_method_recompute_caches>` **(** **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_node<class_AnimationTreePlayer_method_remove_node>` **(** :ref:`String<class_String>` id **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`reset<class_AnimationTreePlayer_method_reset>` **(** **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`timescale_node_get_scale<class_AnimationTreePlayer_method_timescale_node_get_scale>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`timescale_node_set_scale<class_AnimationTreePlayer_method_timescale_node_set_scale>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` scale **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`timeseek_node_seek<class_AnimationTreePlayer_method_timeseek_node_seek>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` seconds **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_delete_input<class_AnimationTreePlayer_method_transition_node_delete_input>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`transition_node_get_current<class_AnimationTreePlayer_method_transition_node_get_current>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`transition_node_get_input_count<class_AnimationTreePlayer_method_transition_node_get_input_count>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`transition_node_get_xfade_time<class_AnimationTreePlayer_method_transition_node_get_xfade_time>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`transition_node_has_input_auto_advance<class_AnimationTreePlayer_method_transition_node_has_input_auto_advance>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_current<class_AnimationTreePlayer_method_transition_node_set_current>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_input_auto_advance<class_AnimationTreePlayer_method_transition_node_set_input_auto_advance>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_input_count<class_AnimationTreePlayer_method_transition_node_set_input_count>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` count **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_xfade_time<class_AnimationTreePlayer_method_transition_node_set_xfade_time>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_AnimationTreePlayer_NodeType:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_OUTPUT:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_ANIMATION:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_ONESHOT:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_MIX:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_BLEND2:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_BLEND3:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_BLEND4:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_TIMESCALE:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_TIMESEEK:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_TRANSITION:
|
||||
|
||||
enum **NodeType**:
|
||||
|
||||
- **NODE_OUTPUT** = **0** --- Output node.
|
||||
|
||||
- **NODE_ANIMATION** = **1** --- Animation node.
|
||||
|
||||
- **NODE_ONESHOT** = **2** --- OneShot node.
|
||||
|
||||
- **NODE_MIX** = **3** --- Mix node.
|
||||
|
||||
- **NODE_BLEND2** = **4** --- Blend2 node.
|
||||
|
||||
- **NODE_BLEND3** = **5** --- Blend3 node.
|
||||
|
||||
- **NODE_BLEND4** = **6** --- Blend4 node.
|
||||
|
||||
- **NODE_TIMESCALE** = **7** --- TimeScale node.
|
||||
|
||||
- **NODE_TIMESEEK** = **8** --- TimeSeek node.
|
||||
|
||||
- **NODE_TRANSITION** = **9** --- Transition node.
|
||||
|
||||
----
|
||||
|
||||
.. _enum_AnimationTreePlayer_AnimationProcessMode:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_ANIMATION_PROCESS_PHYSICS:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_ANIMATION_PROCESS_IDLE:
|
||||
|
||||
enum **AnimationProcessMode**:
|
||||
|
||||
- **ANIMATION_PROCESS_PHYSICS** = **0** --- Process animation during the physics process. This is especially useful when animating physics bodies.
|
||||
|
||||
- **ANIMATION_PROCESS_IDLE** = **1** --- Process animation during the idle process.
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimationTreePlayer_property_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **active**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_active(value) |
|
||||
+-----------+-------------------+
|
||||
| *Getter* | is_active() |
|
||||
+-----------+-------------------+
|
||||
|
||||
If ``true``, the ``AnimationTreePlayer`` is able to play animations.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_property_base_path:
|
||||
|
||||
- :ref:`NodePath<class_NodePath>` **base_path**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | ``NodePath("..")`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_base_path(value) |
|
||||
+-----------+----------------------+
|
||||
| *Getter* | get_base_path() |
|
||||
+-----------+----------------------+
|
||||
|
||||
The node from which to relatively access other nodes.
|
||||
|
||||
It accesses the bones, so it should point to the same node the :ref:`AnimationPlayer<class_AnimationPlayer>` would point its Root Node at.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_property_master_player:
|
||||
|
||||
- :ref:`NodePath<class_NodePath>` **master_player**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | ``NodePath("")`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_master_player(value) |
|
||||
+-----------+--------------------------+
|
||||
| *Getter* | get_master_player() |
|
||||
+-----------+--------------------------+
|
||||
|
||||
The path to the :ref:`AnimationPlayer<class_AnimationPlayer>` from which this ``AnimationTreePlayer`` binds animations to animation nodes.
|
||||
|
||||
Once set, :ref:`Animation<class_Animation>` nodes can be added to the ``AnimationTreePlayer``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_property_playback_process_mode:
|
||||
|
||||
- :ref:`AnimationProcessMode<enum_AnimationTreePlayer_AnimationProcessMode>` **playback_process_mode**
|
||||
|
||||
+-----------+-----------------------------------+
|
||||
| *Default* | ``1`` |
|
||||
+-----------+-----------------------------------+
|
||||
| *Setter* | set_animation_process_mode(value) |
|
||||
+-----------+-----------------------------------+
|
||||
| *Getter* | get_animation_process_mode() |
|
||||
+-----------+-----------------------------------+
|
||||
|
||||
The thread in which to update animations.
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AnimationTreePlayer_method_add_node:
|
||||
|
||||
- void **add_node** **(** :ref:`NodeType<enum_AnimationTreePlayer_NodeType>` type, :ref:`String<class_String>` id **)**
|
||||
|
||||
Adds a ``type`` node to the graph with name ``id``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_advance:
|
||||
|
||||
- void **advance** **(** :ref:`float<class_float>` delta **)**
|
||||
|
||||
Shifts position in the animation timeline. ``delta`` is the time in seconds to shift. Events between the current frame and ``delta`` are handled.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_animation_node_get_animation:
|
||||
|
||||
- :ref:`Animation<class_Animation>` **animation_node_get_animation** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the :ref:`AnimationPlayer<class_AnimationPlayer>`'s :ref:`Animation<class_Animation>` bound to the ``AnimationTreePlayer``'s animation node with name ``id``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_animation_node_get_master_animation:
|
||||
|
||||
- :ref:`String<class_String>` **animation_node_get_master_animation** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the name of the :ref:`master_player<class_AnimationTreePlayer_property_master_player>`'s :ref:`Animation<class_Animation>` bound to this animation node.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_animation_node_get_position:
|
||||
|
||||
- :ref:`float<class_float>` **animation_node_get_position** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the absolute playback timestamp of the animation node with name ``id``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_animation_node_set_animation:
|
||||
|
||||
- void **animation_node_set_animation** **(** :ref:`String<class_String>` id, :ref:`Animation<class_Animation>` animation **)**
|
||||
|
||||
Binds a new :ref:`Animation<class_Animation>` from the :ref:`master_player<class_AnimationTreePlayer_property_master_player>` to the ``AnimationTreePlayer``'s animation node with name ``id``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_animation_node_set_filter_path:
|
||||
|
||||
- void **animation_node_set_filter_path** **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
If ``enable`` is ``true``, the animation node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_animation_node_set_master_animation:
|
||||
|
||||
- void **animation_node_set_master_animation** **(** :ref:`String<class_String>` id, :ref:`String<class_String>` source **)**
|
||||
|
||||
Binds the :ref:`Animation<class_Animation>` named ``source`` from :ref:`master_player<class_AnimationTreePlayer_property_master_player>` to the animation node ``id``. Recalculates caches.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_are_nodes_connected:
|
||||
|
||||
- :ref:`bool<class_bool>` **are_nodes_connected** **(** :ref:`String<class_String>` id, :ref:`String<class_String>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const
|
||||
|
||||
Returns whether node ``id`` and ``dst_id`` are connected at the specified slot.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_blend2_node_get_amount:
|
||||
|
||||
- :ref:`float<class_float>` **blend2_node_get_amount** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the blend amount of a Blend2 node given its name.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_blend2_node_set_amount:
|
||||
|
||||
- void **blend2_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` blend **)**
|
||||
|
||||
Sets the blend amount of a Blend2 node given its name and value.
|
||||
|
||||
A Blend2 node blends two animations (A and B) with the amount between 0 and 1.
|
||||
|
||||
At 0, output is input A. Towards 1, the influence of A gets lessened, the influence of B gets raised. At 1, output is input B.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_blend2_node_set_filter_path:
|
||||
|
||||
- void **blend2_node_set_filter_path** **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
If ``enable`` is ``true``, the Blend2 node with name ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_blend3_node_get_amount:
|
||||
|
||||
- :ref:`float<class_float>` **blend3_node_get_amount** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the blend amount of a Blend3 node given its name.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_blend3_node_set_amount:
|
||||
|
||||
- void **blend3_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` blend **)**
|
||||
|
||||
Sets the blend amount of a Blend3 node given its name and value.
|
||||
|
||||
A Blend3 Node blends three animations (A, B-, B+) with the amount between -1 and 1.
|
||||
|
||||
At -1, output is input B-. From -1 to 0, the influence of B- gets lessened, the influence of A gets raised and the influence of B+ is 0. At 0, output is input A. From 0 to 1, the influence of A gets lessened, the influence of B+ gets raised and the influence of B+ is 0. At 1, output is input B+.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_blend4_node_get_amount:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **blend4_node_get_amount** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the blend amount of a Blend4 node given its name.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_blend4_node_set_amount:
|
||||
|
||||
- void **blend4_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`Vector2<class_Vector2>` blend **)**
|
||||
|
||||
Sets the blend amount of a Blend4 node given its name and value.
|
||||
|
||||
A Blend4 Node blends two pairs of animations.
|
||||
|
||||
The two pairs are blended like Blend2 and then added together.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_connect_nodes:
|
||||
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **connect_nodes** **(** :ref:`String<class_String>` id, :ref:`String<class_String>` dst_id, :ref:`int<class_int>` dst_input_idx **)**
|
||||
|
||||
Connects node ``id`` to ``dst_id`` at the specified input slot.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_disconnect_nodes:
|
||||
|
||||
- void **disconnect_nodes** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` dst_input_idx **)**
|
||||
|
||||
Disconnects nodes connected to ``id`` at the specified input slot.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_get_node_list:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **get_node_list** **(** **)**
|
||||
|
||||
Returns a :ref:`PoolStringArray<class_PoolStringArray>` containing the name of all nodes.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_mix_node_get_amount:
|
||||
|
||||
- :ref:`float<class_float>` **mix_node_get_amount** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the mix amount of a Mix node given its name.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_mix_node_set_amount:
|
||||
|
||||
- void **mix_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` ratio **)**
|
||||
|
||||
Sets the mix amount of a Mix node given its name and value.
|
||||
|
||||
A Mix node adds input b to input a by the amount given by ratio.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_node_exists:
|
||||
|
||||
- :ref:`bool<class_bool>` **node_exists** **(** :ref:`String<class_String>` node **)** const
|
||||
|
||||
Check if a node exists (by name).
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_node_get_input_count:
|
||||
|
||||
- :ref:`int<class_int>` **node_get_input_count** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the input count for a given node. Different types of nodes have different amount of inputs.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_node_get_input_source:
|
||||
|
||||
- :ref:`String<class_String>` **node_get_input_source** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Returns the input source for a given node input.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_node_get_position:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **node_get_position** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns position of a node in the graph given its name.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_node_get_type:
|
||||
|
||||
- :ref:`NodeType<enum_AnimationTreePlayer_NodeType>` **node_get_type** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Gets the node type, will return from :ref:`NodeType<enum_AnimationTreePlayer_NodeType>` enum.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_node_rename:
|
||||
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **node_rename** **(** :ref:`String<class_String>` node, :ref:`String<class_String>` new_name **)**
|
||||
|
||||
Renames a node in the graph.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_node_set_position:
|
||||
|
||||
- void **node_set_position** **(** :ref:`String<class_String>` id, :ref:`Vector2<class_Vector2>` screen_position **)**
|
||||
|
||||
Sets the position of a node in the graph given its name and position.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_get_autorestart_delay:
|
||||
|
||||
- :ref:`float<class_float>` **oneshot_node_get_autorestart_delay** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the autostart delay of a OneShot node given its name.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_get_autorestart_random_delay:
|
||||
|
||||
- :ref:`float<class_float>` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the autostart random delay of a OneShot node given its name.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_get_fadein_time:
|
||||
|
||||
- :ref:`float<class_float>` **oneshot_node_get_fadein_time** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the fade in time of a OneShot node given its name.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_get_fadeout_time:
|
||||
|
||||
- :ref:`float<class_float>` **oneshot_node_get_fadeout_time** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the fade out time of a OneShot node given its name.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_has_autorestart:
|
||||
|
||||
- :ref:`bool<class_bool>` **oneshot_node_has_autorestart** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns whether a OneShot node will auto restart given its name.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_is_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **oneshot_node_is_active** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns whether a OneShot node is active given its name.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart:
|
||||
|
||||
- void **oneshot_node_set_autorestart** **(** :ref:`String<class_String>` id, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
Sets the autorestart property of a OneShot node given its name and value.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart_delay:
|
||||
|
||||
- void **oneshot_node_set_autorestart_delay** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` delay_sec **)**
|
||||
|
||||
Sets the autorestart delay of a OneShot node given its name and value in seconds.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart_random_delay:
|
||||
|
||||
- void **oneshot_node_set_autorestart_random_delay** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` rand_sec **)**
|
||||
|
||||
Sets the autorestart random delay of a OneShot node given its name and value in seconds.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_set_fadein_time:
|
||||
|
||||
- void **oneshot_node_set_fadein_time** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)**
|
||||
|
||||
Sets the fade in time of a OneShot node given its name and value in seconds.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_set_fadeout_time:
|
||||
|
||||
- void **oneshot_node_set_fadeout_time** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)**
|
||||
|
||||
Sets the fade out time of a OneShot node given its name and value in seconds.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_set_filter_path:
|
||||
|
||||
- void **oneshot_node_set_filter_path** **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
If ``enable`` is ``true``, the OneShot node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_start:
|
||||
|
||||
- void **oneshot_node_start** **(** :ref:`String<class_String>` id **)**
|
||||
|
||||
Starts a OneShot node given its name.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_stop:
|
||||
|
||||
- void **oneshot_node_stop** **(** :ref:`String<class_String>` id **)**
|
||||
|
||||
Stops the OneShot node with name ``id``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_recompute_caches:
|
||||
|
||||
- void **recompute_caches** **(** **)**
|
||||
|
||||
Manually recalculates the cache of track information generated from animation nodes. Needed when external sources modify the animation nodes' state.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_remove_node:
|
||||
|
||||
- void **remove_node** **(** :ref:`String<class_String>` id **)**
|
||||
|
||||
Removes the animation node with name ``id``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_reset:
|
||||
|
||||
- void **reset** **(** **)**
|
||||
|
||||
Resets this ``AnimationTreePlayer``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_timescale_node_get_scale:
|
||||
|
||||
- :ref:`float<class_float>` **timescale_node_get_scale** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the time scale value of the TimeScale node with name ``id``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_timescale_node_set_scale:
|
||||
|
||||
- void **timescale_node_set_scale** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` scale **)**
|
||||
|
||||
Sets the time scale of the TimeScale node with name ``id`` to ``scale``.
|
||||
|
||||
The TimeScale node is used to speed :ref:`Animation<class_Animation>`\ s up if the scale is above 1 or slow them down if it is below 1.
|
||||
|
||||
If applied after a blend or mix, affects all input animations to that blend or mix.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_timeseek_node_seek:
|
||||
|
||||
- void **timeseek_node_seek** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` seconds **)**
|
||||
|
||||
Sets the time seek value of the TimeSeek node with name ``id`` to ``seconds``.
|
||||
|
||||
This functions as a seek in the :ref:`Animation<class_Animation>` or the blend or mix of :ref:`Animation<class_Animation>`\ s input in it.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_transition_node_delete_input:
|
||||
|
||||
- void **transition_node_delete_input** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)**
|
||||
|
||||
Deletes the input at ``input_idx`` for the transition node with name ``id``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_transition_node_get_current:
|
||||
|
||||
- :ref:`int<class_int>` **transition_node_get_current** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the index of the currently evaluated input for the transition node with name ``id``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_transition_node_get_input_count:
|
||||
|
||||
- :ref:`int<class_int>` **transition_node_get_input_count** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the number of inputs for the transition node with name ``id``. You can add inputs by right-clicking on the transition node.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_transition_node_get_xfade_time:
|
||||
|
||||
- :ref:`float<class_float>` **transition_node_get_xfade_time** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the cross fade time for the transition node with name ``id``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_transition_node_has_input_auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **transition_node_has_input_auto_advance** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)** const
|
||||
|
||||
Returns ``true`` if the input at ``input_idx`` on the transition node with name ``id`` is set to automatically advance to the next input upon completion.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_transition_node_set_current:
|
||||
|
||||
- void **transition_node_set_current** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)**
|
||||
|
||||
The transition node with name ``id`` sets its current input at ``input_idx``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_transition_node_set_input_auto_advance:
|
||||
|
||||
- void **transition_node_set_input_auto_advance** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
The transition node with name ``id`` advances to its next input automatically when the input at ``input_idx`` completes.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_transition_node_set_input_count:
|
||||
|
||||
- void **transition_node_set_input_count** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` count **)**
|
||||
|
||||
Resizes the number of inputs available for the transition node with name ``id``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AnimationTreePlayer_method_transition_node_set_xfade_time:
|
||||
|
||||
- void **transition_node_set_xfade_time** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)**
|
||||
|
||||
The transition node with name ``id`` sets its cross fade time to ``time_sec``.
|
||||
|
||||
@@ -24,7 +24,7 @@ Properties
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angular_damp<class_Area_property_angular_damp>` | ``0.1`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`audio_bus_name<class_Area_property_audio_bus_name>` | ``"Master"`` |
|
||||
| :ref:`StringName<class_StringName>` | :ref:`audio_bus_name<class_Area_property_audio_bus_name>` | ``@"Master"`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`audio_bus_override<class_Area_property_audio_bus_override>` | ``false`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
@@ -52,7 +52,7 @@ Properties
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`reverb_bus_enable<class_Area_property_reverb_bus_enable>` | ``false`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`reverb_bus_name<class_Area_property_reverb_bus_name>` | ``"Master"`` |
|
||||
| :ref:`StringName<class_StringName>` | :ref:`reverb_bus_name<class_Area_property_reverb_bus_name>` | ``@"Master"`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`reverb_bus_uniformity<class_Area_property_reverb_bus_uniformity>` | ``0.0`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
@@ -201,10 +201,10 @@ The rate at which objects stop spinning in this area. Represents the angular vel
|
||||
|
||||
.. _class_Area_property_audio_bus_name:
|
||||
|
||||
- :ref:`String<class_String>` **audio_bus_name**
|
||||
- :ref:`StringName<class_StringName>` **audio_bus_name**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | ``"Master"`` |
|
||||
| *Default* | ``@"Master"`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_audio_bus(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -425,10 +425,10 @@ If ``true``, the area applies reverb to its associated audio.
|
||||
|
||||
.. _class_Area_property_reverb_bus_name:
|
||||
|
||||
- :ref:`String<class_String>` **reverb_bus_name**
|
||||
- :ref:`StringName<class_StringName>` **reverb_bus_name**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | ``"Master"`` |
|
||||
| *Default* | ``@"Master"`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_reverb_bus(value) |
|
||||
+-----------+-----------------------+
|
||||
|
||||
@@ -29,7 +29,7 @@ Properties
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angular_damp<class_Area2D_property_angular_damp>` | ``1.0`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`String<class_String>` | :ref:`audio_bus_name<class_Area2D_property_audio_bus_name>` | ``"Master"`` |
|
||||
| :ref:`StringName<class_StringName>` | :ref:`audio_bus_name<class_Area2D_property_audio_bus_name>` | ``@"Master"`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`audio_bus_override<class_Area2D_property_audio_bus_override>` | ``false`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
|
||||
@@ -198,10 +198,10 @@ The rate at which objects stop spinning in this area. Represents the angular vel
|
||||
|
||||
.. _class_Area2D_property_audio_bus_name:
|
||||
|
||||
- :ref:`String<class_String>` **audio_bus_name**
|
||||
- :ref:`StringName<class_StringName>` **audio_bus_name**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | ``"Master"`` |
|
||||
| *Default* | ``@"Master"`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_audio_bus_name(value) |
|
||||
+-----------+---------------------------+
|
||||
|
||||
@@ -27,131 +27,155 @@ Generic array which can contain several elements of any type, accessible by a nu
|
||||
array[2] = "Three"
|
||||
print(array[-2]) # Three.
|
||||
|
||||
Arrays can be concatenated using the ``+`` operator:
|
||||
|
||||
::
|
||||
|
||||
var array1 = ["One", 2]
|
||||
var array2 = [3, "Four"]
|
||||
print(array1 + array2) # ["One", 2, 3, "Four"]
|
||||
|
||||
Arrays are always passed by reference.
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PoolColorArray<class_PoolColorArray>` from **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PoolVector3Array<class_PoolVector3Array>` from **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` from **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PoolStringArray<class_PoolStringArray>` from **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PoolRealArray<class_PoolRealArray>` from **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PoolIntArray<class_PoolIntArray>` from **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PoolByteArray<class_PoolByteArray>` from **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`append<class_Array_method_append>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`back<class_Array_method_back>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`bsearch<class_Array_method_bsearch>` **(** :ref:`Variant<class_Variant>` value, :ref:`bool<class_bool>` before=True **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`bsearch_custom<class_Array_method_bsearch_custom>` **(** :ref:`Variant<class_Variant>` value, :ref:`Object<class_Object>` obj, :ref:`String<class_String>` func, :ref:`bool<class_bool>` before=True **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_Array_method_clear>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`count<class_Array_method_count>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`duplicate<class_Array_method_duplicate>` **(** :ref:`bool<class_bool>` deep=False **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`empty<class_Array_method_empty>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase<class_Array_method_erase>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find<class_Array_method_find>` **(** :ref:`Variant<class_Variant>` what, :ref:`int<class_int>` from=0 **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find_last<class_Array_method_find_last>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`front<class_Array_method_front>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has<class_Array_method_has>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`hash<class_Array_method_hash>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`insert<class_Array_method_insert>` **(** :ref:`int<class_int>` position, :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`invert<class_Array_method_invert>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`max<class_Array_method_max>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`min<class_Array_method_min>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`pop_back<class_Array_method_pop_back>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`pop_front<class_Array_method_pop_front>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`push_back<class_Array_method_push_back>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`push_front<class_Array_method_push_front>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove<class_Array_method_remove>` **(** :ref:`int<class_int>` position **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`resize<class_Array_method_resize>` **(** :ref:`int<class_int>` size **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`rfind<class_Array_method_rfind>` **(** :ref:`Variant<class_Variant>` what, :ref:`int<class_int>` from=-1 **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shuffle<class_Array_method_shuffle>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`size<class_Array_method_size>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`slice<class_Array_method_slice>` **(** :ref:`int<class_int>` begin, :ref:`int<class_int>` end, :ref:`int<class_int>` step=1, :ref:`bool<class_bool>` deep=False **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`sort<class_Array_method_sort>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`sort_custom<class_Array_method_sort_custom>` **(** :ref:`Object<class_Object>` obj, :ref:`String<class_String>` func **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PackedColorArray<class_PackedColorArray>` from **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PackedVector3Array<class_PackedVector3Array>` from **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PackedVector2Array<class_PackedVector2Array>` from **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PackedStringArray<class_PackedStringArray>` from **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` from **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PackedFloat32Array<class_PackedFloat32Array>` from **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PackedInt64Array<class_PackedInt64Array>` from **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PackedInt32Array<class_PackedInt32Array>` from **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PackedByteArray<class_PackedByteArray>` from **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`append<class_Array_method_append>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`back<class_Array_method_back>` **(** **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`bsearch<class_Array_method_bsearch>` **(** :ref:`Variant<class_Variant>` value, :ref:`bool<class_bool>` before=true **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`bsearch_custom<class_Array_method_bsearch_custom>` **(** :ref:`Variant<class_Variant>` value, :ref:`Object<class_Object>` obj, :ref:`String<class_String>` func, :ref:`bool<class_bool>` before=true **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_Array_method_clear>` **(** **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`count<class_Array_method_count>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`duplicate<class_Array_method_duplicate>` **(** :ref:`bool<class_bool>` deep=false **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`empty<class_Array_method_empty>` **(** **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase<class_Array_method_erase>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find<class_Array_method_find>` **(** :ref:`Variant<class_Variant>` what, :ref:`int<class_int>` from=0 **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find_last<class_Array_method_find_last>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`front<class_Array_method_front>` **(** **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has<class_Array_method_has>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`hash<class_Array_method_hash>` **(** **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`insert<class_Array_method_insert>` **(** :ref:`int<class_int>` position, :ref:`Variant<class_Variant>` value **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`invert<class_Array_method_invert>` **(** **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`max<class_Array_method_max>` **(** **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`min<class_Array_method_min>` **(** **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`pop_back<class_Array_method_pop_back>` **(** **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`pop_front<class_Array_method_pop_front>` **(** **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`push_back<class_Array_method_push_back>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`push_front<class_Array_method_push_front>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove<class_Array_method_remove>` **(** :ref:`int<class_int>` position **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`resize<class_Array_method_resize>` **(** :ref:`int<class_int>` size **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`rfind<class_Array_method_rfind>` **(** :ref:`Variant<class_Variant>` what, :ref:`int<class_int>` from=-1 **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shuffle<class_Array_method_shuffle>` **(** **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`size<class_Array_method_size>` **(** **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`slice<class_Array_method_slice>` **(** :ref:`int<class_int>` begin, :ref:`int<class_int>` end, :ref:`int<class_int>` step=1, :ref:`bool<class_bool>` deep=false **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`sort<class_Array_method_sort>` **(** **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`sort_custom<class_Array_method_sort_custom>` **(** :ref:`Object<class_Object>` obj, :ref:`String<class_String>` func **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_Array_method_Array:
|
||||
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolColorArray<class_PoolColorArray>` from **)**
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PackedColorArray<class_PackedColorArray>` from **)**
|
||||
|
||||
Constructs an array from a :ref:`PoolColorArray<class_PoolColorArray>`.
|
||||
Constructs an array from a :ref:`PackedColorArray<class_PackedColorArray>`.
|
||||
|
||||
----
|
||||
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolVector3Array<class_PoolVector3Array>` from **)**
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PackedVector3Array<class_PackedVector3Array>` from **)**
|
||||
|
||||
Constructs an array from a :ref:`PoolVector3Array<class_PoolVector3Array>`.
|
||||
Constructs an array from a :ref:`PackedVector3Array<class_PackedVector3Array>`.
|
||||
|
||||
----
|
||||
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` from **)**
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PackedVector2Array<class_PackedVector2Array>` from **)**
|
||||
|
||||
Constructs an array from a :ref:`PoolVector2Array<class_PoolVector2Array>`.
|
||||
Constructs an array from a :ref:`PackedVector2Array<class_PackedVector2Array>`.
|
||||
|
||||
----
|
||||
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolStringArray<class_PoolStringArray>` from **)**
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PackedStringArray<class_PackedStringArray>` from **)**
|
||||
|
||||
Constructs an array from a :ref:`PoolStringArray<class_PoolStringArray>`.
|
||||
Constructs an array from a :ref:`PackedStringArray<class_PackedStringArray>`.
|
||||
|
||||
----
|
||||
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolRealArray<class_PoolRealArray>` from **)**
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` from **)**
|
||||
|
||||
Constructs an array from a :ref:`PoolRealArray<class_PoolRealArray>`.
|
||||
Constructs an array from a :ref:`PackedFloat64Array<class_PackedFloat64Array>`.
|
||||
|
||||
----
|
||||
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolIntArray<class_PoolIntArray>` from **)**
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PackedFloat32Array<class_PackedFloat32Array>` from **)**
|
||||
|
||||
Constructs an array from a :ref:`PoolIntArray<class_PoolIntArray>`.
|
||||
Constructs an array from a :ref:`PackedFloat32Array<class_PackedFloat32Array>`.
|
||||
|
||||
----
|
||||
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolByteArray<class_PoolByteArray>` from **)**
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PackedInt64Array<class_PackedInt64Array>` from **)**
|
||||
|
||||
Constructs an array from a :ref:`PoolByteArray<class_PoolByteArray>`.
|
||||
Constructs an array from a :ref:`PackedInt64Array<class_PackedInt64Array>`.
|
||||
|
||||
----
|
||||
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` from **)**
|
||||
|
||||
Constructs an array from a :ref:`PackedInt32Array<class_PackedInt32Array>`.
|
||||
|
||||
----
|
||||
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PackedByteArray<class_PackedByteArray>` from **)**
|
||||
|
||||
Constructs an array from a :ref:`PackedByteArray<class_PackedByteArray>`.
|
||||
|
||||
----
|
||||
|
||||
@@ -165,7 +189,7 @@ Appends an element at the end of the array (alias of :ref:`push_back<class_Array
|
||||
|
||||
.. _class_Array_method_back:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **back** **(** **)**
|
||||
- void **back** **(** **)**
|
||||
|
||||
Returns the last element of the array, or ``null`` if the array is empty.
|
||||
|
||||
@@ -173,7 +197,7 @@ Returns the last element of the array, or ``null`` if the array is empty.
|
||||
|
||||
.. _class_Array_method_bsearch:
|
||||
|
||||
- :ref:`int<class_int>` **bsearch** **(** :ref:`Variant<class_Variant>` value, :ref:`bool<class_bool>` before=True **)**
|
||||
- :ref:`int<class_int>` **bsearch** **(** :ref:`Variant<class_Variant>` value, :ref:`bool<class_bool>` before=true **)**
|
||||
|
||||
Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array.
|
||||
|
||||
@@ -183,7 +207,7 @@ Finds the index of an existing value (or the insertion index that maintains sort
|
||||
|
||||
.. _class_Array_method_bsearch_custom:
|
||||
|
||||
- :ref:`int<class_int>` **bsearch_custom** **(** :ref:`Variant<class_Variant>` value, :ref:`Object<class_Object>` obj, :ref:`String<class_String>` func, :ref:`bool<class_bool>` before=True **)**
|
||||
- :ref:`int<class_int>` **bsearch_custom** **(** :ref:`Variant<class_Variant>` value, :ref:`Object<class_Object>` obj, :ref:`String<class_String>` func, :ref:`bool<class_bool>` before=true **)**
|
||||
|
||||
Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return ``true`` if the first argument is less than the second, and return ``false`` otherwise.
|
||||
|
||||
@@ -209,7 +233,7 @@ Returns the number of times an element is in the array.
|
||||
|
||||
.. _class_Array_method_duplicate:
|
||||
|
||||
- :ref:`Array<class_Array>` **duplicate** **(** :ref:`bool<class_bool>` deep=False **)**
|
||||
- :ref:`Array<class_Array>` **duplicate** **(** :ref:`bool<class_bool>` deep=false **)**
|
||||
|
||||
Returns a copy of the array.
|
||||
|
||||
@@ -251,7 +275,7 @@ Searches the array in reverse order for a value and returns its index or -1 if n
|
||||
|
||||
.. _class_Array_method_front:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **front** **(** **)**
|
||||
- void **front** **(** **)**
|
||||
|
||||
Returns the first element of the array, or ``null`` if the array is empty.
|
||||
|
||||
@@ -298,7 +322,7 @@ Reverses the order of the elements in the array.
|
||||
|
||||
.. _class_Array_method_max:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **max** **(** **)**
|
||||
- void **max** **(** **)**
|
||||
|
||||
Returns the maximum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned.
|
||||
|
||||
@@ -306,7 +330,7 @@ Returns the maximum value contained in the array if all elements are of comparab
|
||||
|
||||
.. _class_Array_method_min:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **min** **(** **)**
|
||||
- void **min** **(** **)**
|
||||
|
||||
Returns the minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned.
|
||||
|
||||
@@ -314,7 +338,7 @@ Returns the minimum value contained in the array if all elements are of comparab
|
||||
|
||||
.. _class_Array_method_pop_back:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **pop_back** **(** **)**
|
||||
- void **pop_back** **(** **)**
|
||||
|
||||
Removes and returns the last element of the array. Returns ``null`` if the array is empty.
|
||||
|
||||
@@ -322,7 +346,7 @@ Removes and returns the last element of the array. Returns ``null`` if the array
|
||||
|
||||
.. _class_Array_method_pop_front:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **pop_front** **(** **)**
|
||||
- void **pop_front** **(** **)**
|
||||
|
||||
Removes and returns the first element of the array. Returns ``null`` if the array is empty.
|
||||
|
||||
@@ -386,7 +410,7 @@ Returns the number of elements in the array.
|
||||
|
||||
.. _class_Array_method_slice:
|
||||
|
||||
- :ref:`Array<class_Array>` **slice** **(** :ref:`int<class_int>` begin, :ref:`int<class_int>` end, :ref:`int<class_int>` step=1, :ref:`bool<class_bool>` deep=False **)**
|
||||
- :ref:`Array<class_Array>` **slice** **(** :ref:`int<class_int>` begin, :ref:`int<class_int>` end, :ref:`int<class_int>` step=1, :ref:`bool<class_bool>` deep=false **)**
|
||||
|
||||
Duplicates the subset described in the function and returns it in an array, deeply copying the array if ``deep`` is ``true``. Lower and upper index are inclusive, with the ``step`` describing the change between indices while slicing.
|
||||
|
||||
@@ -398,7 +422,13 @@ Duplicates the subset described in the function and returns it in an array, deep
|
||||
|
||||
Sorts the array.
|
||||
|
||||
**Note:** strings are sorted in alphabetical, not natural order.
|
||||
**Note:** Strings are sorted in alphabetical order (as opposed to natural order). This may lead to unexpected behavior when sorting an array of strings ending with a sequence of numbers. Consider the following example:
|
||||
|
||||
::
|
||||
|
||||
var strings = ["string1", "string2", "string10", "string11"]
|
||||
strings.sort()
|
||||
print(strings) # Prints [string1, string10, string11, string2]
|
||||
|
||||
----
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ The most basic example is the creation of a single triangle:
|
||||
|
||||
::
|
||||
|
||||
var vertices = PoolVector3Array()
|
||||
var vertices = PackedVector3Array()
|
||||
vertices.push_back(Vector3(0, 1, 0))
|
||||
vertices.push_back(Vector3(1, 0, 0))
|
||||
vertices.push_back(Vector3(0, 0, 1))
|
||||
@@ -55,39 +55,39 @@ Properties
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_blend_shape<class_ArrayMesh_method_add_blend_shape>` **(** :ref:`String<class_String>` name **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>` **(** :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[ ], :ref:`int<class_int>` compress_flags=97280 **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_blend_shapes<class_ArrayMesh_method_clear_blend_shapes>` **(** **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_blend_shape_count<class_ArrayMesh_method_get_blend_shape_count>` **(** **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_blend_shape_name<class_ArrayMesh_method_get_blend_shape_name>` **(** :ref:`int<class_int>` index **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`lightmap_unwrap<class_ArrayMesh_method_lightmap_unwrap>` **(** :ref:`Transform<class_Transform>` transform, :ref:`float<class_float>` texel_size **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`regen_normalmaps<class_ArrayMesh_method_regen_normalmaps>` **(** **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_find_by_name<class_ArrayMesh_method_surface_find_by_name>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_array_index_len<class_ArrayMesh_method_surface_get_array_index_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_array_len<class_ArrayMesh_method_surface_get_array_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_format<class_ArrayMesh_method_surface_get_format>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`surface_get_name<class_ArrayMesh_method_surface_get_name>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` | :ref:`surface_get_primitive_type<class_ArrayMesh_method_surface_get_primitive_type>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`surface_remove<class_ArrayMesh_method_surface_remove>` **(** :ref:`int<class_int>` surf_idx **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`surface_set_name<class_ArrayMesh_method_surface_set_name>` **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_String>` name **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`surface_update_region<class_ArrayMesh_method_surface_update_region>` **(** :ref:`int<class_int>` surf_idx, :ref:`int<class_int>` offset, :ref:`PoolByteArray<class_PoolByteArray>` data **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_blend_shape<class_ArrayMesh_method_add_blend_shape>` **(** :ref:`StringName<class_StringName>` name **)** |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>` **(** :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[ ], :ref:`Dictionary<class_Dictionary>` lods={ }, :ref:`int<class_int>` compress_flags=31744 **)** |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_blend_shapes<class_ArrayMesh_method_clear_blend_shapes>` **(** **)** |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_surfaces<class_ArrayMesh_method_clear_surfaces>` **(** **)** |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_blend_shape_count<class_ArrayMesh_method_get_blend_shape_count>` **(** **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`StringName<class_StringName>` | :ref:`get_blend_shape_name<class_ArrayMesh_method_get_blend_shape_name>` **(** :ref:`int<class_int>` index **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`lightmap_unwrap<class_ArrayMesh_method_lightmap_unwrap>` **(** :ref:`Transform<class_Transform>` transform, :ref:`float<class_float>` texel_size **)** |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`regen_normalmaps<class_ArrayMesh_method_regen_normalmaps>` **(** **)** |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_find_by_name<class_ArrayMesh_method_surface_find_by_name>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_array_index_len<class_ArrayMesh_method_surface_get_array_index_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_array_len<class_ArrayMesh_method_surface_get_array_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_format<class_ArrayMesh_method_surface_get_format>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`surface_get_name<class_ArrayMesh_method_surface_get_name>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` | :ref:`surface_get_primitive_type<class_ArrayMesh_method_surface_get_primitive_type>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`surface_set_name<class_ArrayMesh_method_surface_set_name>` **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_String>` name **)** |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`surface_update_region<class_ArrayMesh_method_surface_update_region>` **(** :ref:`int<class_int>` surf_idx, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)** |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
@@ -116,23 +116,23 @@ Enumerations
|
||||
|
||||
enum **ArrayType**:
|
||||
|
||||
- **ARRAY_VERTEX** = **0** --- :ref:`PoolVector3Array<class_PoolVector3Array>`, :ref:`PoolVector2Array<class_PoolVector2Array>`, or :ref:`Array<class_Array>` of vertex positions.
|
||||
- **ARRAY_VERTEX** = **0** --- :ref:`PackedVector3Array<class_PackedVector3Array>`, :ref:`PackedVector2Array<class_PackedVector2Array>`, or :ref:`Array<class_Array>` of vertex positions.
|
||||
|
||||
- **ARRAY_NORMAL** = **1** --- :ref:`PoolVector3Array<class_PoolVector3Array>` of vertex normals.
|
||||
- **ARRAY_NORMAL** = **1** --- :ref:`PackedVector3Array<class_PackedVector3Array>` of vertex normals.
|
||||
|
||||
- **ARRAY_TANGENT** = **2** --- :ref:`PoolRealArray<class_PoolRealArray>` of vertex tangents. Each element in groups of 4 floats, first 3 floats determine the tangent, and the last the binormal direction as -1 or 1.
|
||||
- **ARRAY_TANGENT** = **2** --- :ref:`PackedFloat32Array<class_PackedFloat32Array>` of vertex tangents. Each element in groups of 4 floats, first 3 floats determine the tangent, and the last the binormal direction as -1 or 1.
|
||||
|
||||
- **ARRAY_COLOR** = **3** --- :ref:`PoolColorArray<class_PoolColorArray>` of vertex colors.
|
||||
- **ARRAY_COLOR** = **3** --- :ref:`PackedColorArray<class_PackedColorArray>` of vertex colors.
|
||||
|
||||
- **ARRAY_TEX_UV** = **4** --- :ref:`PoolVector2Array<class_PoolVector2Array>` for UV coordinates.
|
||||
- **ARRAY_TEX_UV** = **4** --- :ref:`PackedVector2Array<class_PackedVector2Array>` for UV coordinates.
|
||||
|
||||
- **ARRAY_TEX_UV2** = **5** --- :ref:`PoolVector2Array<class_PoolVector2Array>` for second UV coordinates.
|
||||
- **ARRAY_TEX_UV2** = **5** --- :ref:`PackedVector2Array<class_PackedVector2Array>` for second UV coordinates.
|
||||
|
||||
- **ARRAY_BONES** = **6** --- :ref:`PoolRealArray<class_PoolRealArray>` or :ref:`PoolIntArray<class_PoolIntArray>` of bone indices. Each element in groups of 4 floats.
|
||||
- **ARRAY_BONES** = **6** --- :ref:`PackedFloat32Array<class_PackedFloat32Array>` or :ref:`PackedInt32Array<class_PackedInt32Array>` of bone indices. Each element in groups of 4 floats.
|
||||
|
||||
- **ARRAY_WEIGHTS** = **7** --- :ref:`PoolRealArray<class_PoolRealArray>` of bone weights. Each element in groups of 4 floats.
|
||||
- **ARRAY_WEIGHTS** = **7** --- :ref:`PackedFloat32Array<class_PackedFloat32Array>` of bone weights. Each element in groups of 4 floats.
|
||||
|
||||
- **ARRAY_INDEX** = **8** --- :ref:`PoolIntArray<class_PoolIntArray>` of integers used as indices referencing vertices, colors, normals, tangents, and textures. All of those arrays must have the same number of elements as the vertex array. No index can be beyond the vertex array size. When this index array is present, it puts the function into "index mode," where the index selects the \*i\*'th vertex, normal, tangent, color, UV, etc. This means if you want to have different normals or colors along an edge, you have to duplicate the vertices.
|
||||
- **ARRAY_INDEX** = **8** --- :ref:`PackedInt32Array<class_PackedInt32Array>` of integers used as indices referencing vertices, colors, normals, tangents, and textures. All of those arrays must have the same number of elements as the vertex array. No index can be beyond the vertex array size. When this index array is present, it puts the function into "index mode," where the index selects the \*i\*'th vertex, normal, tangent, color, UV, etc. This means if you want to have different normals or colors along an edge, you have to duplicate the vertices.
|
||||
|
||||
For triangles, the index array is interpreted as triples, referring to the vertices of each triangle. For lines, the index array is in pairs indicating the start and end of each line.
|
||||
|
||||
@@ -229,7 +229,7 @@ Method Descriptions
|
||||
|
||||
.. _class_ArrayMesh_method_add_blend_shape:
|
||||
|
||||
- void **add_blend_shape** **(** :ref:`String<class_String>` name **)**
|
||||
- void **add_blend_shape** **(** :ref:`StringName<class_StringName>` name **)**
|
||||
|
||||
Adds name for a blend shape that will be added with :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`. Must be called before surface is added.
|
||||
|
||||
@@ -237,7 +237,7 @@ Adds name for a blend shape that will be added with :ref:`add_surface_from_array
|
||||
|
||||
.. _class_ArrayMesh_method_add_surface_from_arrays:
|
||||
|
||||
- void **add_surface_from_arrays** **(** :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[ ], :ref:`int<class_int>` compress_flags=97280 **)**
|
||||
- void **add_surface_from_arrays** **(** :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[ ], :ref:`Dictionary<class_Dictionary>` lods={ }, :ref:`int<class_int>` compress_flags=31744 **)**
|
||||
|
||||
Creates a new surface.
|
||||
|
||||
@@ -259,6 +259,14 @@ Removes all blend shapes from this ``ArrayMesh``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_ArrayMesh_method_clear_surfaces:
|
||||
|
||||
- void **clear_surfaces** **(** **)**
|
||||
|
||||
Removes all surfaces from this ``ArrayMesh``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_ArrayMesh_method_get_blend_shape_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_blend_shape_count** **(** **)** const
|
||||
@@ -269,7 +277,7 @@ Returns the number of blend shapes that the ``ArrayMesh`` holds.
|
||||
|
||||
.. _class_ArrayMesh_method_get_blend_shape_name:
|
||||
|
||||
- :ref:`String<class_String>` **get_blend_shape_name** **(** :ref:`int<class_int>` index **)** const
|
||||
- :ref:`StringName<class_StringName>` **get_blend_shape_name** **(** :ref:`int<class_int>` index **)** const
|
||||
|
||||
Returns the name of the blend shape at this index.
|
||||
|
||||
@@ -339,14 +347,6 @@ Returns the primitive type of the requested surface (see :ref:`add_surface_from_
|
||||
|
||||
----
|
||||
|
||||
.. _class_ArrayMesh_method_surface_remove:
|
||||
|
||||
- void **surface_remove** **(** :ref:`int<class_int>` surf_idx **)**
|
||||
|
||||
Removes a surface at position ``surf_idx``, shifting greater surfaces one ``surf_idx`` slot down.
|
||||
|
||||
----
|
||||
|
||||
.. _class_ArrayMesh_method_surface_set_name:
|
||||
|
||||
- void **surface_set_name** **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_String>` name **)**
|
||||
@@ -357,7 +357,7 @@ Sets a name for a given surface.
|
||||
|
||||
.. _class_ArrayMesh_method_surface_update_region:
|
||||
|
||||
- void **surface_update_region** **(** :ref:`int<class_int>` surf_idx, :ref:`int<class_int>` offset, :ref:`PoolByteArray<class_PoolByteArray>` data **)**
|
||||
- void **surface_update_region** **(** :ref:`int<class_int>` surf_idx, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)**
|
||||
|
||||
Updates a specified region of mesh arrays on the GPU.
|
||||
|
||||
|
||||
@@ -52,7 +52,7 @@ Methods
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Mesh<class_Mesh>` | :ref:`get_mesh<class_ARVRController_method_get_mesh>` **(** **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`is_button_pressed<class_ARVRController_method_is_button_pressed>` **(** :ref:`int<class_int>` button **)** const |
|
||||
| :ref:`bool<class_bool>` | :ref:`is_button_pressed<class_ARVRController_method_is_button_pressed>` **(** :ref:`int<class_int>` button **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
@@ -174,7 +174,7 @@ If provided by the :ref:`ARVRInterface<class_ARVRInterface>`, this returns a mes
|
||||
|
||||
.. _class_ARVRController_method_is_button_pressed:
|
||||
|
||||
- :ref:`int<class_int>` **is_button_pressed** **(** :ref:`int<class_int>` button **)** const
|
||||
- :ref:`bool<class_bool>` **is_button_pressed** **(** :ref:`int<class_int>` button **)** const
|
||||
|
||||
Returns ``true`` if the button at index ``button`` is pressed. See :ref:`JoystickList<enum_@GlobalScope_JoystickList>`, in particular the ``JOY_VR_*`` constants.
|
||||
|
||||
|
||||
@@ -46,7 +46,7 @@ Methods
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_capabilities<class_ARVRInterface_method_get_capabilities>` **(** **)** const |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_name<class_ARVRInterface_method_get_name>` **(** **)** const |
|
||||
| :ref:`StringName<class_StringName>` | :ref:`get_name<class_ARVRInterface_method_get_name>` **(** **)** const |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_render_targetsize<class_ARVRInterface_method_get_render_targetsize>` **(** **)** |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------+
|
||||
@@ -200,7 +200,7 @@ Returns a combination of :ref:`Capabilities<enum_ARVRInterface_Capabilities>` fl
|
||||
|
||||
.. _class_ARVRInterface_method_get_name:
|
||||
|
||||
- :ref:`String<class_String>` **get_name** **(** **)** const
|
||||
- :ref:`StringName<class_StringName>` **get_name** **(** **)** const
|
||||
|
||||
Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc).
|
||||
|
||||
|
||||
@@ -44,12 +44,14 @@ Methods
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Mesh<class_Mesh>` | :ref:`get_mesh<class_ARVRPositionalTracker_method_get_mesh>` **(** **)** const |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_name<class_ARVRPositionalTracker_method_get_name>` **(** **)** const |
|
||||
| :ref:`StringName<class_StringName>` | :ref:`get_name<class_ARVRPositionalTracker_method_get_name>` **(** **)** const |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`get_orientation<class_ARVRPositionalTracker_method_get_orientation>` **(** **)** const |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_position<class_ARVRPositionalTracker_method_get_position>` **(** **)** const |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_tracker_id<class_ARVRPositionalTracker_method_get_tracker_id>` **(** **)** const |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_tracks_orientation<class_ARVRPositionalTracker_method_get_tracks_orientation>` **(** **)** const |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_tracks_position<class_ARVRPositionalTracker_method_get_tracks_position>` **(** **)** const |
|
||||
@@ -124,7 +126,7 @@ Returns the mesh related to a controller or anchor point if one is available.
|
||||
|
||||
.. _class_ARVRPositionalTracker_method_get_name:
|
||||
|
||||
- :ref:`String<class_String>` **get_name** **(** **)** const
|
||||
- :ref:`StringName<class_StringName>` **get_name** **(** **)** const
|
||||
|
||||
Returns the controller or anchor point's name if available.
|
||||
|
||||
@@ -146,6 +148,14 @@ Returns the world-space controller position.
|
||||
|
||||
----
|
||||
|
||||
.. _class_ARVRPositionalTracker_method_get_tracker_id:
|
||||
|
||||
- :ref:`int<class_int>` **get_tracker_id** **(** **)** const
|
||||
|
||||
Returns the internal tracker ID. This uniquely identifies the tracker per tracker type and matches the ID you need to specify for nodes such as the :ref:`ARVRController<class_ARVRController>` and :ref:`ARVRAnchor<class_ARVRAnchor>` nodes.
|
||||
|
||||
----
|
||||
|
||||
.. _class_ARVRPositionalTracker_method_get_tracks_orientation:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_tracks_orientation** **(** **)** const
|
||||
|
||||
@@ -66,7 +66,7 @@ Signals
|
||||
|
||||
.. _class_ARVRServer_signal_interface_added:
|
||||
|
||||
- **interface_added** **(** :ref:`String<class_String>` interface_name **)**
|
||||
- **interface_added** **(** :ref:`StringName<class_StringName>` interface_name **)**
|
||||
|
||||
Emitted when a new interface has been added.
|
||||
|
||||
@@ -74,7 +74,7 @@ Emitted when a new interface has been added.
|
||||
|
||||
.. _class_ARVRServer_signal_interface_removed:
|
||||
|
||||
- **interface_removed** **(** :ref:`String<class_String>` interface_name **)**
|
||||
- **interface_removed** **(** :ref:`StringName<class_StringName>` interface_name **)**
|
||||
|
||||
Emitted when an interface is removed.
|
||||
|
||||
@@ -82,7 +82,7 @@ Emitted when an interface is removed.
|
||||
|
||||
.. _class_ARVRServer_signal_tracker_added:
|
||||
|
||||
- **tracker_added** **(** :ref:`String<class_String>` tracker_name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
|
||||
- **tracker_added** **(** :ref:`StringName<class_StringName>` tracker_name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
|
||||
|
||||
Emitted when a new tracker has been added. If you don't use a fixed number of controllers or if you're using :ref:`ARVRAnchor<class_ARVRAnchor>`\ s for an AR solution, it is important to react to this signal to add the appropriate :ref:`ARVRController<class_ARVRController>` or :ref:`ARVRAnchor<class_ARVRAnchor>` nodes related to this new tracker.
|
||||
|
||||
@@ -90,7 +90,7 @@ Emitted when a new tracker has been added. If you don't use a fixed number of co
|
||||
|
||||
.. _class_ARVRServer_signal_tracker_removed:
|
||||
|
||||
- **tracker_removed** **(** :ref:`String<class_String>` tracker_name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
|
||||
- **tracker_removed** **(** :ref:`StringName<class_StringName>` tracker_name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
|
||||
|
||||
Emitted when a tracker is removed. You should remove any :ref:`ARVRController<class_ARVRController>` or :ref:`ARVRAnchor<class_ARVRAnchor>` points if applicable. This is not mandatory, the nodes simply become inactive and will be made active again when a new tracker becomes available (i.e. a new controller is switched on that takes the place of the previous one).
|
||||
|
||||
|
||||
@@ -38,57 +38,57 @@ It is also possible to use non-Euclidean distances. To do so, create a class tha
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`_compute_cost<class_AStar_method__compute_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`_estimate_cost<class_AStar_method__estimate_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_point<class_AStar_method_add_point>` **(** :ref:`int<class_int>` id, :ref:`Vector3<class_Vector3>` position, :ref:`float<class_float>` weight_scale=1.0 **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`are_points_connected<class_AStar_method_are_points_connected>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_AStar_method_clear>` **(** **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`connect_points<class_AStar_method_connect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect_points<class_AStar_method_disconnect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_available_point_id<class_AStar_method_get_available_point_id>` **(** **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_closest_point<class_AStar_method_get_closest_point>` **(** :ref:`Vector3<class_Vector3>` to_position, :ref:`bool<class_bool>` include_disabled=false **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_closest_position_in_segment<class_AStar_method_get_closest_position_in_segment>` **(** :ref:`Vector3<class_Vector3>` to_position **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`get_id_path<class_AStar_method_get_id_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_point_capacity<class_AStar_method_get_point_capacity>` **(** **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`get_point_connections<class_AStar_method_get_point_connections>` **(** :ref:`int<class_int>` id **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_point_count<class_AStar_method_get_point_count>` **(** **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`get_point_path<class_AStar_method_get_point_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_point_position<class_AStar_method_get_point_position>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_point_weight_scale<class_AStar_method_get_point_weight_scale>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_points<class_AStar_method_get_points>` **(** **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_point<class_AStar_method_has_point>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_point_disabled<class_AStar_method_is_point_disabled>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_AStar_method_remove_point>` **(** :ref:`int<class_int>` id **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`reserve_space<class_AStar_method_reserve_space>` **(** :ref:`int<class_int>` num_nodes **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_disabled<class_AStar_method_set_point_disabled>` **(** :ref:`int<class_int>` id, :ref:`bool<class_bool>` disabled=true **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_position<class_AStar_method_set_point_position>` **(** :ref:`int<class_int>` id, :ref:`Vector3<class_Vector3>` position **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_weight_scale<class_AStar_method_set_point_weight_scale>` **(** :ref:`int<class_int>` id, :ref:`float<class_float>` weight_scale **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`_compute_cost<class_AStar_method__compute_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`_estimate_cost<class_AStar_method__estimate_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_point<class_AStar_method_add_point>` **(** :ref:`int<class_int>` id, :ref:`Vector3<class_Vector3>` position, :ref:`float<class_float>` weight_scale=1.0 **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`are_points_connected<class_AStar_method_are_points_connected>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_AStar_method_clear>` **(** **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`connect_points<class_AStar_method_connect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect_points<class_AStar_method_disconnect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_available_point_id<class_AStar_method_get_available_point_id>` **(** **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_closest_point<class_AStar_method_get_closest_point>` **(** :ref:`Vector3<class_Vector3>` to_position, :ref:`bool<class_bool>` include_disabled=false **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_closest_position_in_segment<class_AStar_method_get_closest_position_in_segment>` **(** :ref:`Vector3<class_Vector3>` to_position **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_id_path<class_AStar_method_get_id_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_point_capacity<class_AStar_method_get_point_capacity>` **(** **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_point_connections<class_AStar_method_get_point_connections>` **(** :ref:`int<class_int>` id **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_point_count<class_AStar_method_get_point_count>` **(** **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`get_point_path<class_AStar_method_get_point_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_point_position<class_AStar_method_get_point_position>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_point_weight_scale<class_AStar_method_get_point_weight_scale>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_points<class_AStar_method_get_points>` **(** **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_point<class_AStar_method_has_point>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_point_disabled<class_AStar_method_is_point_disabled>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_AStar_method_remove_point>` **(** :ref:`int<class_int>` id **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`reserve_space<class_AStar_method_reserve_space>` **(** :ref:`int<class_int>` num_nodes **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_disabled<class_AStar_method_set_point_disabled>` **(** :ref:`int<class_int>` id, :ref:`bool<class_bool>` disabled=true **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_position<class_AStar_method_set_point_position>` **(** :ref:`int<class_int>` id, :ref:`Vector3<class_Vector3>` position **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_weight_scale<class_AStar_method_set_point_weight_scale>` **(** :ref:`int<class_int>` id, :ref:`float<class_float>` weight_scale **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
@@ -203,7 +203,7 @@ The result is in the segment that goes from ``y = 0`` to ``y = 5``. It's the clo
|
||||
|
||||
.. _class_AStar_method_get_id_path:
|
||||
|
||||
- :ref:`PoolIntArray<class_PoolIntArray>` **get_id_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
|
||||
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_id_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
|
||||
|
||||
Returns an array with the IDs of the points that form the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path.
|
||||
|
||||
@@ -236,7 +236,7 @@ Returns the capacity of the structure backing the points, useful in conjunction
|
||||
|
||||
.. _class_AStar_method_get_point_connections:
|
||||
|
||||
- :ref:`PoolIntArray<class_PoolIntArray>` **get_point_connections** **(** :ref:`int<class_int>` id **)**
|
||||
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_point_connections** **(** :ref:`int<class_int>` id **)**
|
||||
|
||||
Returns an array with the IDs of the points that form the connection with the given point.
|
||||
|
||||
@@ -265,7 +265,7 @@ Returns the number of points currently in the points pool.
|
||||
|
||||
.. _class_AStar_method_get_point_path:
|
||||
|
||||
- :ref:`PoolVector3Array<class_PoolVector3Array>` **get_point_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
|
||||
- :ref:`PackedVector3Array<class_PackedVector3Array>` **get_point_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
|
||||
|
||||
Returns an array with the points that are in the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path.
|
||||
|
||||
|
||||
@@ -21,53 +21,53 @@ This is a wrapper for the :ref:`AStar<class_AStar>` class which uses 2D vectors
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_point<class_AStar2D_method_add_point>` **(** :ref:`int<class_int>` id, :ref:`Vector2<class_Vector2>` position, :ref:`float<class_float>` weight_scale=1.0 **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`are_points_connected<class_AStar2D_method_are_points_connected>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_AStar2D_method_clear>` **(** **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`connect_points<class_AStar2D_method_connect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect_points<class_AStar2D_method_disconnect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_available_point_id<class_AStar2D_method_get_available_point_id>` **(** **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_closest_point<class_AStar2D_method_get_closest_point>` **(** :ref:`Vector2<class_Vector2>` to_position, :ref:`bool<class_bool>` include_disabled=false **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_closest_position_in_segment<class_AStar2D_method_get_closest_position_in_segment>` **(** :ref:`Vector2<class_Vector2>` to_position **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`get_id_path<class_AStar2D_method_get_id_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_point_capacity<class_AStar2D_method_get_point_capacity>` **(** **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`get_point_connections<class_AStar2D_method_get_point_connections>` **(** :ref:`int<class_int>` id **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_point_count<class_AStar2D_method_get_point_count>` **(** **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`get_point_path<class_AStar2D_method_get_point_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_point_position<class_AStar2D_method_get_point_position>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_point_weight_scale<class_AStar2D_method_get_point_weight_scale>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_points<class_AStar2D_method_get_points>` **(** **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_point<class_AStar2D_method_has_point>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_point_disabled<class_AStar2D_method_is_point_disabled>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_AStar2D_method_remove_point>` **(** :ref:`int<class_int>` id **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`reserve_space<class_AStar2D_method_reserve_space>` **(** :ref:`int<class_int>` num_nodes **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_disabled<class_AStar2D_method_set_point_disabled>` **(** :ref:`int<class_int>` id, :ref:`bool<class_bool>` disabled=true **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_position<class_AStar2D_method_set_point_position>` **(** :ref:`int<class_int>` id, :ref:`Vector2<class_Vector2>` position **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_weight_scale<class_AStar2D_method_set_point_weight_scale>` **(** :ref:`int<class_int>` id, :ref:`float<class_float>` weight_scale **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_point<class_AStar2D_method_add_point>` **(** :ref:`int<class_int>` id, :ref:`Vector2<class_Vector2>` position, :ref:`float<class_float>` weight_scale=1.0 **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`are_points_connected<class_AStar2D_method_are_points_connected>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_AStar2D_method_clear>` **(** **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`connect_points<class_AStar2D_method_connect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect_points<class_AStar2D_method_disconnect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_available_point_id<class_AStar2D_method_get_available_point_id>` **(** **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_closest_point<class_AStar2D_method_get_closest_point>` **(** :ref:`Vector2<class_Vector2>` to_position, :ref:`bool<class_bool>` include_disabled=false **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_closest_position_in_segment<class_AStar2D_method_get_closest_position_in_segment>` **(** :ref:`Vector2<class_Vector2>` to_position **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_id_path<class_AStar2D_method_get_id_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_point_capacity<class_AStar2D_method_get_point_capacity>` **(** **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_point_connections<class_AStar2D_method_get_point_connections>` **(** :ref:`int<class_int>` id **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_point_count<class_AStar2D_method_get_point_count>` **(** **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`get_point_path<class_AStar2D_method_get_point_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_point_position<class_AStar2D_method_get_point_position>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_point_weight_scale<class_AStar2D_method_get_point_weight_scale>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_points<class_AStar2D_method_get_points>` **(** **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_point<class_AStar2D_method_has_point>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_point_disabled<class_AStar2D_method_is_point_disabled>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_AStar2D_method_remove_point>` **(** :ref:`int<class_int>` id **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`reserve_space<class_AStar2D_method_reserve_space>` **(** :ref:`int<class_int>` num_nodes **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_disabled<class_AStar2D_method_set_point_disabled>` **(** :ref:`int<class_int>` id, :ref:`bool<class_bool>` disabled=true **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_position<class_AStar2D_method_set_point_position>` **(** :ref:`int<class_int>` id, :ref:`Vector2<class_Vector2>` position **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_weight_scale<class_AStar2D_method_set_point_weight_scale>` **(** :ref:`int<class_int>` id, :ref:`float<class_float>` weight_scale **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
@@ -162,7 +162,7 @@ The result is in the segment that goes from ``y = 0`` to ``y = 5``. It's the clo
|
||||
|
||||
.. _class_AStar2D_method_get_id_path:
|
||||
|
||||
- :ref:`PoolIntArray<class_PoolIntArray>` **get_id_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
|
||||
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_id_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
|
||||
|
||||
Returns an array with the IDs of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path.
|
||||
|
||||
@@ -195,7 +195,7 @@ Returns the capacity of the structure backing the points, useful in conjunction
|
||||
|
||||
.. _class_AStar2D_method_get_point_connections:
|
||||
|
||||
- :ref:`PoolIntArray<class_PoolIntArray>` **get_point_connections** **(** :ref:`int<class_int>` id **)**
|
||||
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_point_connections** **(** :ref:`int<class_int>` id **)**
|
||||
|
||||
Returns an array with the IDs of the points that form the connection with the given point.
|
||||
|
||||
@@ -224,7 +224,7 @@ Returns the number of points currently in the points pool.
|
||||
|
||||
.. _class_AStar2D_method_get_point_path:
|
||||
|
||||
- :ref:`PoolVector2Array<class_PoolVector2Array>` **get_point_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
|
||||
- :ref:`PackedVector2Array<class_PackedVector2Array>` **get_point_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
|
||||
|
||||
Returns an array with the points that are in the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path.
|
||||
|
||||
|
||||
@@ -9,36 +9,34 @@
|
||||
AtlasTexture
|
||||
============
|
||||
|
||||
**Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
**Inherits:** :ref:`Texture2D<class_Texture2D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
:ref:`Texture<class_Texture>` resource aimed at managing big textures files that pack multiple smaller textures. Consists of a :ref:`Texture<class_Texture>`, a margin that defines the border width, and a region that defines the actual area of the AtlasTexture.
|
||||
:ref:`Texture2D<class_Texture2D>` resource aimed at managing big textures files that pack multiple smaller textures. Consists of a :ref:`Texture2D<class_Texture2D>`, a margin that defines the border width, and a region that defines the actual area of the AtlasTexture.
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------+-------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`atlas<class_AtlasTexture_property_atlas>` | |
|
||||
+-------------------------------+-------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`filter_clip<class_AtlasTexture_property_filter_clip>` | ``false`` |
|
||||
+-------------------------------+-------------------------------------------------------------+-------------------------+
|
||||
| :ref:`int<class_int>` | flags | **O:** ``0`` |
|
||||
+-------------------------------+-------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`margin<class_AtlasTexture_property_margin>` | ``Rect2( 0, 0, 0, 0 )`` |
|
||||
+-------------------------------+-------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`region<class_AtlasTexture_property_region>` | ``Rect2( 0, 0, 0, 0 )`` |
|
||||
+-------------------------------+-------------------------------------------------------------+-------------------------+
|
||||
+-----------------------------------+-------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`atlas<class_AtlasTexture_property_atlas>` | |
|
||||
+-----------------------------------+-------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`filter_clip<class_AtlasTexture_property_filter_clip>` | ``false`` |
|
||||
+-----------------------------------+-------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`margin<class_AtlasTexture_property_margin>` | ``Rect2( 0, 0, 0, 0 )`` |
|
||||
+-----------------------------------+-------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`region<class_AtlasTexture_property_region>` | ``Rect2( 0, 0, 0, 0 )`` |
|
||||
+-----------------------------------+-------------------------------------------------------------+-------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AtlasTexture_property_atlas:
|
||||
|
||||
- :ref:`Texture<class_Texture>` **atlas**
|
||||
- :ref:`Texture2D<class_Texture2D>` **atlas**
|
||||
|
||||
+----------+------------------+
|
||||
| *Setter* | set_atlas(value) |
|
||||
@@ -46,7 +44,7 @@ Property Descriptions
|
||||
| *Getter* | get_atlas() |
|
||||
+----------+------------------+
|
||||
|
||||
The texture that contains the atlas. Can be any :ref:`Texture<class_Texture>` subtype.
|
||||
The texture that contains the atlas. Can be any :ref:`Texture2D<class_Texture2D>` subtype.
|
||||
|
||||
----
|
||||
|
||||
|
||||
@@ -33,21 +33,21 @@ Compressor has many uses in the mix:
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`attack_us<class_AudioEffectCompressor_property_attack_us>` | ``20.0`` |
|
||||
+-----------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`gain<class_AudioEffectCompressor_property_gain>` | ``0.0`` |
|
||||
+-----------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`mix<class_AudioEffectCompressor_property_mix>` | ``1.0`` |
|
||||
+-----------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`ratio<class_AudioEffectCompressor_property_ratio>` | ``4.0`` |
|
||||
+-----------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`release_ms<class_AudioEffectCompressor_property_release_ms>` | ``250.0`` |
|
||||
+-----------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`String<class_String>` | :ref:`sidechain<class_AudioEffectCompressor_property_sidechain>` | ``""`` |
|
||||
+-----------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`threshold<class_AudioEffectCompressor_property_threshold>` | ``0.0`` |
|
||||
+-----------------------------+--------------------------------------------------------------------+-----------+
|
||||
+-------------------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`attack_us<class_AudioEffectCompressor_property_attack_us>` | ``20.0`` |
|
||||
+-------------------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`gain<class_AudioEffectCompressor_property_gain>` | ``0.0`` |
|
||||
+-------------------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`mix<class_AudioEffectCompressor_property_mix>` | ``1.0`` |
|
||||
+-------------------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`ratio<class_AudioEffectCompressor_property_ratio>` | ``4.0`` |
|
||||
+-------------------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`release_ms<class_AudioEffectCompressor_property_release_ms>` | ``250.0`` |
|
||||
+-------------------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`StringName<class_StringName>` | :ref:`sidechain<class_AudioEffectCompressor_property_sidechain>` | ``@""`` |
|
||||
+-------------------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`threshold<class_AudioEffectCompressor_property_threshold>` | ``0.0`` |
|
||||
+-------------------------------------+--------------------------------------------------------------------+-----------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -134,10 +134,10 @@ Compressor's delay time to stop reducing the signal after the signal level falls
|
||||
|
||||
.. _class_AudioEffectCompressor_property_sidechain:
|
||||
|
||||
- :ref:`String<class_String>` **sidechain**
|
||||
- :ref:`StringName<class_StringName>` **sidechain**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | ``""`` |
|
||||
| *Default* | ``@""`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_sidechain(value) |
|
||||
+-----------+----------------------+
|
||||
|
||||
@@ -11,7 +11,12 @@ AudioEffectRecord
|
||||
|
||||
**Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
Audio effect used for recording sound from a microphone.
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
|
||||
- :doc:`../tutorials/audio/recording_with_microphone`
|
||||
|
||||
Properties
|
||||
----------
|
||||
@@ -46,6 +51,8 @@ Property Descriptions
|
||||
| *Getter* | get_format() |
|
||||
+-----------+-------------------+
|
||||
|
||||
Specifies the format in which the sample will be recorded. See :ref:`Format<enum_AudioStreamSample_Format>` for available formats.
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
@@ -53,15 +60,21 @@ Method Descriptions
|
||||
|
||||
- :ref:`AudioStreamSample<class_AudioStreamSample>` **get_recording** **(** **)** const
|
||||
|
||||
Returns the recorded sample.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AudioEffectRecord_method_is_recording_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_recording_active** **(** **)** const
|
||||
|
||||
Returns whether the recording is active or not.
|
||||
|
||||
----
|
||||
|
||||
.. _class_AudioEffectRecord_method_set_recording_active:
|
||||
|
||||
- void **set_recording_active** **(** :ref:`bool<class_bool>` record **)**
|
||||
|
||||
If ``true``, the sound will be recorded. Note that restarting the recording will remove the previously recorded sample.
|
||||
|
||||
|
||||
@@ -58,7 +58,7 @@ Methods
|
||||
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AudioEffectInstance<class_AudioEffectInstance>` | :ref:`get_bus_effect_instance<class_AudioServer_method_get_bus_effect_instance>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` channel=0 **)** |
|
||||
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_bus_index<class_AudioServer_method_get_bus_index>` **(** :ref:`String<class_String>` bus_name **)** const |
|
||||
| :ref:`int<class_int>` | :ref:`get_bus_index<class_AudioServer_method_get_bus_index>` **(** :ref:`StringName<class_StringName>` bus_name **)** const |
|
||||
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_bus_name<class_AudioServer_method_get_bus_name>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -66,7 +66,7 @@ Methods
|
||||
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_bus_peak_volume_right_db<class_AudioServer_method_get_bus_peak_volume_right_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const |
|
||||
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_bus_send<class_AudioServer_method_get_bus_send>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
| :ref:`StringName<class_StringName>` | :ref:`get_bus_send<class_AudioServer_method_get_bus_send>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_bus_volume_db<class_AudioServer_method_get_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -108,7 +108,7 @@ Methods
|
||||
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_name<class_AudioServer_method_set_bus_name>` **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_String>` name **)** |
|
||||
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_send<class_AudioServer_method_set_bus_send>` **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_String>` send **)** |
|
||||
| void | :ref:`set_bus_send<class_AudioServer_method_set_bus_send>` **(** :ref:`int<class_int>` bus_idx, :ref:`StringName<class_StringName>` send **)** |
|
||||
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_solo<class_AudioServer_method_set_bus_solo>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
|
||||
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -285,7 +285,7 @@ Returns the :ref:`AudioEffectInstance<class_AudioEffectInstance>` assigned to th
|
||||
|
||||
.. _class_AudioServer_method_get_bus_index:
|
||||
|
||||
- :ref:`int<class_int>` **get_bus_index** **(** :ref:`String<class_String>` bus_name **)** const
|
||||
- :ref:`int<class_int>` **get_bus_index** **(** :ref:`StringName<class_StringName>` bus_name **)** const
|
||||
|
||||
Returns the index of the bus with the name ``bus_name``.
|
||||
|
||||
@@ -317,7 +317,7 @@ Returns the peak volume of the right speaker at bus index ``bus_idx`` and channe
|
||||
|
||||
.. _class_AudioServer_method_get_bus_send:
|
||||
|
||||
- :ref:`String<class_String>` **get_bus_send** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
- :ref:`StringName<class_StringName>` **get_bus_send** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
|
||||
Returns the name of the bus that the bus at index ``bus_idx`` sends to.
|
||||
|
||||
@@ -487,7 +487,7 @@ Sets the name of the bus at index ``bus_idx`` to ``name``.
|
||||
|
||||
.. _class_AudioServer_method_set_bus_send:
|
||||
|
||||
- void **set_bus_send** **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_String>` send **)**
|
||||
- void **set_bus_send** **(** :ref:`int<class_int>` bus_idx, :ref:`StringName<class_StringName>` send **)**
|
||||
|
||||
Connects the output of the bus at ``bus_idx`` to the bus named ``send``.
|
||||
|
||||
|
||||
@@ -21,19 +21,19 @@ Tutorials
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_push_buffer<class_AudioStreamGeneratorPlayback_method_can_push_buffer>` **(** :ref:`int<class_int>` amount **)** const |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_buffer<class_AudioStreamGeneratorPlayback_method_clear_buffer>` **(** **)** |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_frames_available<class_AudioStreamGeneratorPlayback_method_get_frames_available>` **(** **)** const |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_skips<class_AudioStreamGeneratorPlayback_method_get_skips>` **(** **)** const |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`push_buffer<class_AudioStreamGeneratorPlayback_method_push_buffer>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` frames **)** |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`push_frame<class_AudioStreamGeneratorPlayback_method_push_frame>` **(** :ref:`Vector2<class_Vector2>` frame **)** |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_push_buffer<class_AudioStreamGeneratorPlayback_method_can_push_buffer>` **(** :ref:`int<class_int>` amount **)** const |
|
||||
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_buffer<class_AudioStreamGeneratorPlayback_method_clear_buffer>` **(** **)** |
|
||||
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_frames_available<class_AudioStreamGeneratorPlayback_method_get_frames_available>` **(** **)** const |
|
||||
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_skips<class_AudioStreamGeneratorPlayback_method_get_skips>` **(** **)** const |
|
||||
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`push_buffer<class_AudioStreamGeneratorPlayback_method_push_buffer>` **(** :ref:`PackedVector2Array<class_PackedVector2Array>` frames **)** |
|
||||
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`push_frame<class_AudioStreamGeneratorPlayback_method_push_frame>` **(** :ref:`Vector2<class_Vector2>` frame **)** |
|
||||
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
@@ -64,7 +64,7 @@ Method Descriptions
|
||||
|
||||
.. _class_AudioStreamGeneratorPlayback_method_push_buffer:
|
||||
|
||||
- :ref:`bool<class_bool>` **push_buffer** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` frames **)**
|
||||
- :ref:`bool<class_bool>` **push_buffer** **(** :ref:`PackedVector2Array<class_PackedVector2Array>` frames **)**
|
||||
|
||||
----
|
||||
|
||||
|
||||
@@ -21,28 +21,28 @@ OGG Vorbis audio stream driver.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------+---------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`data<class_AudioStreamOGGVorbis_property_data>` | ``PoolByteArray( )`` |
|
||||
+-------------------------------------------+---------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`loop<class_AudioStreamOGGVorbis_property_loop>` | ``false`` |
|
||||
+-------------------------------------------+---------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`loop_offset<class_AudioStreamOGGVorbis_property_loop_offset>` | ``0.0`` |
|
||||
+-------------------------------------------+---------------------------------------------------------------------+-----------------------+
|
||||
+-----------------------------------------------+---------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`data<class_AudioStreamOGGVorbis_property_data>` | ``PackedByteArray( )`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`loop<class_AudioStreamOGGVorbis_property_loop>` | ``false`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`loop_offset<class_AudioStreamOGGVorbis_property_loop_offset>` | ``0.0`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------+-------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioStreamOGGVorbis_property_data:
|
||||
|
||||
- :ref:`PoolByteArray<class_PoolByteArray>` **data**
|
||||
- :ref:`PackedByteArray<class_PackedByteArray>` **data**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | ``PoolByteArray( )`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_data(value) |
|
||||
+-----------+-----------------------+
|
||||
| *Getter* | get_data() |
|
||||
+-----------+-----------------------+
|
||||
+-----------+-------------------------+
|
||||
| *Default* | ``PackedByteArray( )`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_data(value) |
|
||||
+-----------+-------------------------+
|
||||
| *Getter* | get_data() |
|
||||
+-----------+-------------------------+
|
||||
|
||||
Contains the audio data in bytes.
|
||||
|
||||
|
||||
@@ -26,23 +26,23 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer_property_autoplay>` | ``false`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
||||
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer_property_bus>` | ``"Master"`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
||||
| :ref:`MixTarget<enum_AudioStreamPlayer_MixTarget>` | :ref:`mix_target<class_AudioStreamPlayer_property_mix_target>` | ``0`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer_property_pitch_scale>` | ``1.0`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer_property_playing>` | ``false`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer_property_stream>` | |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer_property_stream_paused>` | ``false`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioStreamPlayer_property_volume_db>` | ``0.0`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+---------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer_property_autoplay>` | ``false`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+---------------+
|
||||
| :ref:`StringName<class_StringName>` | :ref:`bus<class_AudioStreamPlayer_property_bus>` | ``@"Master"`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+---------------+
|
||||
| :ref:`MixTarget<enum_AudioStreamPlayer_MixTarget>` | :ref:`mix_target<class_AudioStreamPlayer_property_mix_target>` | ``0`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+---------------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer_property_pitch_scale>` | ``1.0`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+---------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer_property_playing>` | ``false`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+---------------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer_property_stream>` | |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+---------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer_property_stream_paused>` | ``false`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+---------------+
|
||||
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioStreamPlayer_property_volume_db>` | ``0.0`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+---------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -108,10 +108,10 @@ If ``true``, audio plays when added to scene tree.
|
||||
|
||||
.. _class_AudioStreamPlayer_property_bus:
|
||||
|
||||
- :ref:`String<class_String>` **bus**
|
||||
- :ref:`StringName<class_StringName>` **bus**
|
||||
|
||||
+-----------+----------------+
|
||||
| *Default* | ``"Master"`` |
|
||||
| *Default* | ``@"Master"`` |
|
||||
+-----------+----------------+
|
||||
| *Setter* | set_bus(value) |
|
||||
+-----------+----------------+
|
||||
|
||||
@@ -26,27 +26,27 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`int<class_int>` | :ref:`area_mask<class_AudioStreamPlayer2D_property_area_mask>` | ``1`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`attenuation<class_AudioStreamPlayer2D_property_attenuation>` | ``1.0`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer2D_property_autoplay>` | ``false`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer2D_property_bus>` | ``"Master"`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`max_distance<class_AudioStreamPlayer2D_property_max_distance>` | ``2000.0`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer2D_property_pitch_scale>` | ``1.0`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer2D_property_playing>` | ``false`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer2D_property_stream>` | |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer2D_property_stream_paused>` | ``false`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioStreamPlayer2D_property_volume_db>` | ``0.0`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
+---------------------------------------+------------------------------------------------------------------------+---------------+
|
||||
| :ref:`int<class_int>` | :ref:`area_mask<class_AudioStreamPlayer2D_property_area_mask>` | ``1`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+---------------+
|
||||
| :ref:`float<class_float>` | :ref:`attenuation<class_AudioStreamPlayer2D_property_attenuation>` | ``1.0`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+---------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer2D_property_autoplay>` | ``false`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+---------------+
|
||||
| :ref:`StringName<class_StringName>` | :ref:`bus<class_AudioStreamPlayer2D_property_bus>` | ``@"Master"`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+---------------+
|
||||
| :ref:`float<class_float>` | :ref:`max_distance<class_AudioStreamPlayer2D_property_max_distance>` | ``2000.0`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+---------------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer2D_property_pitch_scale>` | ``1.0`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+---------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer2D_property_playing>` | ``false`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+---------------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer2D_property_stream>` | |
|
||||
+---------------------------------------+------------------------------------------------------------------------+---------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer2D_property_stream_paused>` | ``false`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+---------------+
|
||||
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioStreamPlayer2D_property_volume_db>` | ``0.0`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+---------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -125,10 +125,10 @@ If ``true``, audio plays when added to scene tree.
|
||||
|
||||
.. _class_AudioStreamPlayer2D_property_bus:
|
||||
|
||||
- :ref:`String<class_String>` **bus**
|
||||
- :ref:`StringName<class_StringName>` **bus**
|
||||
|
||||
+-----------+----------------+
|
||||
| *Default* | ``"Master"`` |
|
||||
| *Default* | ``@"Master"`` |
|
||||
+-----------+----------------+
|
||||
| *Setter* | set_bus(value) |
|
||||
+-----------+----------------+
|
||||
|
||||
@@ -26,45 +26,45 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`int<class_int>` | :ref:`area_mask<class_AudioStreamPlayer3D_property_area_mask>` | ``1`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`attenuation_filter_cutoff_hz<class_AudioStreamPlayer3D_property_attenuation_filter_cutoff_hz>` | ``5000.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`attenuation_filter_db<class_AudioStreamPlayer3D_property_attenuation_filter_db>` | ``-24.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` | :ref:`attenuation_model<class_AudioStreamPlayer3D_property_attenuation_model>` | ``0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer3D_property_autoplay>` | ``false`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer3D_property_bus>` | ``"Master"`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` | :ref:`doppler_tracking<class_AudioStreamPlayer3D_property_doppler_tracking>` | ``0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`emission_angle_degrees<class_AudioStreamPlayer3D_property_emission_angle_degrees>` | ``45.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`emission_angle_enabled<class_AudioStreamPlayer3D_property_emission_angle_enabled>` | ``false`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`emission_angle_filter_attenuation_db<class_AudioStreamPlayer3D_property_emission_angle_filter_attenuation_db>` | ``-12.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`max_db<class_AudioStreamPlayer3D_property_max_db>` | ``3.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`max_distance<class_AudioStreamPlayer3D_property_max_distance>` | ``0.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`OutOfRangeMode<enum_AudioStreamPlayer3D_OutOfRangeMode>` | :ref:`out_of_range_mode<class_AudioStreamPlayer3D_property_out_of_range_mode>` | ``0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer3D_property_pitch_scale>` | ``1.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer3D_property_playing>` | ``false`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer3D_property_stream>` | |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer3D_property_stream_paused>` | ``false`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`unit_db<class_AudioStreamPlayer3D_property_unit_db>` | ``0.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`unit_size<class_AudioStreamPlayer3D_property_unit_size>` | ``1.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
| :ref:`int<class_int>` | :ref:`area_mask<class_AudioStreamPlayer3D_property_area_mask>` | ``1`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
| :ref:`float<class_float>` | :ref:`attenuation_filter_cutoff_hz<class_AudioStreamPlayer3D_property_attenuation_filter_cutoff_hz>` | ``5000.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
| :ref:`float<class_float>` | :ref:`attenuation_filter_db<class_AudioStreamPlayer3D_property_attenuation_filter_db>` | ``-24.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
| :ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` | :ref:`attenuation_model<class_AudioStreamPlayer3D_property_attenuation_model>` | ``0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer3D_property_autoplay>` | ``false`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
| :ref:`StringName<class_StringName>` | :ref:`bus<class_AudioStreamPlayer3D_property_bus>` | ``@"Master"`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
| :ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` | :ref:`doppler_tracking<class_AudioStreamPlayer3D_property_doppler_tracking>` | ``0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
| :ref:`float<class_float>` | :ref:`emission_angle_degrees<class_AudioStreamPlayer3D_property_emission_angle_degrees>` | ``45.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`emission_angle_enabled<class_AudioStreamPlayer3D_property_emission_angle_enabled>` | ``false`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
| :ref:`float<class_float>` | :ref:`emission_angle_filter_attenuation_db<class_AudioStreamPlayer3D_property_emission_angle_filter_attenuation_db>` | ``-12.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
| :ref:`float<class_float>` | :ref:`max_db<class_AudioStreamPlayer3D_property_max_db>` | ``3.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
| :ref:`float<class_float>` | :ref:`max_distance<class_AudioStreamPlayer3D_property_max_distance>` | ``0.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
| :ref:`OutOfRangeMode<enum_AudioStreamPlayer3D_OutOfRangeMode>` | :ref:`out_of_range_mode<class_AudioStreamPlayer3D_property_out_of_range_mode>` | ``0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer3D_property_pitch_scale>` | ``1.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer3D_property_playing>` | ``false`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer3D_property_stream>` | |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer3D_property_stream_paused>` | ``false`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
| :ref:`float<class_float>` | :ref:`unit_db<class_AudioStreamPlayer3D_property_unit_db>` | ``0.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
| :ref:`float<class_float>` | :ref:`unit_size<class_AudioStreamPlayer3D_property_unit_size>` | ``1.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -230,10 +230,10 @@ If ``true``, audio plays when added to scene tree.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_property_bus:
|
||||
|
||||
- :ref:`String<class_String>` **bus**
|
||||
- :ref:`StringName<class_StringName>` **bus**
|
||||
|
||||
+-----------+----------------+
|
||||
| *Default* | ``"Master"`` |
|
||||
| *Default* | ``@"Master"`` |
|
||||
+-----------+----------------+
|
||||
| *Setter* | set_bus(value) |
|
||||
+-----------+----------------+
|
||||
|
||||
@@ -23,21 +23,21 @@ This class can also be used to store dynamically-generated PCM audio data.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-----------------------+
|
||||
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`data<class_AudioStreamSample_property_data>` | ``PoolByteArray( )`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Format<enum_AudioStreamSample_Format>` | :ref:`format<class_AudioStreamSample_property_format>` | ``0`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`loop_begin<class_AudioStreamSample_property_loop_begin>` | ``0`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`loop_end<class_AudioStreamSample_property_loop_end>` | ``0`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-----------------------+
|
||||
| :ref:`LoopMode<enum_AudioStreamSample_LoopMode>` | :ref:`loop_mode<class_AudioStreamSample_property_loop_mode>` | ``0`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`mix_rate<class_AudioStreamSample_property_mix_rate>` | ``44100`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stereo<class_AudioStreamSample_property_stereo>` | ``false`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-----------------------+
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-------------------------+
|
||||
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`data<class_AudioStreamSample_property_data>` | ``PackedByteArray( )`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Format<enum_AudioStreamSample_Format>` | :ref:`format<class_AudioStreamSample_property_format>` | ``0`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`loop_begin<class_AudioStreamSample_property_loop_begin>` | ``0`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`loop_end<class_AudioStreamSample_property_loop_end>` | ``0`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-------------------------+
|
||||
| :ref:`LoopMode<enum_AudioStreamSample_LoopMode>` | :ref:`loop_mode<class_AudioStreamSample_property_loop_mode>` | ``0`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`mix_rate<class_AudioStreamSample_property_mix_rate>` | ``44100`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stereo<class_AudioStreamSample_property_stereo>` | ``false`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -92,15 +92,15 @@ Property Descriptions
|
||||
|
||||
.. _class_AudioStreamSample_property_data:
|
||||
|
||||
- :ref:`PoolByteArray<class_PoolByteArray>` **data**
|
||||
- :ref:`PackedByteArray<class_PackedByteArray>` **data**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | ``PoolByteArray( )`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_data(value) |
|
||||
+-----------+-----------------------+
|
||||
| *Getter* | get_data() |
|
||||
+-----------+-----------------------+
|
||||
+-----------+-------------------------+
|
||||
| *Default* | ``PackedByteArray( )`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_data(value) |
|
||||
+-----------+-------------------------+
|
||||
| *Getter* | get_data() |
|
||||
+-----------+-------------------------+
|
||||
|
||||
Contains the audio data in bytes.
|
||||
|
||||
|
||||
@@ -1,312 +0,0 @@
|
||||
:github_url: hide
|
||||
|
||||
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||
.. DO NOT EDIT THIS FILE, but the BakedLightmap.xml source instead.
|
||||
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||||
|
||||
.. _class_BakedLightmap:
|
||||
|
||||
BakedLightmap
|
||||
=============
|
||||
|
||||
**Inherits:** :ref:`VisualInstance<class_VisualInstance>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
Prerendered indirect light map for a scene.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Baked lightmaps are an alternative workflow for adding indirect (or baked) lighting to a scene. Unlike the :ref:`GIProbe<class_GIProbe>` approach, baked lightmaps work fine on low-end PCs and mobile devices as they consume almost no resources in run-time.
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
|
||||
- :doc:`../tutorials/3d/baked_lightmaps`
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bake_cell_size<class_BakedLightmap_property_bake_cell_size>` | ``0.25`` |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bake_default_texels_per_unit<class_BakedLightmap_property_bake_default_texels_per_unit>` | ``20.0`` |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bake_energy<class_BakedLightmap_property_bake_energy>` | ``1.0`` |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`bake_extents<class_BakedLightmap_property_bake_extents>` | ``Vector3( 10, 10, 10 )`` |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`bake_hdr<class_BakedLightmap_property_bake_hdr>` | ``false`` |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`BakeMode<enum_BakedLightmap_BakeMode>` | :ref:`bake_mode<class_BakedLightmap_property_bake_mode>` | ``0`` |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bake_propagation<class_BakedLightmap_property_bake_propagation>` | ``1.0`` |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`BakeQuality<enum_BakedLightmap_BakeQuality>` | :ref:`bake_quality<class_BakedLightmap_property_bake_quality>` | ``1`` |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`capture_cell_size<class_BakedLightmap_property_capture_cell_size>` | ``0.5`` |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`image_path<class_BakedLightmap_property_image_path>` | ``"."`` |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`BakedLightmapData<class_BakedLightmapData>` | :ref:`light_data<class_BakedLightmap_property_light_data>` | |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`BakeError<enum_BakedLightmap_BakeError>` | :ref:`bake<class_BakedLightmap_method_bake>` **(** :ref:`Node<class_Node>` from_node=null, :ref:`bool<class_bool>` create_visual_debug=false **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`debug_bake<class_BakedLightmap_method_debug_bake>` **(** **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_BakedLightmap_BakeQuality:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_QUALITY_LOW:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_QUALITY_MEDIUM:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_QUALITY_HIGH:
|
||||
|
||||
enum **BakeQuality**:
|
||||
|
||||
- **BAKE_QUALITY_LOW** = **0** --- The lowest bake quality mode. Fastest to calculate.
|
||||
|
||||
- **BAKE_QUALITY_MEDIUM** = **1** --- The default bake quality mode.
|
||||
|
||||
- **BAKE_QUALITY_HIGH** = **2** --- The highest bake quality mode. Takes longer to calculate.
|
||||
|
||||
----
|
||||
|
||||
.. _enum_BakedLightmap_BakeMode:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_MODE_CONE_TRACE:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_MODE_RAY_TRACE:
|
||||
|
||||
enum **BakeMode**:
|
||||
|
||||
- **BAKE_MODE_CONE_TRACE** = **0** --- Less precise but faster bake mode.
|
||||
|
||||
- **BAKE_MODE_RAY_TRACE** = **1** --- More precise bake mode but can take considerably longer to bake.
|
||||
|
||||
----
|
||||
|
||||
.. _enum_BakedLightmap_BakeError:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_ERROR_OK:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_ERROR_NO_SAVE_PATH:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_ERROR_NO_MESHES:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_ERROR_CANT_CREATE_IMAGE:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_ERROR_USER_ABORTED:
|
||||
|
||||
enum **BakeError**:
|
||||
|
||||
- **BAKE_ERROR_OK** = **0**
|
||||
|
||||
- **BAKE_ERROR_NO_SAVE_PATH** = **1**
|
||||
|
||||
- **BAKE_ERROR_NO_MESHES** = **2**
|
||||
|
||||
- **BAKE_ERROR_CANT_CREATE_IMAGE** = **3**
|
||||
|
||||
- **BAKE_ERROR_USER_ABORTED** = **4**
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_BakedLightmap_property_bake_cell_size:
|
||||
|
||||
- :ref:`float<class_float>` **bake_cell_size**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | ``0.25`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_bake_cell_size(value) |
|
||||
+-----------+---------------------------+
|
||||
| *Getter* | get_bake_cell_size() |
|
||||
+-----------+---------------------------+
|
||||
|
||||
Grid subdivision size for lightmapper calculation. The default value will work for most cases. Increase for better lighting on small details or if your scene is very large.
|
||||
|
||||
----
|
||||
|
||||
.. _class_BakedLightmap_property_bake_default_texels_per_unit:
|
||||
|
||||
- :ref:`float<class_float>` **bake_default_texels_per_unit**
|
||||
|
||||
+-----------+-----------------------------------------+
|
||||
| *Default* | ``20.0`` |
|
||||
+-----------+-----------------------------------------+
|
||||
| *Setter* | set_bake_default_texels_per_unit(value) |
|
||||
+-----------+-----------------------------------------+
|
||||
| *Getter* | get_bake_default_texels_per_unit() |
|
||||
+-----------+-----------------------------------------+
|
||||
|
||||
If a :ref:`Mesh.lightmap_size_hint<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**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_energy(value) |
|
||||
+-----------+-------------------+
|
||||
| *Getter* | get_energy() |
|
||||
+-----------+-------------------+
|
||||
|
||||
Multiplies the light sources' intensity by this value. For instance, if the value is set to 2, lights will be twice as bright. If the value is set to 0.5, lights will be half as bright.
|
||||
|
||||
----
|
||||
|
||||
.. _class_BakedLightmap_property_bake_extents:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **bake_extents**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | ``Vector3( 10, 10, 10 )`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_extents(value) |
|
||||
+-----------+---------------------------+
|
||||
| *Getter* | get_extents() |
|
||||
+-----------+---------------------------+
|
||||
|
||||
The size of the affected area.
|
||||
|
||||
----
|
||||
|
||||
.. _class_BakedLightmap_property_bake_hdr:
|
||||
|
||||
- :ref:`bool<class_bool>` **bake_hdr**
|
||||
|
||||
+-----------+----------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+----------------+
|
||||
| *Setter* | set_hdr(value) |
|
||||
+-----------+----------------+
|
||||
| *Getter* | is_hdr() |
|
||||
+-----------+----------------+
|
||||
|
||||
If ``true``, the lightmap can capture light values greater than ``1.0``. Turning this off will result in a smaller file size.
|
||||
|
||||
----
|
||||
|
||||
.. _class_BakedLightmap_property_bake_mode:
|
||||
|
||||
- :ref:`BakeMode<enum_BakedLightmap_BakeMode>` **bake_mode**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_bake_mode(value) |
|
||||
+-----------+----------------------+
|
||||
| *Getter* | get_bake_mode() |
|
||||
+-----------+----------------------+
|
||||
|
||||
Lightmapping mode. See :ref:`BakeMode<enum_BakedLightmap_BakeMode>`.
|
||||
|
||||
----
|
||||
|
||||
.. _class_BakedLightmap_property_bake_propagation:
|
||||
|
||||
- :ref:`float<class_float>` **bake_propagation**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_propagation(value) |
|
||||
+-----------+------------------------+
|
||||
| *Getter* | get_propagation() |
|
||||
+-----------+------------------------+
|
||||
|
||||
Defines how far the light will travel before it is no longer effective. The higher the number, the farther the light will travel. For instance, if the value is set to 2, the light will go twice as far. If the value is set to 0.5, the light will only go half as far.
|
||||
|
||||
----
|
||||
|
||||
.. _class_BakedLightmap_property_bake_quality:
|
||||
|
||||
- :ref:`BakeQuality<enum_BakedLightmap_BakeQuality>` **bake_quality**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | ``1`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_bake_quality(value) |
|
||||
+-----------+-------------------------+
|
||||
| *Getter* | get_bake_quality() |
|
||||
+-----------+-------------------------+
|
||||
|
||||
Three quality modes are available. Higher quality requires more rendering time. See :ref:`BakeQuality<enum_BakedLightmap_BakeQuality>`.
|
||||
|
||||
----
|
||||
|
||||
.. _class_BakedLightmap_property_capture_cell_size:
|
||||
|
||||
- :ref:`float<class_float>` **capture_cell_size**
|
||||
|
||||
+-----------+------------------------------+
|
||||
| *Default* | ``0.5`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_capture_cell_size(value) |
|
||||
+-----------+------------------------------+
|
||||
| *Getter* | get_capture_cell_size() |
|
||||
+-----------+------------------------------+
|
||||
|
||||
Grid size used for real-time capture information on dynamic objects. Cannot be larger than :ref:`bake_cell_size<class_BakedLightmap_property_bake_cell_size>`.
|
||||
|
||||
----
|
||||
|
||||
.. _class_BakedLightmap_property_image_path:
|
||||
|
||||
- :ref:`String<class_String>` **image_path**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | ``"."`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_image_path(value) |
|
||||
+-----------+-----------------------+
|
||||
| *Getter* | get_image_path() |
|
||||
+-----------+-----------------------+
|
||||
|
||||
The location where lightmaps will be saved.
|
||||
|
||||
----
|
||||
|
||||
.. _class_BakedLightmap_property_light_data:
|
||||
|
||||
- :ref:`BakedLightmapData<class_BakedLightmapData>` **light_data**
|
||||
|
||||
+----------+-----------------------+
|
||||
| *Setter* | set_light_data(value) |
|
||||
+----------+-----------------------+
|
||||
| *Getter* | get_light_data() |
|
||||
+----------+-----------------------+
|
||||
|
||||
The calculated light data.
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_BakedLightmap_method_bake:
|
||||
|
||||
- :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.
|
||||
|
||||
@@ -1,147 +0,0 @@
|
||||
:github_url: hide
|
||||
|
||||
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||
.. DO NOT EDIT THIS FILE, but the BakedLightmapData.xml source instead.
|
||||
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||||
|
||||
.. _class_BakedLightmapData:
|
||||
|
||||
BakedLightmapData
|
||||
=================
|
||||
|
||||
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`bounds<class_BakedLightmapData_property_bounds>` | ``AABB( 0, 0, 0, 0, 0, 0 )`` |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`Transform<class_Transform>` | :ref:`cell_space_transform<class_BakedLightmapData_property_cell_space_transform>` | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`cell_subdiv<class_BakedLightmapData_property_cell_subdiv>` | ``1`` |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`energy<class_BakedLightmapData_property_energy>` | ``1.0`` |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`octree<class_BakedLightmapData_property_octree>` | ``PoolByteArray( )`` |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_user<class_BakedLightmapData_method_add_user>` **(** :ref:`NodePath<class_NodePath>` path, :ref:`Texture<class_Texture>` lightmap, :ref:`int<class_int>` instance **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_users<class_BakedLightmapData_method_clear_users>` **(** **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_user_count<class_BakedLightmapData_method_get_user_count>` **(** **)** const |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`get_user_lightmap<class_BakedLightmapData_method_get_user_lightmap>` **(** :ref:`int<class_int>` user_idx **)** const |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`get_user_path<class_BakedLightmapData_method_get_user_path>` **(** :ref:`int<class_int>` user_idx **)** const |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_BakedLightmapData_property_bounds:
|
||||
|
||||
- :ref:`AABB<class_AABB>` **bounds**
|
||||
|
||||
+-----------+------------------------------+
|
||||
| *Default* | ``AABB( 0, 0, 0, 0, 0, 0 )`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_bounds(value) |
|
||||
+-----------+------------------------------+
|
||||
| *Getter* | get_bounds() |
|
||||
+-----------+------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. _class_BakedLightmapData_property_cell_space_transform:
|
||||
|
||||
- :ref:`Transform<class_Transform>` **cell_space_transform**
|
||||
|
||||
+-----------+-----------------------------------------------------+
|
||||
| *Default* | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` |
|
||||
+-----------+-----------------------------------------------------+
|
||||
| *Setter* | set_cell_space_transform(value) |
|
||||
+-----------+-----------------------------------------------------+
|
||||
| *Getter* | get_cell_space_transform() |
|
||||
+-----------+-----------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. _class_BakedLightmapData_property_cell_subdiv:
|
||||
|
||||
- :ref:`int<class_int>` **cell_subdiv**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | ``1`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_cell_subdiv(value) |
|
||||
+-----------+------------------------+
|
||||
| *Getter* | get_cell_subdiv() |
|
||||
+-----------+------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. _class_BakedLightmapData_property_energy:
|
||||
|
||||
- :ref:`float<class_float>` **energy**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_energy(value) |
|
||||
+-----------+-------------------+
|
||||
| *Getter* | get_energy() |
|
||||
+-----------+-------------------+
|
||||
|
||||
----
|
||||
|
||||
.. _class_BakedLightmapData_property_octree:
|
||||
|
||||
- :ref:`PoolByteArray<class_PoolByteArray>` **octree**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | ``PoolByteArray( )`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_octree(value) |
|
||||
+-----------+-----------------------+
|
||||
| *Getter* | get_octree() |
|
||||
+-----------+-----------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_BakedLightmapData_method_add_user:
|
||||
|
||||
- void **add_user** **(** :ref:`NodePath<class_NodePath>` path, :ref:`Texture<class_Texture>` lightmap, :ref:`int<class_int>` instance **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_BakedLightmapData_method_clear_users:
|
||||
|
||||
- void **clear_users** **(** **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_BakedLightmapData_method_get_user_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_user_count** **(** **)** const
|
||||
|
||||
----
|
||||
|
||||
.. _class_BakedLightmapData_method_get_user_lightmap:
|
||||
|
||||
- :ref:`Texture<class_Texture>` **get_user_lightmap** **(** :ref:`int<class_int>` user_idx **)** const
|
||||
|
||||
----
|
||||
|
||||
.. _class_BakedLightmapData_method_get_user_path:
|
||||
|
||||
- :ref:`NodePath<class_NodePath>` **get_user_path** **(** :ref:`int<class_int>` user_idx **)** const
|
||||
|
||||
2326
classes/class_basematerial3d.rst
Normal file
2326
classes/class_basematerial3d.rst
Normal file
File diff suppressed because it is too large
Load Diff
@@ -58,7 +58,7 @@ Methods
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`inverse<class_Basis_method_inverse>` **(** **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_equal_approx<class_Basis_method_is_equal_approx>` **(** :ref:`Basis<class_Basis>` b, :ref:`float<class_float>` epsilon=0.00001 **)** |
|
||||
| :ref:`bool<class_bool>` | :ref:`is_equal_approx<class_Basis_method_is_equal_approx>` **(** :ref:`Basis<class_Basis>` b, :ref:`float<class_float>` epsilon=1e-05 **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`orthonormalized<class_Basis_method_orthonormalized>` **(** **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -216,7 +216,7 @@ Returns the inverse of the matrix.
|
||||
|
||||
.. _class_Basis_method_is_equal_approx:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_equal_approx** **(** :ref:`Basis<class_Basis>` b, :ref:`float<class_float>` epsilon=0.00001 **)**
|
||||
- :ref:`bool<class_bool>` **is_equal_approx** **(** :ref:`Basis<class_Basis>` b, :ref:`float<class_float>` epsilon=1e-05 **)**
|
||||
|
||||
Returns ``true`` if this basis and ``b`` are approximately equal, by calling ``is_equal_approx`` on each component.
|
||||
|
||||
|
||||
@@ -41,7 +41,7 @@ Methods
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_kerning_pair<class_BitmapFont_method_add_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b, :ref:`int<class_int>` kerning **)** |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_texture<class_BitmapFont_method_add_texture>` **(** :ref:`Texture<class_Texture>` texture **)** |
|
||||
| void | :ref:`add_texture<class_BitmapFont_method_add_texture>` **(** :ref:`Texture2D<class_Texture2D>` texture **)** |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_BitmapFont_method_clear>` **(** **)** |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -51,7 +51,7 @@ Methods
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_kerning_pair<class_BitmapFont_method_get_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`get_texture<class_BitmapFont_method_get_texture>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`get_texture<class_BitmapFont_method_get_texture>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_texture_count<class_BitmapFont_method_get_texture_count>` **(** **)** const |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -140,7 +140,7 @@ Adds a kerning pair to the ``BitmapFont`` as a difference. Kerning pairs are spe
|
||||
|
||||
.. _class_BitmapFont_method_add_texture:
|
||||
|
||||
- void **add_texture** **(** :ref:`Texture<class_Texture>` texture **)**
|
||||
- void **add_texture** **(** :ref:`Texture2D<class_Texture2D>` texture **)**
|
||||
|
||||
Adds a texture to the ``BitmapFont``.
|
||||
|
||||
@@ -180,7 +180,7 @@ Returns a kerning pair as a difference.
|
||||
|
||||
.. _class_BitmapFont_method_get_texture:
|
||||
|
||||
- :ref:`Texture<class_Texture>` **get_texture** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Returns the font atlas texture at index ``idx``.
|
||||
|
||||
|
||||
@@ -18,16 +18,14 @@ Base class for box containers.
|
||||
Description
|
||||
-----------
|
||||
|
||||
Arranges child controls vertically or horizontally, and rearranges the controls automatically when their minimum size changes.
|
||||
Arranges child :ref:`Control<class_Control>` nodes vertically or horizontally, and rearranges them automatically when their minimum size changes.
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------+---------------------------------------------------------+--------------+
|
||||
| :ref:`AlignMode<enum_BoxContainer_AlignMode>` | :ref:`alignment<class_BoxContainer_property_alignment>` | ``0`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------+--------------+
|
||||
| :ref:`MouseFilter<enum_Control_MouseFilter>` | mouse_filter | **O:** ``1`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------+--------------+
|
||||
+-----------------------------------------------+---------------------------------------------------------+-------+
|
||||
| :ref:`AlignMode<enum_BoxContainer_AlignMode>` | :ref:`alignment<class_BoxContainer_property_alignment>` | ``0`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------+-------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -70,7 +68,7 @@ Property Descriptions
|
||||
| *Getter* | get_alignment() |
|
||||
+-----------+----------------------+
|
||||
|
||||
The alignment of the container's children (must be one of :ref:`ALIGN_BEGIN<class_BoxContainer_constant_ALIGN_BEGIN>`, :ref:`ALIGN_CENTER<class_BoxContainer_constant_ALIGN_CENTER>` or :ref:`ALIGN_END<class_BoxContainer_constant_ALIGN_END>`).
|
||||
The alignment of the container's children (must be one of :ref:`ALIGN_BEGIN<class_BoxContainer_constant_ALIGN_BEGIN>`, :ref:`ALIGN_CENTER<class_BoxContainer_constant_ALIGN_CENTER>`, or :ref:`ALIGN_END<class_BoxContainer_constant_ALIGN_END>`).
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
@@ -79,5 +77,5 @@ Method Descriptions
|
||||
|
||||
- void **add_spacer** **(** :ref:`bool<class_bool>` begin **)**
|
||||
|
||||
Adds a control to the box as a spacer. If ``true``, ``begin`` will insert the spacer control in front of other children.
|
||||
Adds a :ref:`Control<class_Control>` node to the box as a spacer. If ``begin`` is ``true``, it will insert the :ref:`Control<class_Control>` node in front of all other children.
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ Properties
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flat<class_Button_property_flat>` | ``false`` |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`icon<class_Button_property_icon>` | |
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`icon<class_Button_property_icon>` | |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`String<class_String>` | :ref:`text<class_Button_property_text>` | ``""`` |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
@@ -152,7 +152,7 @@ Flat buttons don't display decoration.
|
||||
|
||||
.. _class_Button_property_icon:
|
||||
|
||||
- :ref:`Texture<class_Texture>` **icon**
|
||||
- :ref:`Texture2D<class_Texture2D>` **icon**
|
||||
|
||||
+----------+------------------------+
|
||||
| *Setter* | set_button_icon(value) |
|
||||
|
||||
128
classes/class_callable.rst
Normal file
128
classes/class_callable.rst
Normal file
@@ -0,0 +1,128 @@
|
||||
:github_url: hide
|
||||
|
||||
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||
.. DO NOT EDIT THIS FILE, but the Callable.xml source instead.
|
||||
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||||
|
||||
.. _class_Callable:
|
||||
|
||||
Callable
|
||||
========
|
||||
|
||||
An object representing a method in a certain object that can be called.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
``Callable`` is a first class object which can be held in variables and passed to functions. It represents a given method in an :ref:`Object<class_Object>`, and is typically used for signal callbacks.
|
||||
|
||||
**Example:**
|
||||
|
||||
::
|
||||
|
||||
var callable = Callable(self, "print_args")
|
||||
func print_args(arg1, arg2, arg3 = ""):
|
||||
prints(arg1, arg2, arg3)
|
||||
func test():
|
||||
callable.call("hello", "world") # Prints "hello world".
|
||||
callable.call(Vector2.UP, 42, callable) # Prints "(0, -1) 42 Node(Node.gd)::print_args".
|
||||
callable.call("invalid") # Invalid call, should have at least 2 arguments.
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Callable<class_Callable>` | :ref:`Callable<class_Callable_method_Callable>` **(** :ref:`Object<class_Object>` object, :ref:`StringName<class_StringName>` method_name **)** |
|
||||
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`call<class_Callable_method_call>` **(** ... **)** vararg |
|
||||
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`call_deferred<class_Callable_method_call_deferred>` **(** ... **)** vararg |
|
||||
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`StringName<class_StringName>` | :ref:`get_method<class_Callable_method_get_method>` **(** **)** |
|
||||
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_Object>` | :ref:`get_object<class_Callable_method_get_object>` **(** **)** |
|
||||
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_object_id<class_Callable_method_get_object_id>` **(** **)** |
|
||||
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`hash<class_Callable_method_hash>` **(** **)** |
|
||||
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_custom<class_Callable_method_is_custom>` **(** **)** |
|
||||
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_null<class_Callable_method_is_null>` **(** **)** |
|
||||
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_standard<class_Callable_method_is_standard>` **(** **)** |
|
||||
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_Callable_method_Callable:
|
||||
|
||||
- :ref:`Callable<class_Callable>` **Callable** **(** :ref:`Object<class_Object>` object, :ref:`StringName<class_StringName>` method_name **)**
|
||||
|
||||
Creates a new ``Callable`` for the method called ``method_name`` in the specified ``object``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Callable_method_call:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **call** **(** ... **)** vararg
|
||||
|
||||
Calls the method represented by this ``Callable``. Arguments can be passed and should match the method's signature.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Callable_method_call_deferred:
|
||||
|
||||
- void **call_deferred** **(** ... **)** vararg
|
||||
|
||||
Calls the method represented by this ``Callable`` in deferred mode, i.e. during the idle frame. Arguments can be passed and should match the method's signature.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Callable_method_get_method:
|
||||
|
||||
- :ref:`StringName<class_StringName>` **get_method** **(** **)**
|
||||
|
||||
Returns the name of the method represented by this ``Callable``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Callable_method_get_object:
|
||||
|
||||
- :ref:`Object<class_Object>` **get_object** **(** **)**
|
||||
|
||||
Returns the object on which this ``Callable`` is called.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Callable_method_get_object_id:
|
||||
|
||||
- :ref:`int<class_int>` **get_object_id** **(** **)**
|
||||
|
||||
Returns the ID of this ``Callable``'s object (see :ref:`Object.get_instance_id<class_Object_method_get_instance_id>`).
|
||||
|
||||
----
|
||||
|
||||
.. _class_Callable_method_hash:
|
||||
|
||||
- :ref:`int<class_int>` **hash** **(** **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_Callable_method_is_custom:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_custom** **(** **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_Callable_method_is_null:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_null** **(** **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_Callable_method_is_standard:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_standard** **(** **)**
|
||||
|
||||
@@ -30,6 +30,8 @@ Properties
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+---------------------+
|
||||
| :ref:`DopplerTracking<enum_Camera_DopplerTracking>` | :ref:`doppler_tracking<class_Camera_property_doppler_tracking>` | ``0`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+---------------------+
|
||||
| :ref:`CameraEffects<class_CameraEffects>` | :ref:`effects<class_Camera_property_effects>` | |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+---------------------+
|
||||
| :ref:`Environment<class_Environment>` | :ref:`environment<class_Camera_property_environment>` | |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`far<class_Camera_property_far>` | ``100.0`` |
|
||||
@@ -190,6 +192,18 @@ If not :ref:`DOPPLER_TRACKING_DISABLED<class_Camera_constant_DOPPLER_TRACKING_DI
|
||||
|
||||
----
|
||||
|
||||
.. _class_Camera_property_effects:
|
||||
|
||||
- :ref:`CameraEffects<class_CameraEffects>` **effects**
|
||||
|
||||
+----------+--------------------+
|
||||
| *Setter* | set_effects(value) |
|
||||
+----------+--------------------+
|
||||
| *Getter* | get_effects() |
|
||||
+----------+--------------------+
|
||||
|
||||
----
|
||||
|
||||
.. _class_Camera_property_environment:
|
||||
|
||||
- :ref:`Environment<class_Environment>` **environment**
|
||||
|
||||
165
classes/class_cameraeffects.rst
Normal file
165
classes/class_cameraeffects.rst
Normal file
@@ -0,0 +1,165 @@
|
||||
:github_url: hide
|
||||
|
||||
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||
.. DO NOT EDIT THIS FILE, but the CameraEffects.xml source instead.
|
||||
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||||
|
||||
.. _class_CameraEffects:
|
||||
|
||||
CameraEffects
|
||||
=============
|
||||
|
||||
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+----------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`dof_blur_amount<class_CameraEffects_property_dof_blur_amount>` | ``0.1`` |
|
||||
+---------------------------+----------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`dof_blur_far_distance<class_CameraEffects_property_dof_blur_far_distance>` | ``10.0`` |
|
||||
+---------------------------+----------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`dof_blur_far_enabled<class_CameraEffects_property_dof_blur_far_enabled>` | ``false`` |
|
||||
+---------------------------+----------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`dof_blur_far_transition<class_CameraEffects_property_dof_blur_far_transition>` | ``5.0`` |
|
||||
+---------------------------+----------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`dof_blur_near_distance<class_CameraEffects_property_dof_blur_near_distance>` | ``2.0`` |
|
||||
+---------------------------+----------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`dof_blur_near_enabled<class_CameraEffects_property_dof_blur_near_enabled>` | ``false`` |
|
||||
+---------------------------+----------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`dof_blur_near_transition<class_CameraEffects_property_dof_blur_near_transition>` | ``1.0`` |
|
||||
+---------------------------+----------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`override_exposure<class_CameraEffects_property_override_exposure>` | ``1.0`` |
|
||||
+---------------------------+----------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`override_exposure_enable<class_CameraEffects_property_override_exposure_enable>` | ``false`` |
|
||||
+---------------------------+----------------------------------------------------------------------------------------+-----------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CameraEffects_property_dof_blur_amount:
|
||||
|
||||
- :ref:`float<class_float>` **dof_blur_amount**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | ``0.1`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_dof_blur_amount(value) |
|
||||
+-----------+----------------------------+
|
||||
| *Getter* | get_dof_blur_amount() |
|
||||
+-----------+----------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. _class_CameraEffects_property_dof_blur_far_distance:
|
||||
|
||||
- :ref:`float<class_float>` **dof_blur_far_distance**
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| *Default* | ``10.0`` |
|
||||
+-----------+----------------------------------+
|
||||
| *Setter* | set_dof_blur_far_distance(value) |
|
||||
+-----------+----------------------------------+
|
||||
| *Getter* | get_dof_blur_far_distance() |
|
||||
+-----------+----------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. _class_CameraEffects_property_dof_blur_far_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **dof_blur_far_enabled**
|
||||
|
||||
+-----------+---------------------------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------------------+
|
||||
| *Setter* | set_dof_blur_far_enabled(value) |
|
||||
+-----------+---------------------------------+
|
||||
| *Getter* | is_dof_blur_far_enabled() |
|
||||
+-----------+---------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. _class_CameraEffects_property_dof_blur_far_transition:
|
||||
|
||||
- :ref:`float<class_float>` **dof_blur_far_transition**
|
||||
|
||||
+-----------+------------------------------------+
|
||||
| *Default* | ``5.0`` |
|
||||
+-----------+------------------------------------+
|
||||
| *Setter* | set_dof_blur_far_transition(value) |
|
||||
+-----------+------------------------------------+
|
||||
| *Getter* | get_dof_blur_far_transition() |
|
||||
+-----------+------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. _class_CameraEffects_property_dof_blur_near_distance:
|
||||
|
||||
- :ref:`float<class_float>` **dof_blur_near_distance**
|
||||
|
||||
+-----------+-----------------------------------+
|
||||
| *Default* | ``2.0`` |
|
||||
+-----------+-----------------------------------+
|
||||
| *Setter* | set_dof_blur_near_distance(value) |
|
||||
+-----------+-----------------------------------+
|
||||
| *Getter* | get_dof_blur_near_distance() |
|
||||
+-----------+-----------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. _class_CameraEffects_property_dof_blur_near_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **dof_blur_near_enabled**
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+----------------------------------+
|
||||
| *Setter* | set_dof_blur_near_enabled(value) |
|
||||
+-----------+----------------------------------+
|
||||
| *Getter* | is_dof_blur_near_enabled() |
|
||||
+-----------+----------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. _class_CameraEffects_property_dof_blur_near_transition:
|
||||
|
||||
- :ref:`float<class_float>` **dof_blur_near_transition**
|
||||
|
||||
+-----------+-------------------------------------+
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-------------------------------------+
|
||||
| *Setter* | set_dof_blur_near_transition(value) |
|
||||
+-----------+-------------------------------------+
|
||||
| *Getter* | get_dof_blur_near_transition() |
|
||||
+-----------+-------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. _class_CameraEffects_property_override_exposure:
|
||||
|
||||
- :ref:`float<class_float>` **override_exposure**
|
||||
|
||||
+-----------+------------------------------+
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_override_exposure(value) |
|
||||
+-----------+------------------------------+
|
||||
| *Getter* | get_override_exposure() |
|
||||
+-----------+------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. _class_CameraEffects_property_override_exposure_enable:
|
||||
|
||||
- :ref:`bool<class_bool>` **override_exposure_enable**
|
||||
|
||||
+-----------+--------------------------------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------------------------------+
|
||||
| *Setter* | set_override_exposure_enabled(value) |
|
||||
+-----------+--------------------------------------+
|
||||
| *Getter* | is_override_exposure_enabled() |
|
||||
+-----------+--------------------------------------+
|
||||
|
||||
@@ -20,122 +20,3 @@ A camera feed gives you access to a single physical camera attached to your devi
|
||||
|
||||
**Note:** Many cameras will return YCbCr images which are split into two textures and need to be combined in a shader. Godot does this automatically for you if you set the environment to show the camera image in the background.
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------------+-----------------------------------------------------------------+--------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`feed_is_active<class_CameraFeed_property_feed_is_active>` | ``false`` |
|
||||
+---------------------------------------+-----------------------------------------------------------------+--------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`feed_transform<class_CameraFeed_property_feed_transform>` | ``Transform2D( 1, 0, 0, -1, 0, 1 )`` |
|
||||
+---------------------------------------+-----------------------------------------------------------------+--------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_id<class_CameraFeed_method_get_id>` **(** **)** const |
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_name<class_CameraFeed_method_get_name>` **(** **)** const |
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`FeedPosition<enum_CameraFeed_FeedPosition>` | :ref:`get_position<class_CameraFeed_method_get_position>` **(** **)** const |
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_CameraFeed_FeedDataType:
|
||||
|
||||
.. _class_CameraFeed_constant_FEED_NOIMAGE:
|
||||
|
||||
.. _class_CameraFeed_constant_FEED_RGB:
|
||||
|
||||
.. _class_CameraFeed_constant_FEED_YCBCR:
|
||||
|
||||
.. _class_CameraFeed_constant_FEED_YCBCR_SEP:
|
||||
|
||||
enum **FeedDataType**:
|
||||
|
||||
- **FEED_NOIMAGE** = **0** --- No image set for the feed.
|
||||
|
||||
- **FEED_RGB** = **1** --- Feed supplies RGB images.
|
||||
|
||||
- **FEED_YCBCR** = **2** --- Feed supplies YCbCr images that need to be converted to RGB.
|
||||
|
||||
- **FEED_YCBCR_SEP** = **3** --- Feed supplies separate Y and CbCr images that need to be combined and converted to RGB.
|
||||
|
||||
----
|
||||
|
||||
.. _enum_CameraFeed_FeedPosition:
|
||||
|
||||
.. _class_CameraFeed_constant_FEED_UNSPECIFIED:
|
||||
|
||||
.. _class_CameraFeed_constant_FEED_FRONT:
|
||||
|
||||
.. _class_CameraFeed_constant_FEED_BACK:
|
||||
|
||||
enum **FeedPosition**:
|
||||
|
||||
- **FEED_UNSPECIFIED** = **0** --- Unspecified position.
|
||||
|
||||
- **FEED_FRONT** = **1** --- Camera is mounted at the front of the device.
|
||||
|
||||
- **FEED_BACK** = **2** --- Camera is mounted at the back of the device.
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CameraFeed_property_feed_is_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **feed_is_active**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_active(value) |
|
||||
+-----------+-------------------+
|
||||
| *Getter* | is_active() |
|
||||
+-----------+-------------------+
|
||||
|
||||
If ``true``, the feed is active.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CameraFeed_property_feed_transform:
|
||||
|
||||
- :ref:`Transform2D<class_Transform2D>` **feed_transform**
|
||||
|
||||
+-----------+--------------------------------------+
|
||||
| *Default* | ``Transform2D( 1, 0, 0, -1, 0, 1 )`` |
|
||||
+-----------+--------------------------------------+
|
||||
| *Setter* | set_transform(value) |
|
||||
+-----------+--------------------------------------+
|
||||
| *Getter* | get_transform() |
|
||||
+-----------+--------------------------------------+
|
||||
|
||||
The transform applied to the camera's image.
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_CameraFeed_method_get_id:
|
||||
|
||||
- :ref:`int<class_int>` **get_id** **(** **)** const
|
||||
|
||||
Returns the unique ID for this feed.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CameraFeed_method_get_name:
|
||||
|
||||
- :ref:`String<class_String>` **get_name** **(** **)** const
|
||||
|
||||
Returns the camera's name.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CameraFeed_method_get_position:
|
||||
|
||||
- :ref:`FeedPosition<enum_CameraFeed_FeedPosition>` **get_position** **(** **)** const
|
||||
|
||||
Returns the position of camera on the device.
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
CameraTexture
|
||||
=============
|
||||
|
||||
**Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
**Inherits:** :ref:`Texture2D<class_Texture2D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
Texture provided by a :ref:`CameraFeed<class_CameraFeed>`.
|
||||
|
||||
@@ -23,15 +23,13 @@ This texture gives access to the camera texture provided by a :ref:`CameraFeed<c
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`int<class_int>` | :ref:`camera_feed_id<class_CameraTexture_property_camera_feed_id>` | ``0`` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`camera_is_active<class_CameraTexture_property_camera_is_active>` | ``false`` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`int<class_int>` | flags | **O:** ``0`` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`FeedImage<enum_CameraServer_FeedImage>` | :ref:`which_feed<class_CameraTexture_property_which_feed>` | ``0`` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+-----------+
|
||||
| :ref:`int<class_int>` | :ref:`camera_feed_id<class_CameraTexture_property_camera_feed_id>` | ``0`` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`camera_is_active<class_CameraTexture_property_camera_is_active>` | ``false`` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+-----------+
|
||||
| :ref:`FeedImage<enum_CameraServer_FeedImage>` | :ref:`which_feed<class_CameraTexture_property_which_feed>` | ``0`` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+-----------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
@@ -38,120 +38,124 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`light_mask<class_CanvasItem_property_light_mask>` | ``1`` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :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 )`` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`self_modulate<class_CanvasItem_property_self_modulate>` | ``Color( 1, 1, 1, 1 )`` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`show_behind_parent<class_CanvasItem_property_show_behind_parent>` | ``false`` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`show_on_top<class_CanvasItem_property_show_on_top>` | |
|
||||
+---------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`use_parent_material<class_CanvasItem_property_use_parent_material>` | ``false`` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`visible<class_CanvasItem_property_visible>` | ``true`` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`light_mask<class_CanvasItem_property_light_mask>` | ``1`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :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 )`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`self_modulate<class_CanvasItem_property_self_modulate>` | ``Color( 1, 1, 1, 1 )`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`show_behind_parent<class_CanvasItem_property_show_behind_parent>` | ``false`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`show_on_top<class_CanvasItem_property_show_on_top>` | |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` | :ref:`texture_filter<class_CanvasItem_property_texture_filter>` | ``0`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` | :ref:`texture_repeat<class_CanvasItem_property_texture_repeat>` | ``0`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`use_parent_material<class_CanvasItem_property_use_parent_material>` | ``false`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`visible<class_CanvasItem_property_visible>` | ``true`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_draw<class_CanvasItem_method__draw>` **(** **)** virtual |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_arc<class_CanvasItem_method_draw_arc>` **(** :ref:`Vector2<class_Vector2>` center, :ref:`float<class_float>` radius, :ref:`float<class_float>` start_angle, :ref:`float<class_float>` end_angle, :ref:`int<class_int>` point_count, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`draw_char<class_CanvasItem_method_draw_char>` **(** :ref:`Font<class_Font>` font, :ref:`Vector2<class_Vector2>` position, :ref:`String<class_String>` char, :ref:`String<class_String>` next, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ) **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_circle<class_CanvasItem_method_draw_circle>` **(** :ref:`Vector2<class_Vector2>` position, :ref:`float<class_float>` radius, :ref:`Color<class_Color>` color **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_colored_polygon<class_CanvasItem_method_draw_colored_polygon>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs=PoolVector2Array( ), :ref:`Texture<class_Texture>` texture=null, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_line<class_CanvasItem_method_draw_line>` **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_mesh<class_CanvasItem_method_draw_mesh>` **(** :ref:`Mesh<class_Mesh>` mesh, :ref:`Texture<class_Texture>` texture, :ref:`Texture<class_Texture>` normal_map=null, :ref:`Transform2D<class_Transform2D>` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ) **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_multiline<class_CanvasItem_method_draw_multiline>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_multiline_colors<class_CanvasItem_method_draw_multiline_colors>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_multimesh<class_CanvasItem_method_draw_multimesh>` **(** :ref:`MultiMesh<class_MultiMesh>` multimesh, :ref:`Texture<class_Texture>` texture, :ref:`Texture<class_Texture>` normal_map=null **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_polygon<class_CanvasItem_method_draw_polygon>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs=PoolVector2Array( ), :ref:`Texture<class_Texture>` texture=null, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_polyline<class_CanvasItem_method_draw_polyline>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_polyline_colors<class_CanvasItem_method_draw_polyline_colors>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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, :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 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_set_transform_matrix<class_CanvasItem_method_draw_set_transform_matrix>` **(** :ref:`Transform2D<class_Transform2D>` xform **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_string<class_CanvasItem_method_draw_string>` **(** :ref:`Font<class_Font>` font, :ref:`Vector2<class_Vector2>` position, :ref:`String<class_String>` text, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`int<class_int>` clip_w=-1 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_style_box<class_CanvasItem_method_draw_style_box>` **(** :ref:`StyleBox<class_StyleBox>` style_box, :ref:`Rect2<class_Rect2>` rect **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_texture<class_CanvasItem_method_draw_texture>` **(** :ref:`Texture<class_Texture>` texture, :ref:`Vector2<class_Vector2>` position, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture<class_Texture>` normal_map=null **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_texture_rect<class_CanvasItem_method_draw_texture_rect>` **(** :ref:`Texture<class_Texture>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` tile, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_texture_rect_region<class_CanvasItem_method_draw_texture_rect_region>` **(** :ref:`Texture<class_Texture>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` clip_uv=true **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`force_update_transform<class_CanvasItem_method_force_update_transform>` **(** **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_RID>` | :ref:`get_canvas<class_CanvasItem_method_get_canvas>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_RID>` | :ref:`get_canvas_item<class_CanvasItem_method_get_canvas_item>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_canvas_transform<class_CanvasItem_method_get_canvas_transform>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_global_mouse_position<class_CanvasItem_method_get_global_mouse_position>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_global_transform<class_CanvasItem_method_get_global_transform>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_global_transform_with_canvas<class_CanvasItem_method_get_global_transform_with_canvas>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_local_mouse_position<class_CanvasItem_method_get_local_mouse_position>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_transform<class_CanvasItem_method_get_transform>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`get_viewport_rect<class_CanvasItem_method_get_viewport_rect>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_viewport_transform<class_CanvasItem_method_get_viewport_transform>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`World2D<class_World2D>` | :ref:`get_world_2d<class_CanvasItem_method_get_world_2d>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`hide<class_CanvasItem_method_hide>` **(** **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_local_transform_notification_enabled<class_CanvasItem_method_is_local_transform_notification_enabled>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_set_as_toplevel<class_CanvasItem_method_is_set_as_toplevel>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_transform_notification_enabled<class_CanvasItem_method_is_transform_notification_enabled>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_visible_in_tree<class_CanvasItem_method_is_visible_in_tree>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`make_canvas_position_local<class_CanvasItem_method_make_canvas_position_local>` **(** :ref:`Vector2<class_Vector2>` screen_point **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`InputEvent<class_InputEvent>` | :ref:`make_input_local<class_CanvasItem_method_make_input_local>` **(** :ref:`InputEvent<class_InputEvent>` event **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_as_toplevel<class_CanvasItem_method_set_as_toplevel>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_notify_local_transform<class_CanvasItem_method_set_notify_local_transform>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_notify_transform<class_CanvasItem_method_set_notify_transform>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`show<class_CanvasItem_method_show>` **(** **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`update<class_CanvasItem_method_update>` **(** **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_draw<class_CanvasItem_method__draw>` **(** **)** virtual |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_arc<class_CanvasItem_method_draw_arc>` **(** :ref:`Vector2<class_Vector2>` center, :ref:`float<class_float>` radius, :ref:`float<class_float>` start_angle, :ref:`float<class_float>` end_angle, :ref:`int<class_int>` point_count, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`draw_char<class_CanvasItem_method_draw_char>` **(** :ref:`Font<class_Font>` font, :ref:`Vector2<class_Vector2>` position, :ref:`String<class_String>` char, :ref:`String<class_String>` next, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ) **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_circle<class_CanvasItem_method_draw_circle>` **(** :ref:`Vector2<class_Vector2>` position, :ref:`float<class_float>` radius, :ref:`Color<class_Color>` color **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_colored_polygon<class_CanvasItem_method_draw_colored_polygon>` **(** :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs=PackedVector2Array( ), :ref:`Texture2D<class_Texture2D>` texture=null, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` texture_filter=0, :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` texture_repeat=0 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_line<class_CanvasItem_method_draw_line>` **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_mesh<class_CanvasItem_method_draw_mesh>` **(** :ref:`Mesh<class_Mesh>` mesh, :ref:`Texture2D<class_Texture2D>` texture, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`Transform2D<class_Transform2D>` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` texture_filter=0, :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` texture_repeat=0 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_multiline<class_CanvasItem_method_draw_multiline>` **(** :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_multiline_colors<class_CanvasItem_method_draw_multiline_colors>` **(** :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`float<class_float>` width=1.0 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_multimesh<class_CanvasItem_method_draw_multimesh>` **(** :ref:`MultiMesh<class_MultiMesh>` multimesh, :ref:`Texture2D<class_Texture2D>` texture, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` texture_filter=0, :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` texture_repeat=0 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_polygon<class_CanvasItem_method_draw_polygon>` **(** :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs=PackedVector2Array( ), :ref:`Texture2D<class_Texture2D>` texture=null, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` texture_filter=0, :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` texture_repeat=0 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_polyline<class_CanvasItem_method_draw_polyline>` **(** :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_polyline_colors<class_CanvasItem_method_draw_polyline_colors>` **(** :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`float<class_float>` width=1.0 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_primitive<class_CanvasItem_method_draw_primitive>` **(** :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs, :ref:`Texture2D<class_Texture2D>` texture=null, :ref:`float<class_float>` width=1.0, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` texture_filter=0, :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` texture_repeat=0 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_set_transform_matrix<class_CanvasItem_method_draw_set_transform_matrix>` **(** :ref:`Transform2D<class_Transform2D>` xform **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_string<class_CanvasItem_method_draw_string>` **(** :ref:`Font<class_Font>` font, :ref:`Vector2<class_Vector2>` position, :ref:`String<class_String>` text, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`int<class_int>` clip_w=-1 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_style_box<class_CanvasItem_method_draw_style_box>` **(** :ref:`StyleBox<class_StyleBox>` style_box, :ref:`Rect2<class_Rect2>` rect **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_texture<class_CanvasItem_method_draw_texture>` **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`Vector2<class_Vector2>` position, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` texture_filter=0, :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` texture_repeat=0 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_texture_rect<class_CanvasItem_method_draw_texture_rect>` **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` tile, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` texture_filter=0, :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` texture_repeat=0 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_texture_rect_region<class_CanvasItem_method_draw_texture_rect_region>` **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` clip_uv=true, :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` texture_filter=0, :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` texture_repeat=0 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`force_update_transform<class_CanvasItem_method_force_update_transform>` **(** **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_RID>` | :ref:`get_canvas<class_CanvasItem_method_get_canvas>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_RID>` | :ref:`get_canvas_item<class_CanvasItem_method_get_canvas_item>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_canvas_transform<class_CanvasItem_method_get_canvas_transform>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_global_mouse_position<class_CanvasItem_method_get_global_mouse_position>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_global_transform<class_CanvasItem_method_get_global_transform>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_global_transform_with_canvas<class_CanvasItem_method_get_global_transform_with_canvas>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_local_mouse_position<class_CanvasItem_method_get_local_mouse_position>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_transform<class_CanvasItem_method_get_transform>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`get_viewport_rect<class_CanvasItem_method_get_viewport_rect>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_viewport_transform<class_CanvasItem_method_get_viewport_transform>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`World2D<class_World2D>` | :ref:`get_world_2d<class_CanvasItem_method_get_world_2d>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`hide<class_CanvasItem_method_hide>` **(** **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_local_transform_notification_enabled<class_CanvasItem_method_is_local_transform_notification_enabled>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_set_as_toplevel<class_CanvasItem_method_is_set_as_toplevel>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_transform_notification_enabled<class_CanvasItem_method_is_transform_notification_enabled>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_visible_in_tree<class_CanvasItem_method_is_visible_in_tree>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`make_canvas_position_local<class_CanvasItem_method_make_canvas_position_local>` **(** :ref:`Vector2<class_Vector2>` screen_point **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`InputEvent<class_InputEvent>` | :ref:`make_input_local<class_CanvasItem_method_make_input_local>` **(** :ref:`InputEvent<class_InputEvent>` event **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_as_toplevel<class_CanvasItem_method_set_as_toplevel>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_notify_local_transform<class_CanvasItem_method_set_notify_local_transform>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_notify_transform<class_CanvasItem_method_set_notify_transform>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`show<class_CanvasItem_method_show>` **(** **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`update<class_CanvasItem_method_update>` **(** **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
@@ -189,33 +193,67 @@ Emitted when the visibility (hidden/visible) changes.
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_CanvasItem_BlendMode:
|
||||
.. _enum_CanvasItem_TextureFilter:
|
||||
|
||||
.. _class_CanvasItem_constant_BLEND_MODE_MIX:
|
||||
.. _class_CanvasItem_constant_TEXTURE_FILTER_PARENT_NODE:
|
||||
|
||||
.. _class_CanvasItem_constant_BLEND_MODE_ADD:
|
||||
.. _class_CanvasItem_constant_TEXTURE_FILTER_NEAREST:
|
||||
|
||||
.. _class_CanvasItem_constant_BLEND_MODE_SUB:
|
||||
.. _class_CanvasItem_constant_TEXTURE_FILTER_LINEAR:
|
||||
|
||||
.. _class_CanvasItem_constant_BLEND_MODE_MUL:
|
||||
.. _class_CanvasItem_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS:
|
||||
|
||||
.. _class_CanvasItem_constant_BLEND_MODE_PREMULT_ALPHA:
|
||||
.. _class_CanvasItem_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS:
|
||||
|
||||
.. _class_CanvasItem_constant_BLEND_MODE_DISABLED:
|
||||
.. _class_CanvasItem_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC:
|
||||
|
||||
enum **BlendMode**:
|
||||
.. _class_CanvasItem_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC:
|
||||
|
||||
- **BLEND_MODE_MIX** = **0** --- Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value.
|
||||
.. _class_CanvasItem_constant_TEXTURE_FILTER_MAX:
|
||||
|
||||
- **BLEND_MODE_ADD** = **1** --- Additive blending mode.
|
||||
enum **TextureFilter**:
|
||||
|
||||
- **BLEND_MODE_SUB** = **2** --- Subtractive blending mode.
|
||||
- **TEXTURE_FILTER_PARENT_NODE** = **0** --- The ``CanvasItem`` will inherit the filter from its parent.
|
||||
|
||||
- **BLEND_MODE_MUL** = **3** --- Multiplicative blending mode.
|
||||
- **TEXTURE_FILTER_NEAREST** = **1** --- The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering. Useful for pixel art.
|
||||
|
||||
- **BLEND_MODE_PREMULT_ALPHA** = **4** --- Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value.
|
||||
- **TEXTURE_FILTER_LINEAR** = **2** --- The texture filter blends between the nearest four pixels. Use this for most cases where you want to avoid a pixelated style.
|
||||
|
||||
- **BLEND_MODE_DISABLED** = **5** --- Disables blending mode. Colors including alpha are written as-is. Only applicable for render targets with a transparent background. No lighting will be applied.
|
||||
- **TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = **3**
|
||||
|
||||
- **TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = **4**
|
||||
|
||||
- **TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC** = **5**
|
||||
|
||||
- **TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC** = **6**
|
||||
|
||||
- **TEXTURE_FILTER_MAX** = **7** --- Represents the size of the :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` enum.
|
||||
|
||||
----
|
||||
|
||||
.. _enum_CanvasItem_TextureRepeat:
|
||||
|
||||
.. _class_CanvasItem_constant_TEXTURE_REPEAT_PARENT_NODE:
|
||||
|
||||
.. _class_CanvasItem_constant_TEXTURE_REPEAT_DISABLED:
|
||||
|
||||
.. _class_CanvasItem_constant_TEXTURE_REPEAT_ENABLED:
|
||||
|
||||
.. _class_CanvasItem_constant_TEXTURE_REPEAT_MIRROR:
|
||||
|
||||
.. _class_CanvasItem_constant_TEXTURE_REPEAT_MAX:
|
||||
|
||||
enum **TextureRepeat**:
|
||||
|
||||
- **TEXTURE_REPEAT_PARENT_NODE** = **0** --- The ``CanvasItem`` will inherit the filter from its parent.
|
||||
|
||||
- **TEXTURE_REPEAT_DISABLED** = **1** --- Texture will not repeat.
|
||||
|
||||
- **TEXTURE_REPEAT_ENABLED** = **2** --- Texture will repeat normally.
|
||||
|
||||
- **TEXTURE_REPEAT_MIRROR** = **3** --- Texture will repeat in a 2x2 tiled mode, where elements at even positions are mirrored.
|
||||
|
||||
- **TEXTURE_REPEAT_MAX** = **4** --- Represents the size of the :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` enum.
|
||||
|
||||
Constants
|
||||
---------
|
||||
@@ -329,6 +367,34 @@ If ``true``, the object draws on top of its parent.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CanvasItem_property_texture_filter:
|
||||
|
||||
- :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **texture_filter**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_texture_filter(value) |
|
||||
+-----------+---------------------------+
|
||||
| *Getter* | get_texture_filter() |
|
||||
+-----------+---------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. _class_CanvasItem_property_texture_repeat:
|
||||
|
||||
- :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` **texture_repeat**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_texture_repeat(value) |
|
||||
+-----------+---------------------------+
|
||||
| *Getter* | get_texture_repeat() |
|
||||
+-----------+---------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. _class_CanvasItem_property_use_parent_material:
|
||||
|
||||
- :ref:`bool<class_bool>` **use_parent_material**
|
||||
@@ -372,7 +438,7 @@ Overridable function called by the engine (if defined) to draw the canvas item.
|
||||
|
||||
.. _class_CanvasItem_method_draw_arc:
|
||||
|
||||
- void **draw_arc** **(** :ref:`Vector2<class_Vector2>` center, :ref:`float<class_float>` radius, :ref:`float<class_float>` start_angle, :ref:`float<class_float>` end_angle, :ref:`int<class_int>` point_count, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
- void **draw_arc** **(** :ref:`Vector2<class_Vector2>` center, :ref:`float<class_float>` radius, :ref:`float<class_float>` start_angle, :ref:`float<class_float>` end_angle, :ref:`int<class_int>` point_count, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0 **)**
|
||||
|
||||
Draws an arc between the given angles. The larger the value of ``point_count``, the smoother the curve.
|
||||
|
||||
@@ -396,7 +462,7 @@ Draws a colored circle.
|
||||
|
||||
.. _class_CanvasItem_method_draw_colored_polygon:
|
||||
|
||||
- void **draw_colored_polygon** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs=PoolVector2Array( ), :ref:`Texture<class_Texture>` texture=null, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
- void **draw_colored_polygon** **(** :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs=PackedVector2Array( ), :ref:`Texture2D<class_Texture2D>` texture=null, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` texture_filter=0, :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` texture_repeat=0 **)**
|
||||
|
||||
Draws a colored polygon of any amount of points, convex or concave.
|
||||
|
||||
@@ -404,15 +470,15 @@ Draws a colored polygon of any amount of points, convex or concave.
|
||||
|
||||
.. _class_CanvasItem_method_draw_line:
|
||||
|
||||
- void **draw_line** **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
- void **draw_line** **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0 **)**
|
||||
|
||||
Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased.
|
||||
Draws a line from a 2D point to another, with a given color and width.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CanvasItem_method_draw_mesh:
|
||||
|
||||
- void **draw_mesh** **(** :ref:`Mesh<class_Mesh>` mesh, :ref:`Texture<class_Texture>` texture, :ref:`Texture<class_Texture>` normal_map=null, :ref:`Transform2D<class_Transform2D>` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ) **)**
|
||||
- void **draw_mesh** **(** :ref:`Mesh<class_Mesh>` mesh, :ref:`Texture2D<class_Texture2D>` texture, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`Transform2D<class_Transform2D>` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` texture_filter=0, :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` texture_repeat=0 **)**
|
||||
|
||||
Draws a :ref:`Mesh<class_Mesh>` in 2D, using the provided texture. See :ref:`MeshInstance2D<class_MeshInstance2D>` for related documentation.
|
||||
|
||||
@@ -420,23 +486,23 @@ Draws a :ref:`Mesh<class_Mesh>` in 2D, using the provided texture. See :ref:`Mes
|
||||
|
||||
.. _class_CanvasItem_method_draw_multiline:
|
||||
|
||||
- void **draw_multiline** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
- void **draw_multiline** **(** :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0 **)**
|
||||
|
||||
Draws multiple, parallel lines with a uniform ``color``. ``width`` and ``antialiased`` are currently not implemented and have no effect.
|
||||
Draws multiple, parallel lines with a uniform ``color``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CanvasItem_method_draw_multiline_colors:
|
||||
|
||||
- void **draw_multiline_colors** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
- void **draw_multiline_colors** **(** :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`float<class_float>` width=1.0 **)**
|
||||
|
||||
Draws multiple, parallel lines with a uniform ``width``, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between ``points`` and ``colors``.
|
||||
Draws multiple, parallel lines with a uniform ``width`` and segment-by-segment coloring. Colors assigned to line segments match by index between ``points`` and ``colors``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CanvasItem_method_draw_multimesh:
|
||||
|
||||
- void **draw_multimesh** **(** :ref:`MultiMesh<class_MultiMesh>` multimesh, :ref:`Texture<class_Texture>` texture, :ref:`Texture<class_Texture>` normal_map=null **)**
|
||||
- void **draw_multimesh** **(** :ref:`MultiMesh<class_MultiMesh>` multimesh, :ref:`Texture2D<class_Texture2D>` texture, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` texture_filter=0, :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` texture_repeat=0 **)**
|
||||
|
||||
Draws a :ref:`MultiMesh<class_MultiMesh>` in 2D with the provided texture. See :ref:`MultiMeshInstance2D<class_MultiMeshInstance2D>` for related documentation.
|
||||
|
||||
@@ -444,7 +510,7 @@ Draws a :ref:`MultiMesh<class_MultiMesh>` in 2D with the provided texture. See :
|
||||
|
||||
.. _class_CanvasItem_method_draw_polygon:
|
||||
|
||||
- void **draw_polygon** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs=PoolVector2Array( ), :ref:`Texture<class_Texture>` texture=null, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
- void **draw_polygon** **(** :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs=PackedVector2Array( ), :ref:`Texture2D<class_Texture2D>` texture=null, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` texture_filter=0, :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` texture_repeat=0 **)**
|
||||
|
||||
Draws a polygon of any amount of points, convex or concave.
|
||||
|
||||
@@ -452,35 +518,35 @@ Draws a polygon of any amount of points, convex or concave.
|
||||
|
||||
.. _class_CanvasItem_method_draw_polyline:
|
||||
|
||||
- void **draw_polyline** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
- void **draw_polyline** **(** :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0 **)**
|
||||
|
||||
Draws interconnected line segments with a uniform ``color`` and ``width`` and optional antialiasing.
|
||||
Draws interconnected line segments with a uniform ``color`` and ``width``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CanvasItem_method_draw_polyline_colors:
|
||||
|
||||
- void **draw_polyline_colors** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
- void **draw_polyline_colors** **(** :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`float<class_float>` width=1.0 **)**
|
||||
|
||||
Draws interconnected line segments with a uniform ``width``, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between ``points`` and ``colors``.
|
||||
Draws interconnected line segments with a uniform ``width`` and segment-by-segment coloring. Colors assigned to line segments match by index between ``points`` and ``colors``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CanvasItem_method_draw_primitive:
|
||||
|
||||
- void **draw_primitive** **(** :ref:`PoolVector2Array<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 **draw_primitive** **(** :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs, :ref:`Texture2D<class_Texture2D>` texture=null, :ref:`float<class_float>` width=1.0, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` texture_filter=0, :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` texture_repeat=0 **)**
|
||||
|
||||
Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.
|
||||
Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle, and 4 points for a quad.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CanvasItem_method_draw_rect:
|
||||
|
||||
- void **draw_rect** **(** :ref:`Rect2<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 **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 **)**
|
||||
|
||||
Draws a rectangle. If ``filled`` is ``true``, the rectangle will be filled with the ``color`` specified. If ``filled`` is ``false``, the rectangle will be drawn as a stroke with the ``color`` and ``width`` specified. If ``antialiased`` is ``true``, the lines will be antialiased.
|
||||
Draws a rectangle. If ``filled`` is ``true``, the rectangle will be filled with the ``color`` specified. If ``filled`` is ``false``, the rectangle will be drawn as a stroke with the ``color`` and ``width`` specified.
|
||||
|
||||
**Note:** ``width`` and ``antialiased`` are only effective if ``filled`` is ``false``.
|
||||
**Note:** ``width`` is only effective if ``filled`` is ``false``.
|
||||
|
||||
----
|
||||
|
||||
@@ -518,7 +584,7 @@ Draws a styled rectangle.
|
||||
|
||||
.. _class_CanvasItem_method_draw_texture:
|
||||
|
||||
- void **draw_texture** **(** :ref:`Texture<class_Texture>` texture, :ref:`Vector2<class_Vector2>` position, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture<class_Texture>` normal_map=null **)**
|
||||
- void **draw_texture** **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`Vector2<class_Vector2>` position, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` texture_filter=0, :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` texture_repeat=0 **)**
|
||||
|
||||
Draws a texture at a given position.
|
||||
|
||||
@@ -526,7 +592,7 @@ Draws a texture at a given position.
|
||||
|
||||
.. _class_CanvasItem_method_draw_texture_rect:
|
||||
|
||||
- void **draw_texture_rect** **(** :ref:`Texture<class_Texture>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` tile, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null **)**
|
||||
- void **draw_texture_rect** **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` tile, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` texture_filter=0, :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` texture_repeat=0 **)**
|
||||
|
||||
Draws a textured rectangle at a given position, optionally modulated by a color. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped.
|
||||
|
||||
@@ -534,7 +600,7 @@ Draws a textured rectangle at a given position, optionally modulated by a color.
|
||||
|
||||
.. _class_CanvasItem_method_draw_texture_rect_region:
|
||||
|
||||
- void **draw_texture_rect_region** **(** :ref:`Texture<class_Texture>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` clip_uv=true **)**
|
||||
- void **draw_texture_rect_region** **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` clip_uv=true, :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` texture_filter=0, :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` texture_repeat=0 **)**
|
||||
|
||||
Draws a textured rectangle region at a given position, optionally modulated by a color. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped.
|
||||
|
||||
|
||||
@@ -125,7 +125,7 @@ The manner in which material reacts to lighting.
|
||||
| *Getter* | get_particles_anim_h_frames() |
|
||||
+----------+------------------------------------+
|
||||
|
||||
The number of columns in the spritesheet assigned as :ref:`Texture<class_Texture>` for a :ref:`Particles2D<class_Particles2D>` or :ref:`CPUParticles2D<class_CPUParticles2D>`.
|
||||
The number of columns in the spritesheet assigned as :ref:`Texture2D<class_Texture2D>` for a :ref:`Particles2D<class_Particles2D>` or :ref:`CPUParticles2D<class_CPUParticles2D>`.
|
||||
|
||||
**Note:** This property is only used and visible in the editor if :ref:`particles_animation<class_CanvasItemMaterial_property_particles_animation>` is ``true``.
|
||||
|
||||
@@ -157,7 +157,7 @@ If ``true``, the particles animation will loop.
|
||||
| *Getter* | get_particles_anim_v_frames() |
|
||||
+----------+------------------------------------+
|
||||
|
||||
The number of rows in the spritesheet assigned as :ref:`Texture<class_Texture>` for a :ref:`Particles2D<class_Particles2D>` or :ref:`CPUParticles2D<class_CPUParticles2D>`.
|
||||
The number of rows in the spritesheet assigned as :ref:`Texture2D<class_Texture2D>` for a :ref:`Particles2D<class_Particles2D>` or :ref:`CPUParticles2D<class_CPUParticles2D>`.
|
||||
|
||||
**Note:** This property is only used and visible in the editor if :ref:`particles_animation<class_CanvasItemMaterial_property_particles_animation>` is ``true``.
|
||||
|
||||
|
||||
@@ -11,12 +11,12 @@ CheckBox
|
||||
|
||||
**Inherits:** :ref:`Button<class_Button>` **<** :ref:`BaseButton<class_BaseButton>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
Binary choice user interface widget.
|
||||
Binary choice user interface widget. See also :ref:`CheckButton<class_CheckButton>`.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
A checkbox allows the user to make a binary choice (choosing only one of two possible options).
|
||||
A checkbox allows the user to make a binary choice (choosing only one of two possible options). It's similar to :ref:`CheckButton<class_CheckButton>` in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use CheckBox when toggling it has **no** immediate effect on something. For instance, it should be used when toggling it will only do something once a confirmation button is pressed.
|
||||
|
||||
Properties
|
||||
----------
|
||||
@@ -30,41 +30,41 @@ Properties
|
||||
Theme Properties
|
||||
----------------
|
||||
|
||||
+---------------------------------+--------------------------+------------------------------+
|
||||
| :ref:`int<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 | |
|
||||
+---------------------------------+--------------------------+------------------------------+
|
||||
+-----------------------------------+--------------------------+------------------------------+
|
||||
| :ref:`int<class_int>` | check_vadjust | 0 |
|
||||
+-----------------------------------+--------------------------+------------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | 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:`Texture2D<class_Texture2D>` | radio_checked | |
|
||||
+-----------------------------------+--------------------------+------------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | radio_unchecked | |
|
||||
+-----------------------------------+--------------------------+------------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | unchecked | |
|
||||
+-----------------------------------+--------------------------+------------------------------+
|
||||
|
||||
|
||||
@@ -11,12 +11,12 @@ CheckButton
|
||||
|
||||
**Inherits:** :ref:`Button<class_Button>` **<** :ref:`BaseButton<class_BaseButton>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
Checkable button.
|
||||
Checkable button. See also :ref:`CheckBox<class_CheckBox>`.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
CheckButton is a toggle button displayed as a check field.
|
||||
CheckButton is a toggle button displayed as a check field. It's similar to :ref:`CheckBox<class_CheckBox>` in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use CheckButton when toggling it has an **immediate** effect on something. For instance, it should be used if toggling it enables/disables a setting without requiring the user to press a confirmation button.
|
||||
|
||||
Properties
|
||||
----------
|
||||
@@ -30,41 +30,41 @@ Properties
|
||||
Theme Properties
|
||||
----------------
|
||||
|
||||
+---------------------------------+--------------------------+------------------------------+
|
||||
| :ref:`int<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 | |
|
||||
+---------------------------------+--------------------------+------------------------------+
|
||||
+-----------------------------------+--------------------------+------------------------------+
|
||||
| :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:`Texture2D<class_Texture2D>` | off | |
|
||||
+-----------------------------------+--------------------------+------------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | off_disabled | |
|
||||
+-----------------------------------+--------------------------+------------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | on | |
|
||||
+-----------------------------------+--------------------------+------------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | on_disabled | |
|
||||
+-----------------------------------+--------------------------+------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | pressed | |
|
||||
+-----------------------------------+--------------------------+------------------------------+
|
||||
|
||||
|
||||
@@ -21,54 +21,54 @@ Provides access to metadata stored for every available class.
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_instance<class_ClassDB_method_can_instance>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`class_exists<class_ClassDB_method_class_exists>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`class_get_category<class_ClassDB_method_class_get_category>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`class_get_integer_constant<class_ClassDB_method_class_get_integer_constant>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`class_get_integer_constant_list<class_ClassDB_method_class_get_integer_constant_list>` **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`class_get_method_list<class_ClassDB_method_class_get_method_list>` **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`class_get_property<class_ClassDB_method_class_get_property>` **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`class_get_property_list<class_ClassDB_method_class_get_property_list>` **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_Dictionary>` | :ref:`class_get_signal<class_ClassDB_method_class_get_signal>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` signal **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`class_get_signal_list<class_ClassDB_method_class_get_signal_list>` **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`class_has_integer_constant<class_ClassDB_method_class_has_integer_constant>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`class_has_method<class_ClassDB_method_class_has_method>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` method, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`class_has_signal<class_ClassDB_method_class_has_signal>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` signal **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`class_set_property<class_ClassDB_method_class_set_property>` **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_class_list<class_ClassDB_method_get_class_list>` **(** **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_inheriters_from_class<class_ClassDB_method_get_inheriters_from_class>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_parent_class<class_ClassDB_method_get_parent_class>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`instance<class_ClassDB_method_instance>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_class_enabled<class_ClassDB_method_is_class_enabled>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_parent_class<class_ClassDB_method_is_parent_class>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` inherits **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_instance<class_ClassDB_method_can_instance>` **(** :ref:`StringName<class_StringName>` class **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`class_exists<class_ClassDB_method_class_exists>` **(** :ref:`StringName<class_StringName>` class **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`StringName<class_StringName>` | :ref:`class_get_category<class_ClassDB_method_class_get_category>` **(** :ref:`StringName<class_StringName>` class **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`class_get_integer_constant<class_ClassDB_method_class_get_integer_constant>` **(** :ref:`StringName<class_StringName>` class, :ref:`StringName<class_StringName>` name **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`class_get_integer_constant_list<class_ClassDB_method_class_get_integer_constant_list>` **(** :ref:`StringName<class_StringName>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`class_get_method_list<class_ClassDB_method_class_get_method_list>` **(** :ref:`StringName<class_StringName>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`class_get_property<class_ClassDB_method_class_get_property>` **(** :ref:`Object<class_Object>` object, :ref:`StringName<class_StringName>` property **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`class_get_property_list<class_ClassDB_method_class_get_property_list>` **(** :ref:`StringName<class_StringName>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_Dictionary>` | :ref:`class_get_signal<class_ClassDB_method_class_get_signal>` **(** :ref:`StringName<class_StringName>` class, :ref:`StringName<class_StringName>` signal **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`class_get_signal_list<class_ClassDB_method_class_get_signal_list>` **(** :ref:`StringName<class_StringName>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`class_has_integer_constant<class_ClassDB_method_class_has_integer_constant>` **(** :ref:`StringName<class_StringName>` class, :ref:`StringName<class_StringName>` name **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`class_has_method<class_ClassDB_method_class_has_method>` **(** :ref:`StringName<class_StringName>` class, :ref:`StringName<class_StringName>` method, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`class_has_signal<class_ClassDB_method_class_has_signal>` **(** :ref:`StringName<class_StringName>` class, :ref:`StringName<class_StringName>` signal **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`class_set_property<class_ClassDB_method_class_set_property>` **(** :ref:`Object<class_Object>` object, :ref:`StringName<class_StringName>` property, :ref:`Variant<class_Variant>` value **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_class_list<class_ClassDB_method_get_class_list>` **(** **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_inheriters_from_class<class_ClassDB_method_get_inheriters_from_class>` **(** :ref:`StringName<class_StringName>` class **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`StringName<class_StringName>` | :ref:`get_parent_class<class_ClassDB_method_get_parent_class>` **(** :ref:`StringName<class_StringName>` class **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`instance<class_ClassDB_method_instance>` **(** :ref:`StringName<class_StringName>` class **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_class_enabled<class_ClassDB_method_is_class_enabled>` **(** :ref:`StringName<class_StringName>` class **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_parent_class<class_ClassDB_method_is_parent_class>` **(** :ref:`StringName<class_StringName>` class, :ref:`StringName<class_StringName>` inherits **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_ClassDB_method_can_instance:
|
||||
|
||||
- :ref:`bool<class_bool>` **can_instance** **(** :ref:`String<class_String>` class **)** const
|
||||
- :ref:`bool<class_bool>` **can_instance** **(** :ref:`StringName<class_StringName>` class **)** const
|
||||
|
||||
Returns ``true`` if you can instance objects from the specified ``class``, ``false`` in other case.
|
||||
|
||||
@@ -76,7 +76,7 @@ Returns ``true`` if you can instance objects from the specified ``class``, ``fal
|
||||
|
||||
.. _class_ClassDB_method_class_exists:
|
||||
|
||||
- :ref:`bool<class_bool>` **class_exists** **(** :ref:`String<class_String>` class **)** const
|
||||
- :ref:`bool<class_bool>` **class_exists** **(** :ref:`StringName<class_StringName>` class **)** const
|
||||
|
||||
Returns whether the specified ``class`` is available or not.
|
||||
|
||||
@@ -84,7 +84,7 @@ Returns whether the specified ``class`` is available or not.
|
||||
|
||||
.. _class_ClassDB_method_class_get_category:
|
||||
|
||||
- :ref:`String<class_String>` **class_get_category** **(** :ref:`String<class_String>` class **)** const
|
||||
- :ref:`StringName<class_StringName>` **class_get_category** **(** :ref:`StringName<class_StringName>` class **)** const
|
||||
|
||||
Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required.
|
||||
|
||||
@@ -92,7 +92,7 @@ Returns a category associated with the class for use in documentation and the As
|
||||
|
||||
.. _class_ClassDB_method_class_get_integer_constant:
|
||||
|
||||
- :ref:`int<class_int>` **class_get_integer_constant** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name **)** const
|
||||
- :ref:`int<class_int>` **class_get_integer_constant** **(** :ref:`StringName<class_StringName>` class, :ref:`StringName<class_StringName>` name **)** const
|
||||
|
||||
Returns the value of the integer constant ``name`` of ``class`` or its ancestry. Always returns 0 when the constant could not be found.
|
||||
|
||||
@@ -100,7 +100,7 @@ Returns the value of the integer constant ``name`` of ``class`` or its ancestry.
|
||||
|
||||
.. _class_ClassDB_method_class_get_integer_constant_list:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **class_get_integer_constant_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
||||
- :ref:`PackedStringArray<class_PackedStringArray>` **class_get_integer_constant_list** **(** :ref:`StringName<class_StringName>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
||||
|
||||
Returns an array with the names all the integer constants of ``class`` or its ancestry.
|
||||
|
||||
@@ -108,7 +108,7 @@ Returns an array with the names all the integer constants of ``class`` or its an
|
||||
|
||||
.. _class_ClassDB_method_class_get_method_list:
|
||||
|
||||
- :ref:`Array<class_Array>` **class_get_method_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
||||
- :ref:`Array<class_Array>` **class_get_method_list** **(** :ref:`StringName<class_StringName>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
||||
|
||||
Returns an array with all the methods of ``class`` or its ancestry if ``no_inheritance`` is ``false``. Every element of the array is a :ref:`Dictionary<class_Dictionary>` with the following keys: ``args``, ``default_args``, ``flags``, ``id``, ``name``, ``return: (class_name, hint, hint_string, name, type, usage)``.
|
||||
|
||||
@@ -116,7 +116,7 @@ Returns an array with all the methods of ``class`` or its ancestry if ``no_inher
|
||||
|
||||
.. _class_ClassDB_method_class_get_property:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **class_get_property** **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property **)** const
|
||||
- :ref:`Variant<class_Variant>` **class_get_property** **(** :ref:`Object<class_Object>` object, :ref:`StringName<class_StringName>` property **)** const
|
||||
|
||||
Returns the value of ``property`` of ``class`` or its ancestry.
|
||||
|
||||
@@ -124,7 +124,7 @@ Returns the value of ``property`` of ``class`` or its ancestry.
|
||||
|
||||
.. _class_ClassDB_method_class_get_property_list:
|
||||
|
||||
- :ref:`Array<class_Array>` **class_get_property_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
||||
- :ref:`Array<class_Array>` **class_get_property_list** **(** :ref:`StringName<class_StringName>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
||||
|
||||
Returns an array with all the properties of ``class`` or its ancestry if ``no_inheritance`` is ``false``.
|
||||
|
||||
@@ -132,7 +132,7 @@ Returns an array with all the properties of ``class`` or its ancestry if ``no_in
|
||||
|
||||
.. _class_ClassDB_method_class_get_signal:
|
||||
|
||||
- :ref:`Dictionary<class_Dictionary>` **class_get_signal** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` signal **)** const
|
||||
- :ref:`Dictionary<class_Dictionary>` **class_get_signal** **(** :ref:`StringName<class_StringName>` class, :ref:`StringName<class_StringName>` signal **)** const
|
||||
|
||||
Returns the ``signal`` data of ``class`` or its ancestry. The returned value is a :ref:`Dictionary<class_Dictionary>` with the following keys: ``args``, ``default_args``, ``flags``, ``id``, ``name``, ``return: (class_name, hint, hint_string, name, type, usage)``.
|
||||
|
||||
@@ -140,7 +140,7 @@ Returns the ``signal`` data of ``class`` or its ancestry. The returned value is
|
||||
|
||||
.. _class_ClassDB_method_class_get_signal_list:
|
||||
|
||||
- :ref:`Array<class_Array>` **class_get_signal_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
||||
- :ref:`Array<class_Array>` **class_get_signal_list** **(** :ref:`StringName<class_StringName>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
||||
|
||||
Returns an array with all the signals of ``class`` or its ancestry if ``no_inheritance`` is ``false``. Every element of the array is a :ref:`Dictionary<class_Dictionary>` as described in :ref:`class_get_signal<class_ClassDB_method_class_get_signal>`.
|
||||
|
||||
@@ -148,7 +148,7 @@ Returns an array with all the signals of ``class`` or its ancestry if ``no_inher
|
||||
|
||||
.. _class_ClassDB_method_class_has_integer_constant:
|
||||
|
||||
- :ref:`bool<class_bool>` **class_has_integer_constant** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name **)** const
|
||||
- :ref:`bool<class_bool>` **class_has_integer_constant** **(** :ref:`StringName<class_StringName>` class, :ref:`StringName<class_StringName>` name **)** const
|
||||
|
||||
Returns whether ``class`` or its ancestry has an integer constant called ``name`` or not.
|
||||
|
||||
@@ -156,7 +156,7 @@ Returns whether ``class`` or its ancestry has an integer constant called ``name`
|
||||
|
||||
.. _class_ClassDB_method_class_has_method:
|
||||
|
||||
- :ref:`bool<class_bool>` **class_has_method** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` method, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
||||
- :ref:`bool<class_bool>` **class_has_method** **(** :ref:`StringName<class_StringName>` class, :ref:`StringName<class_StringName>` method, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
||||
|
||||
Returns whether ``class`` (or its ancestry if ``no_inheritance`` is ``false``) has a method called ``method`` or not.
|
||||
|
||||
@@ -164,7 +164,7 @@ Returns whether ``class`` (or its ancestry if ``no_inheritance`` is ``false``) h
|
||||
|
||||
.. _class_ClassDB_method_class_has_signal:
|
||||
|
||||
- :ref:`bool<class_bool>` **class_has_signal** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` signal **)** const
|
||||
- :ref:`bool<class_bool>` **class_has_signal** **(** :ref:`StringName<class_StringName>` class, :ref:`StringName<class_StringName>` signal **)** const
|
||||
|
||||
Returns whether ``class`` or its ancestry has a signal called ``signal`` or not.
|
||||
|
||||
@@ -172,7 +172,7 @@ Returns whether ``class`` or its ancestry has a signal called ``signal`` or not.
|
||||
|
||||
.. _class_ClassDB_method_class_set_property:
|
||||
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **class_set_property** **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value **)** const
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **class_set_property** **(** :ref:`Object<class_Object>` object, :ref:`StringName<class_StringName>` property, :ref:`Variant<class_Variant>` value **)** const
|
||||
|
||||
Sets ``property`` value of ``class`` to ``value``.
|
||||
|
||||
@@ -180,7 +180,7 @@ Sets ``property`` value of ``class`` to ``value``.
|
||||
|
||||
.. _class_ClassDB_method_get_class_list:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **get_class_list** **(** **)** const
|
||||
- :ref:`PackedStringArray<class_PackedStringArray>` **get_class_list** **(** **)** const
|
||||
|
||||
Returns the names of all the classes available.
|
||||
|
||||
@@ -188,7 +188,7 @@ Returns the names of all the classes available.
|
||||
|
||||
.. _class_ClassDB_method_get_inheriters_from_class:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **get_inheriters_from_class** **(** :ref:`String<class_String>` class **)** const
|
||||
- :ref:`PackedStringArray<class_PackedStringArray>` **get_inheriters_from_class** **(** :ref:`StringName<class_StringName>` class **)** const
|
||||
|
||||
Returns the names of all the classes that directly or indirectly inherit from ``class``.
|
||||
|
||||
@@ -196,7 +196,7 @@ Returns the names of all the classes that directly or indirectly inherit from ``
|
||||
|
||||
.. _class_ClassDB_method_get_parent_class:
|
||||
|
||||
- :ref:`String<class_String>` **get_parent_class** **(** :ref:`String<class_String>` class **)** const
|
||||
- :ref:`StringName<class_StringName>` **get_parent_class** **(** :ref:`StringName<class_StringName>` class **)** const
|
||||
|
||||
Returns the parent class of ``class``.
|
||||
|
||||
@@ -204,7 +204,7 @@ Returns the parent class of ``class``.
|
||||
|
||||
.. _class_ClassDB_method_instance:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **instance** **(** :ref:`String<class_String>` class **)** const
|
||||
- :ref:`Variant<class_Variant>` **instance** **(** :ref:`StringName<class_StringName>` class **)** const
|
||||
|
||||
Creates an instance of ``class``.
|
||||
|
||||
@@ -212,7 +212,7 @@ Creates an instance of ``class``.
|
||||
|
||||
.. _class_ClassDB_method_is_class_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_class_enabled** **(** :ref:`String<class_String>` class **)** const
|
||||
- :ref:`bool<class_bool>` **is_class_enabled** **(** :ref:`StringName<class_StringName>` class **)** const
|
||||
|
||||
Returns whether this ``class`` is enabled or not.
|
||||
|
||||
@@ -220,7 +220,7 @@ Returns whether this ``class`` is enabled or not.
|
||||
|
||||
.. _class_ClassDB_method_is_parent_class:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_parent_class** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` inherits **)** const
|
||||
- :ref:`bool<class_bool>` **is_parent_class** **(** :ref:`StringName<class_StringName>` class, :ref:`StringName<class_StringName>` inherits **)** const
|
||||
|
||||
Returns whether ``inherits`` is an ancestor of ``class`` or not.
|
||||
|
||||
|
||||
@@ -21,13 +21,13 @@ Allows editing a collision polygon's vertices on a selected plane. Can also set
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------------+-----------------------------------------------------------+--------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`depth<class_CollisionPolygon_property_depth>` | ``1.0`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------+--------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionPolygon_property_disabled>` | ``false`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------+--------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`polygon<class_CollisionPolygon_property_polygon>` | ``PoolVector2Array( )`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------+--------------------------+
|
||||
+-----------------------------------------------------+-----------------------------------------------------------+----------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`depth<class_CollisionPolygon_property_depth>` | ``1.0`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------+----------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionPolygon_property_disabled>` | ``false`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------+----------------------------+
|
||||
| :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`polygon<class_CollisionPolygon_property_polygon>` | ``PackedVector2Array( )`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------+----------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -66,15 +66,15 @@ If ``true``, no collision will be produced.
|
||||
|
||||
.. _class_CollisionPolygon_property_polygon:
|
||||
|
||||
- :ref:`PoolVector2Array<class_PoolVector2Array>` **polygon**
|
||||
- :ref:`PackedVector2Array<class_PackedVector2Array>` **polygon**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | ``PoolVector2Array( )`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_polygon(value) |
|
||||
+-----------+--------------------------+
|
||||
| *Getter* | get_polygon() |
|
||||
+-----------+--------------------------+
|
||||
+-----------+----------------------------+
|
||||
| *Default* | ``PackedVector2Array( )`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_polygon(value) |
|
||||
+-----------+----------------------------+
|
||||
| *Getter* | get_polygon() |
|
||||
+-----------+----------------------------+
|
||||
|
||||
Array of vertices which define the polygon.
|
||||
|
||||
|
||||
@@ -21,17 +21,17 @@ Provides a 2D collision polygon to a :ref:`CollisionObject2D<class_CollisionObje
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+--------------------------+
|
||||
| :ref:`BuildMode<enum_CollisionPolygon2D_BuildMode>` | :ref:`build_mode<class_CollisionPolygon2D_property_build_mode>` | ``0`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+--------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionPolygon2D_property_disabled>` | ``false`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+--------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`one_way_collision<class_CollisionPolygon2D_property_one_way_collision>` | ``false`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+--------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`one_way_collision_margin<class_CollisionPolygon2D_property_one_way_collision_margin>` | ``1.0`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+--------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`polygon<class_CollisionPolygon2D_property_polygon>` | ``PoolVector2Array( )`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+--------------------------+
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`BuildMode<enum_CollisionPolygon2D_BuildMode>` | :ref:`build_mode<class_CollisionPolygon2D_property_build_mode>` | ``0`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionPolygon2D_property_disabled>` | ``false`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`one_way_collision<class_CollisionPolygon2D_property_one_way_collision>` | ``false`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`one_way_collision_margin<class_CollisionPolygon2D_property_one_way_collision_margin>` | ``1.0`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`polygon<class_CollisionPolygon2D_property_polygon>` | ``PackedVector2Array( )`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
@@ -111,19 +111,21 @@ If ``true``, only edges that face up, relative to ``CollisionPolygon2D``'s rotat
|
||||
| *Getter* | get_one_way_collision_margin() |
|
||||
+-----------+-------------------------------------+
|
||||
|
||||
The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the polygon at a high velocity.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CollisionPolygon2D_property_polygon:
|
||||
|
||||
- :ref:`PoolVector2Array<class_PoolVector2Array>` **polygon**
|
||||
- :ref:`PackedVector2Array<class_PackedVector2Array>` **polygon**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | ``PoolVector2Array( )`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_polygon(value) |
|
||||
+-----------+--------------------------+
|
||||
| *Getter* | get_polygon() |
|
||||
+-----------+--------------------------+
|
||||
+-----------+----------------------------+
|
||||
| *Default* | ``PackedVector2Array( )`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_polygon(value) |
|
||||
+-----------+----------------------------+
|
||||
| *Getter* | get_polygon() |
|
||||
+-----------+----------------------------+
|
||||
|
||||
The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the :ref:`PoolVector2Array<class_PoolVector2Array>`, not a reference.
|
||||
The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the :ref:`PackedVector2Array<class_PackedVector2Array>`, not a reference.
|
||||
|
||||
|
||||
@@ -83,7 +83,7 @@ Sets whether this collision shape should only detect collision on one side (top
|
||||
| *Getter* | get_one_way_collision_margin() |
|
||||
+-----------+-------------------------------------+
|
||||
|
||||
The margin used for one-way collision (in pixels).
|
||||
The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the shape at a high velocity.
|
||||
|
||||
----
|
||||
|
||||
|
||||
@@ -48,53 +48,49 @@ Properties
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`String<class_String>` from **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`int<class_int>` from **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b, :ref:`float<class_float>` a **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`blend<class_Color_method_blend>` **(** :ref:`Color<class_Color>` over **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`contrasted<class_Color_method_contrasted>` **(** **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`darkened<class_Color_method_darkened>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`from_hsv<class_Color_method_from_hsv>` **(** :ref:`float<class_float>` h, :ref:`float<class_float>` s, :ref:`float<class_float>` v, :ref:`float<class_float>` a=1 **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gray<class_Color_method_gray>` **(** **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`inverted<class_Color_method_inverted>` **(** **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_equal_approx<class_Color_method_is_equal_approx>` **(** :ref:`Color<class_Color>` color **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`lightened<class_Color_method_lightened>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`linear_interpolate<class_Color_method_linear_interpolate>` **(** :ref:`Color<class_Color>` b, :ref:`float<class_float>` t **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_abgr32<class_Color_method_to_abgr32>` **(** **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_abgr64<class_Color_method_to_abgr64>` **(** **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_argb32<class_Color_method_to_argb32>` **(** **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_argb64<class_Color_method_to_argb64>` **(** **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`to_html<class_Color_method_to_html>` **(** :ref:`bool<class_bool>` with_alpha=True **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_rgba32<class_Color_method_to_rgba32>` **(** **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_rgba64<class_Color_method_to_rgba64>` **(** **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`String<class_String>` from **)** |
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`int<class_int>` from **)** |
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)** |
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b, :ref:`float<class_float>` a **)** |
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`blend<class_Color_method_blend>` **(** :ref:`Color<class_Color>` over **)** |
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`contrasted<class_Color_method_contrasted>` **(** **)** |
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`darkened<class_Color_method_darkened>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`from_hsv<class_Color_method_from_hsv>` **(** :ref:`float<class_float>` h, :ref:`float<class_float>` s, :ref:`float<class_float>` v, :ref:`float<class_float>` a=1.0 **)** |
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`inverted<class_Color_method_inverted>` **(** **)** |
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_equal_approx<class_Color_method_is_equal_approx>` **(** :ref:`Color<class_Color>` color **)** |
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`lightened<class_Color_method_lightened>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`linear_interpolate<class_Color_method_linear_interpolate>` **(** :ref:`Color<class_Color>` b, :ref:`float<class_float>` t **)** |
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_abgr32<class_Color_method_to_abgr32>` **(** **)** |
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_abgr64<class_Color_method_to_abgr64>` **(** **)** |
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_argb32<class_Color_method_to_argb32>` **(** **)** |
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_argb64<class_Color_method_to_argb64>` **(** **)** |
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`to_html<class_Color_method_to_html>` **(** :ref:`bool<class_bool>` with_alpha=true **)** |
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_rgba32<class_Color_method_to_rgba32>` **(** **)** |
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_rgba64<class_Color_method_to_rgba64>` **(** **)** |
|
||||
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Constants
|
||||
---------
|
||||
|
||||
.. _class_Color_constant_gray:
|
||||
|
||||
.. _class_Color_constant_aliceblue:
|
||||
|
||||
.. _class_Color_constant_antiquewhite:
|
||||
@@ -195,6 +191,8 @@ Constants
|
||||
|
||||
.. _class_Color_constant_goldenrod:
|
||||
|
||||
.. _class_Color_constant_gray:
|
||||
|
||||
.. _class_Color_constant_green:
|
||||
|
||||
.. _class_Color_constant_greenyellow:
|
||||
@@ -385,8 +383,6 @@ Constants
|
||||
|
||||
.. _class_Color_constant_yellowgreen:
|
||||
|
||||
- **gray** = **Color( 0.75, 0.75, 0.75, 1 )** --- Gray color.
|
||||
|
||||
- **aliceblue** = **Color( 0.94, 0.97, 1, 1 )** --- Alice blue color.
|
||||
|
||||
- **antiquewhite** = **Color( 0.98, 0.92, 0.84, 1 )** --- Antique white color.
|
||||
@@ -487,6 +483,8 @@ Constants
|
||||
|
||||
- **goldenrod** = **Color( 0.85, 0.65, 0.13, 1 )** --- Goldenrod color.
|
||||
|
||||
- **gray** = **Color( 0.75, 0.75, 0.75, 1 )** --- Gray color.
|
||||
|
||||
- **green** = **Color( 0, 1, 0, 1 )** --- Green color.
|
||||
|
||||
- **greenyellow** = **Color( 0.68, 1, 0.18, 1 )** --- Green yellow color.
|
||||
@@ -901,7 +899,7 @@ Returns a new color resulting from making this color darker by the specified per
|
||||
|
||||
.. _class_Color_method_from_hsv:
|
||||
|
||||
- :ref:`Color<class_Color>` **from_hsv** **(** :ref:`float<class_float>` h, :ref:`float<class_float>` s, :ref:`float<class_float>` v, :ref:`float<class_float>` a=1 **)**
|
||||
- :ref:`Color<class_Color>` **from_hsv** **(** :ref:`float<class_float>` h, :ref:`float<class_float>` s, :ref:`float<class_float>` v, :ref:`float<class_float>` a=1.0 **)**
|
||||
|
||||
Constructs a color from an HSV profile. ``h``, ``s``, and ``v`` are values between 0 and 1.
|
||||
|
||||
@@ -911,21 +909,6 @@ Constructs a color from an HSV profile. ``h``, ``s``, and ``v`` are values betwe
|
||||
|
||||
----
|
||||
|
||||
.. _class_Color_method_gray:
|
||||
|
||||
- :ref:`float<class_float>` **gray** **(** **)**
|
||||
|
||||
Returns the color's grayscale representation.
|
||||
|
||||
The gray value is calculated as ``(r + g + b) / 3``.
|
||||
|
||||
::
|
||||
|
||||
var c = Color(0.2, 0.45, 0.82)
|
||||
var gray = c.gray() # A value of 0.466667
|
||||
|
||||
----
|
||||
|
||||
.. _class_Color_method_inverted:
|
||||
|
||||
- :ref:`Color<class_Color>` **inverted** **(** **)**
|
||||
@@ -1028,7 +1011,7 @@ Returns the color's 64-bit integer in ARGB format (each word represents a compon
|
||||
|
||||
.. _class_Color_method_to_html:
|
||||
|
||||
- :ref:`String<class_String>` **to_html** **(** :ref:`bool<class_bool>` with_alpha=True **)**
|
||||
- :ref:`String<class_String>` **to_html** **(** :ref:`bool<class_bool>` with_alpha=true **)**
|
||||
|
||||
Returns the color's HTML hexadecimal color string in ARGB format (ex: ``ff34f822``).
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ Color picker control.
|
||||
Description
|
||||
-----------
|
||||
|
||||
:ref:`Control<class_Control>` node displaying a color picker widget. It's useful for selecting a color from an RGB/RGBA colorspace.
|
||||
Displays a color picker widget. Useful for selecting a color from an RGB/RGBA colorspace.
|
||||
|
||||
Properties
|
||||
----------
|
||||
@@ -40,40 +40,40 @@ Properties
|
||||
Methods
|
||||
-------
|
||||
|
||||
+---------------------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_preset<class_ColorPicker_method_add_preset>` **(** :ref:`Color<class_Color>` color **)** |
|
||||
+---------------------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase_preset<class_ColorPicker_method_erase_preset>` **(** :ref:`Color<class_Color>` color **)** |
|
||||
+---------------------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolColorArray<class_PoolColorArray>` | :ref:`get_presets<class_ColorPicker_method_get_presets>` **(** **)** const |
|
||||
+---------------------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_preset<class_ColorPicker_method_add_preset>` **(** :ref:`Color<class_Color>` color **)** |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase_preset<class_ColorPicker_method_erase_preset>` **(** :ref:`Color<class_Color>` color **)** |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedColorArray<class_PackedColorArray>` | :ref:`get_presets<class_ColorPicker_method_get_presets>` **(** **)** const |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Theme Properties
|
||||
----------------
|
||||
|
||||
+-------------------------------+----------------------+-----+
|
||||
| :ref:`Texture<class_Texture>` | add_preset | |
|
||||
+-------------------------------+----------------------+-----+
|
||||
| :ref:`Texture<class_Texture>` | color_hue | |
|
||||
+-------------------------------+----------------------+-----+
|
||||
| :ref:`Texture<class_Texture>` | color_sample | |
|
||||
+-------------------------------+----------------------+-----+
|
||||
| :ref:`int<class_int>` | h_width | 30 |
|
||||
+-------------------------------+----------------------+-----+
|
||||
| :ref:`int<class_int>` | label_width | 10 |
|
||||
+-------------------------------+----------------------+-----+
|
||||
| :ref:`int<class_int>` | margin | 4 |
|
||||
+-------------------------------+----------------------+-----+
|
||||
| :ref:`Texture<class_Texture>` | overbright_indicator | |
|
||||
+-------------------------------+----------------------+-----+
|
||||
| :ref:`Texture<class_Texture>` | preset_bg | |
|
||||
+-------------------------------+----------------------+-----+
|
||||
| :ref:`Texture<class_Texture>` | screen_picker | |
|
||||
+-------------------------------+----------------------+-----+
|
||||
| :ref:`int<class_int>` | sv_height | 256 |
|
||||
+-------------------------------+----------------------+-----+
|
||||
| :ref:`int<class_int>` | sv_width | 256 |
|
||||
+-------------------------------+----------------------+-----+
|
||||
+-----------------------------------+----------------------+-----+
|
||||
| :ref:`Texture2D<class_Texture2D>` | add_preset | |
|
||||
+-----------------------------------+----------------------+-----+
|
||||
| :ref:`Texture2D<class_Texture2D>` | color_hue | |
|
||||
+-----------------------------------+----------------------+-----+
|
||||
| :ref:`Texture2D<class_Texture2D>` | color_sample | |
|
||||
+-----------------------------------+----------------------+-----+
|
||||
| :ref:`int<class_int>` | h_width | 30 |
|
||||
+-----------------------------------+----------------------+-----+
|
||||
| :ref:`int<class_int>` | label_width | 10 |
|
||||
+-----------------------------------+----------------------+-----+
|
||||
| :ref:`int<class_int>` | margin | 4 |
|
||||
+-----------------------------------+----------------------+-----+
|
||||
| :ref:`Texture2D<class_Texture2D>` | overbright_indicator | |
|
||||
+-----------------------------------+----------------------+-----+
|
||||
| :ref:`Texture2D<class_Texture2D>` | preset_bg | |
|
||||
+-----------------------------------+----------------------+-----+
|
||||
| :ref:`Texture2D<class_Texture2D>` | screen_picker | |
|
||||
+-----------------------------------+----------------------+-----+
|
||||
| :ref:`int<class_int>` | sv_height | 256 |
|
||||
+-----------------------------------+----------------------+-----+
|
||||
| :ref:`int<class_int>` | sv_width | 256 |
|
||||
+-----------------------------------+----------------------+-----+
|
||||
|
||||
Signals
|
||||
-------
|
||||
@@ -240,7 +240,7 @@ Removes the given color from the list of color presets of this color picker.
|
||||
|
||||
.. _class_ColorPicker_method_get_presets:
|
||||
|
||||
- :ref:`PoolColorArray<class_PoolColorArray>` **get_presets** **(** **)** const
|
||||
- :ref:`PackedColorArray<class_PackedColorArray>` **get_presets** **(** **)** const
|
||||
|
||||
Returns the list of colors in the presets of the color picker.
|
||||
|
||||
|
||||
@@ -41,31 +41,31 @@ Methods
|
||||
Theme Properties
|
||||
----------------
|
||||
|
||||
+---------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`Texture<class_Texture>` | bg | |
|
||||
+---------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | disabled | |
|
||||
+---------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | focus | |
|
||||
+---------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`Font<class_Font>` | font | |
|
||||
+---------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`Color<class_Color>` | font_color | Color( 1, 1, 1, 1 ) |
|
||||
+---------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.3 ) |
|
||||
+---------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`Color<class_Color>` | font_color_hover | Color( 1, 1, 1, 1 ) |
|
||||
+---------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`Color<class_Color>` | font_color_pressed | Color( 0.8, 0.8, 0.8, 1 ) |
|
||||
+---------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | hover | |
|
||||
+---------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`int<class_int>` | hseparation | 2 |
|
||||
+---------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | normal | |
|
||||
+---------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | pressed | |
|
||||
+---------------------------------+---------------------+-----------------------------+
|
||||
+-----------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | bg | |
|
||||
+-----------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | disabled | |
|
||||
+-----------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | focus | |
|
||||
+-----------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`Font<class_Font>` | font | |
|
||||
+-----------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`Color<class_Color>` | font_color | Color( 1, 1, 1, 1 ) |
|
||||
+-----------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.3 ) |
|
||||
+-----------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`Color<class_Color>` | font_color_hover | Color( 1, 1, 1, 1 ) |
|
||||
+-----------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`Color<class_Color>` | font_color_pressed | Color( 0.8, 0.8, 0.8, 1 ) |
|
||||
+-----------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | hover | |
|
||||
+-----------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`int<class_int>` | hseparation | 2 |
|
||||
+-----------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | normal | |
|
||||
+-----------------------------------+---------------------+-----------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | pressed | |
|
||||
+-----------------------------------+---------------------+-----------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
@@ -18,21 +18,23 @@ Description
|
||||
|
||||
Concave polygon shape resource, which can be set into a :ref:`PhysicsBody<class_PhysicsBody>` or area. This shape is created by feeding a list of triangles.
|
||||
|
||||
Note: when used for collision, ``ConcavePolygonShape`` is intended to work with static :ref:`PhysicsBody<class_PhysicsBody>` nodes like :ref:`StaticBody<class_StaticBody>` and will not work with :ref:`KinematicBody<class_KinematicBody>` or :ref:`RigidBody<class_RigidBody>` with a mode other than Static.
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`get_faces<class_ConcavePolygonShape_method_get_faces>` **(** **)** const |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_faces<class_ConcavePolygonShape_method_set_faces>` **(** :ref:`PoolVector3Array<class_PoolVector3Array>` faces **)** |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`get_faces<class_ConcavePolygonShape_method_get_faces>` **(** **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_faces<class_ConcavePolygonShape_method_set_faces>` **(** :ref:`PackedVector3Array<class_PackedVector3Array>` faces **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_ConcavePolygonShape_method_get_faces:
|
||||
|
||||
- :ref:`PoolVector3Array<class_PoolVector3Array>` **get_faces** **(** **)** const
|
||||
- :ref:`PackedVector3Array<class_PackedVector3Array>` **get_faces** **(** **)** const
|
||||
|
||||
Returns the faces (an array of triangles).
|
||||
|
||||
@@ -40,7 +42,7 @@ Returns the faces (an array of triangles).
|
||||
|
||||
.. _class_ConcavePolygonShape_method_set_faces:
|
||||
|
||||
- void **set_faces** **(** :ref:`PoolVector3Array<class_PoolVector3Array>` faces **)**
|
||||
- void **set_faces** **(** :ref:`PackedVector3Array<class_PackedVector3Array>` faces **)**
|
||||
|
||||
Sets the faces (an array of triangles).
|
||||
|
||||
|
||||
@@ -23,24 +23,24 @@ The main difference between a :ref:`ConvexPolygonShape2D<class_ConvexPolygonShap
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------------+----------------------------------------------------------------+--------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`segments<class_ConcavePolygonShape2D_property_segments>` | ``PoolVector2Array( )`` |
|
||||
+-------------------------------------------------+----------------------------------------------------------------+--------------------------+
|
||||
+-----------------------------------------------------+----------------------------------------------------------------+----------------------------+
|
||||
| :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`segments<class_ConcavePolygonShape2D_property_segments>` | ``PackedVector2Array( )`` |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------+----------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_ConcavePolygonShape2D_property_segments:
|
||||
|
||||
- :ref:`PoolVector2Array<class_PoolVector2Array>` **segments**
|
||||
- :ref:`PackedVector2Array<class_PackedVector2Array>` **segments**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | ``PoolVector2Array( )`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_segments(value) |
|
||||
+-----------+--------------------------+
|
||||
| *Getter* | get_segments() |
|
||||
+-----------+--------------------------+
|
||||
+-----------+----------------------------+
|
||||
| *Default* | ``PackedVector2Array( )`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_segments(value) |
|
||||
+-----------+----------------------------+
|
||||
| *Getter* | get_segments() |
|
||||
+-----------+----------------------------+
|
||||
|
||||
The array of points that make up the ``ConcavePolygonShape2D``'s line segments.
|
||||
|
||||
|
||||
@@ -49,35 +49,37 @@ ConfigFiles can also contain manually written comment lines starting with a semi
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase_section<class_ConfigFile_method_erase_section>` **(** :ref:`String<class_String>` section **)** |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase_section_key<class_ConfigFile_method_erase_section_key>` **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key **)** |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_section_keys<class_ConfigFile_method_get_section_keys>` **(** :ref:`String<class_String>` section **)** const |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_sections<class_ConfigFile_method_get_sections>` **(** **)** const |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`get_value<class_ConfigFile_method_get_value>` **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` default=null **)** const |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_section<class_ConfigFile_method_has_section>` **(** :ref:`String<class_String>` section **)** const |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_section_key<class_ConfigFile_method_has_section_key>` **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key **)** const |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load<class_ConfigFile_method_load>` **(** :ref:`String<class_String>` path **)** |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load_encrypted<class_ConfigFile_method_load_encrypted>` **(** :ref:`String<class_String>` path, :ref:`PoolByteArray<class_PoolByteArray>` key **)** |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load_encrypted_pass<class_ConfigFile_method_load_encrypted_pass>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` pass **)** |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`save<class_ConfigFile_method_save>` **(** :ref:`String<class_String>` path **)** |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`save_encrypted<class_ConfigFile_method_save_encrypted>` **(** :ref:`String<class_String>` path, :ref:`PoolByteArray<class_PoolByteArray>` key **)** |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`save_encrypted_pass<class_ConfigFile_method_save_encrypted_pass>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` pass **)** |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_value<class_ConfigFile_method_set_value>` **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` value **)** |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase_section<class_ConfigFile_method_erase_section>` **(** :ref:`String<class_String>` section **)** |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase_section_key<class_ConfigFile_method_erase_section_key>` **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key **)** |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_section_keys<class_ConfigFile_method_get_section_keys>` **(** :ref:`String<class_String>` section **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_sections<class_ConfigFile_method_get_sections>` **(** **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`get_value<class_ConfigFile_method_get_value>` **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` default=null **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_section<class_ConfigFile_method_has_section>` **(** :ref:`String<class_String>` section **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_section_key<class_ConfigFile_method_has_section_key>` **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load<class_ConfigFile_method_load>` **(** :ref:`String<class_String>` path **)** |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load_encrypted<class_ConfigFile_method_load_encrypted>` **(** :ref:`String<class_String>` path, :ref:`PackedByteArray<class_PackedByteArray>` key **)** |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load_encrypted_pass<class_ConfigFile_method_load_encrypted_pass>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` password **)** |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`parse<class_ConfigFile_method_parse>` **(** :ref:`String<class_String>` data **)** |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`save<class_ConfigFile_method_save>` **(** :ref:`String<class_String>` path **)** |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`save_encrypted<class_ConfigFile_method_save_encrypted>` **(** :ref:`String<class_String>` path, :ref:`PackedByteArray<class_PackedByteArray>` key **)** |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`save_encrypted_pass<class_ConfigFile_method_save_encrypted_pass>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` password **)** |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_value<class_ConfigFile_method_set_value>` **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` value **)** |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
@@ -86,7 +88,7 @@ Method Descriptions
|
||||
|
||||
- void **erase_section** **(** :ref:`String<class_String>` section **)**
|
||||
|
||||
Deletes the specified section along with all the key-value pairs inside.
|
||||
Deletes the specified section along with all the key-value pairs inside. Raises an error if the section does not exist.
|
||||
|
||||
----
|
||||
|
||||
@@ -94,19 +96,21 @@ Deletes the specified section along with all the key-value pairs inside.
|
||||
|
||||
- void **erase_section_key** **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key **)**
|
||||
|
||||
Deletes the specified key in a section. Raises an error if either the section or the key do not exist.
|
||||
|
||||
----
|
||||
|
||||
.. _class_ConfigFile_method_get_section_keys:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **get_section_keys** **(** :ref:`String<class_String>` section **)** const
|
||||
- :ref:`PackedStringArray<class_PackedStringArray>` **get_section_keys** **(** :ref:`String<class_String>` section **)** const
|
||||
|
||||
Returns an array of all defined key identifiers in the specified section.
|
||||
Returns an array of all defined key identifiers in the specified section. Raises an error and returns an empty array if the section does not exist.
|
||||
|
||||
----
|
||||
|
||||
.. _class_ConfigFile_method_get_sections:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **get_sections** **(** **)** const
|
||||
- :ref:`PackedStringArray<class_PackedStringArray>` **get_sections** **(** **)** const
|
||||
|
||||
Returns an array of all defined section identifiers.
|
||||
|
||||
@@ -116,7 +120,7 @@ Returns an array of all defined section identifiers.
|
||||
|
||||
- :ref:`Variant<class_Variant>` **get_value** **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` default=null **)** const
|
||||
|
||||
Returns the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional ``default`` argument, or ``null`` if it is omitted.
|
||||
Returns the current value for the specified section and key. If either the section or the key do not exist, the method returns the fallback ``default`` value. If ``default`` is not specified or set to ``null``, an error is also raised.
|
||||
|
||||
----
|
||||
|
||||
@@ -140,7 +144,7 @@ Returns ``true`` if the specified section-key pair exists.
|
||||
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **load** **(** :ref:`String<class_String>` path **)**
|
||||
|
||||
Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on.
|
||||
Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ``ConfigFile`` object which the method was called on.
|
||||
|
||||
Returns one of the :ref:`Error<enum_@GlobalScope_Error>` code constants (``OK`` on success).
|
||||
|
||||
@@ -148,13 +152,31 @@ Returns one of the :ref:`Error<enum_@GlobalScope_Error>` code constants (``OK``
|
||||
|
||||
.. _class_ConfigFile_method_load_encrypted:
|
||||
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **load_encrypted** **(** :ref:`String<class_String>` path, :ref:`PoolByteArray<class_PoolByteArray>` key **)**
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **load_encrypted** **(** :ref:`String<class_String>` path, :ref:`PackedByteArray<class_PackedByteArray>` key **)**
|
||||
|
||||
Loads the encrypted config file specified as a parameter, using the provided ``key`` to decrypt it. The file's contents are parsed and loaded in the ``ConfigFile`` object which the method was called on.
|
||||
|
||||
Returns one of the :ref:`Error<enum_@GlobalScope_Error>` code constants (``OK`` on success).
|
||||
|
||||
----
|
||||
|
||||
.. _class_ConfigFile_method_load_encrypted_pass:
|
||||
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **load_encrypted_pass** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` pass **)**
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **load_encrypted_pass** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` password **)**
|
||||
|
||||
Loads the encrypted config file specified as a parameter, using the provided ``password`` to decrypt it. The file's contents are parsed and loaded in the ``ConfigFile`` object which the method was called on.
|
||||
|
||||
Returns one of the :ref:`Error<enum_@GlobalScope_Error>` code constants (``OK`` on success).
|
||||
|
||||
----
|
||||
|
||||
.. _class_ConfigFile_method_parse:
|
||||
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **parse** **(** :ref:`String<class_String>` data **)**
|
||||
|
||||
Parses the the passed string as the contents of a config file. The string is parsed and loaded in the ConfigFile object which the method was called on.
|
||||
|
||||
Returns one of the :ref:`Error<enum_@GlobalScope_Error>` code constants (``OK`` on success).
|
||||
|
||||
----
|
||||
|
||||
@@ -162,7 +184,7 @@ Returns one of the :ref:`Error<enum_@GlobalScope_Error>` code constants (``OK``
|
||||
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **save** **(** :ref:`String<class_String>` path **)**
|
||||
|
||||
Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure.
|
||||
Saves the contents of the ``ConfigFile`` object to the file specified as a parameter. The output file uses an INI-style structure.
|
||||
|
||||
Returns one of the :ref:`Error<enum_@GlobalScope_Error>` code constants (``OK`` on success).
|
||||
|
||||
@@ -170,13 +192,21 @@ Returns one of the :ref:`Error<enum_@GlobalScope_Error>` code constants (``OK``
|
||||
|
||||
.. _class_ConfigFile_method_save_encrypted:
|
||||
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **save_encrypted** **(** :ref:`String<class_String>` path, :ref:`PoolByteArray<class_PoolByteArray>` key **)**
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **save_encrypted** **(** :ref:`String<class_String>` path, :ref:`PackedByteArray<class_PackedByteArray>` key **)**
|
||||
|
||||
Saves the contents of the ``ConfigFile`` object to the AES-256 encrypted file specified as a parameter, using the provided ``key`` to encrypt it. The output file uses an INI-style structure.
|
||||
|
||||
Returns one of the :ref:`Error<enum_@GlobalScope_Error>` code constants (``OK`` on success).
|
||||
|
||||
----
|
||||
|
||||
.. _class_ConfigFile_method_save_encrypted_pass:
|
||||
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **save_encrypted_pass** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` pass **)**
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **save_encrypted_pass** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` password **)**
|
||||
|
||||
Saves the contents of the ``ConfigFile`` object to the AES-256 encrypted file specified as a parameter, using the provided ``password`` to encrypt it. The output file uses an INI-style structure.
|
||||
|
||||
Returns one of the :ref:`Error<enum_@GlobalScope_Error>` code constants (``OK`` on success).
|
||||
|
||||
----
|
||||
|
||||
@@ -184,5 +214,5 @@ Returns one of the :ref:`Error<enum_@GlobalScope_Error>` code constants (``OK``
|
||||
|
||||
- void **set_value** **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` value **)**
|
||||
|
||||
Assigns a value to the specified key of the specified section. If the section and/or the key do not exist, they are created. Passing a ``null`` value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed.
|
||||
Assigns a value to the specified key of the specified section. If either the section or the key do not exist, they are created. Passing a ``null`` value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed.
|
||||
|
||||
|
||||
@@ -22,6 +22,13 @@ Base node for containers. A ``Container`` contains other controls and automatica
|
||||
|
||||
A Control can inherit this to create custom container classes.
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+----------------------------------------------+--------------+--------------+
|
||||
| :ref:`MouseFilter<enum_Control_MouseFilter>` | mouse_filter | **O:** ``1`` |
|
||||
+----------------------------------------------+--------------+--------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
|
||||
@@ -122,17 +122,17 @@ Methods
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`accept_event<class_Control_method_accept_event>` **(** **)** |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_color_override<class_Control_method_add_color_override>` **(** :ref:`String<class_String>` name, :ref:`Color<class_Color>` color **)** |
|
||||
| void | :ref:`add_color_override<class_Control_method_add_color_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`Color<class_Color>` color **)** |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_constant_override<class_Control_method_add_constant_override>` **(** :ref:`String<class_String>` name, :ref:`int<class_int>` constant **)** |
|
||||
| void | :ref:`add_constant_override<class_Control_method_add_constant_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`int<class_int>` constant **)** |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_font_override<class_Control_method_add_font_override>` **(** :ref:`String<class_String>` name, :ref:`Font<class_Font>` font **)** |
|
||||
| void | :ref:`add_font_override<class_Control_method_add_font_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`Font<class_Font>` font **)** |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_icon_override<class_Control_method_add_icon_override>` **(** :ref:`String<class_String>` name, :ref:`Texture<class_Texture>` texture **)** |
|
||||
| void | :ref:`add_icon_override<class_Control_method_add_icon_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`Texture2D<class_Texture2D>` texture **)** |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_shader_override<class_Control_method_add_shader_override>` **(** :ref:`String<class_String>` name, :ref:`Shader<class_Shader>` shader **)** |
|
||||
| void | :ref:`add_shader_override<class_Control_method_add_shader_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`Shader<class_Shader>` shader **)** |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_stylebox_override<class_Control_method_add_stylebox_override>` **(** :ref:`String<class_String>` name, :ref:`StyleBox<class_StyleBox>` stylebox **)** |
|
||||
| void | :ref:`add_stylebox_override<class_Control_method_add_stylebox_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`StyleBox<class_StyleBox>` stylebox **)** |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_drop_data<class_Control_method_can_drop_data>` **(** :ref:`Vector2<class_Vector2>` position, :ref:`Variant<class_Variant>` data **)** virtual |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -144,11 +144,11 @@ Methods
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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 |
|
||||
| :ref:`Color<class_Color>` | :ref:`get_color<class_Control_method_get_color>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_combined_minimum_size<class_Control_method_get_combined_minimum_size>` **(** **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_constant<class_Control_method_get_constant>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const |
|
||||
| :ref:`int<class_int>` | :ref:`get_constant<class_Control_method_get_constant>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`CursorShape<enum_Control_CursorShape>` | :ref:`get_cursor_shape<class_Control_method_get_cursor_shape>` **(** :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -160,11 +160,11 @@ Methods
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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 |
|
||||
| :ref:`Font<class_Font>` | :ref:`get_font<class_Control_method_get_font>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`get_global_rect<class_Control_method_get_global_rect>` **(** **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`get_icon<class_Control_method_get_icon>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const |
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`get_icon<class_Control_method_get_icon>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_margin<class_Control_method_get_margin>` **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -178,7 +178,7 @@ Methods
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_rotation<class_Control_method_get_rotation>` **(** **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`get_stylebox<class_Control_method_get_stylebox>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const |
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`get_stylebox<class_Control_method_get_stylebox>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_tooltip<class_Control_method_get_tooltip>` **(** :ref:`Vector2<class_Vector2>` at_position=Vector2( 0, 0 ) **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -186,31 +186,31 @@ Methods
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`grab_focus<class_Control_method_grab_focus>` **(** **)** |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_color<class_Control_method_has_color>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const |
|
||||
| :ref:`bool<class_bool>` | :ref:`has_color<class_Control_method_has_color>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_color_override<class_Control_method_has_color_override>` **(** :ref:`String<class_String>` name **)** const |
|
||||
| :ref:`bool<class_bool>` | :ref:`has_color_override<class_Control_method_has_color_override>` **(** :ref:`StringName<class_StringName>` name **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_constant<class_Control_method_has_constant>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const |
|
||||
| :ref:`bool<class_bool>` | :ref:`has_constant<class_Control_method_has_constant>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_constant_override<class_Control_method_has_constant_override>` **(** :ref:`String<class_String>` name **)** const |
|
||||
| :ref:`bool<class_bool>` | :ref:`has_constant_override<class_Control_method_has_constant_override>` **(** :ref:`StringName<class_StringName>` name **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_focus<class_Control_method_has_focus>` **(** **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_font<class_Control_method_has_font>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const |
|
||||
| :ref:`bool<class_bool>` | :ref:`has_font<class_Control_method_has_font>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_font_override<class_Control_method_has_font_override>` **(** :ref:`String<class_String>` name **)** const |
|
||||
| :ref:`bool<class_bool>` | :ref:`has_font_override<class_Control_method_has_font_override>` **(** :ref:`StringName<class_StringName>` name **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_icon<class_Control_method_has_icon>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const |
|
||||
| :ref:`bool<class_bool>` | :ref:`has_icon<class_Control_method_has_icon>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_icon_override<class_Control_method_has_icon_override>` **(** :ref:`String<class_String>` name **)** const |
|
||||
| :ref:`bool<class_bool>` | :ref:`has_icon_override<class_Control_method_has_icon_override>` **(** :ref:`StringName<class_StringName>` name **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_point<class_Control_method_has_point>` **(** :ref:`Vector2<class_Vector2>` point **)** virtual |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_shader_override<class_Control_method_has_shader_override>` **(** :ref:`String<class_String>` name **)** const |
|
||||
| :ref:`bool<class_bool>` | :ref:`has_shader_override<class_Control_method_has_shader_override>` **(** :ref:`StringName<class_StringName>` name **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_stylebox<class_Control_method_has_stylebox>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const |
|
||||
| :ref:`bool<class_bool>` | :ref:`has_stylebox<class_Control_method_has_stylebox>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_stylebox_override<class_Control_method_has_stylebox_override>` **(** :ref:`String<class_String>` name **)** const |
|
||||
| :ref:`bool<class_bool>` | :ref:`has_stylebox_override<class_Control_method_has_stylebox_override>` **(** :ref:`StringName<class_StringName>` name **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`minimum_size_changed<class_Control_method_minimum_size_changed>` **(** **)** |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -1223,7 +1223,7 @@ Marks an input event as handled. Once you accept an input event, it stops propag
|
||||
|
||||
.. _class_Control_method_add_color_override:
|
||||
|
||||
- void **add_color_override** **(** :ref:`String<class_String>` name, :ref:`Color<class_Color>` color **)**
|
||||
- void **add_color_override** **(** :ref:`StringName<class_StringName>` name, :ref:`Color<class_Color>` color **)**
|
||||
|
||||
Overrides the :ref:`Color<class_Color>` with given ``name`` in the :ref:`theme<class_Control_property_theme>` resource the control uses. If the ``color`` is empty or invalid, the override is cleared and the color from assigned :ref:`Theme<class_Theme>` is used.
|
||||
|
||||
@@ -1231,7 +1231,7 @@ Overrides the :ref:`Color<class_Color>` with given ``name`` in the :ref:`theme<c
|
||||
|
||||
.. _class_Control_method_add_constant_override:
|
||||
|
||||
- void **add_constant_override** **(** :ref:`String<class_String>` name, :ref:`int<class_int>` constant **)**
|
||||
- void **add_constant_override** **(** :ref:`StringName<class_StringName>` name, :ref:`int<class_int>` constant **)**
|
||||
|
||||
Overrides an integer constant with given ``name`` in the :ref:`theme<class_Control_property_theme>` resource the control uses. If the ``constant`` is empty or invalid, the override is cleared and the constant from assigned :ref:`Theme<class_Theme>` is used.
|
||||
|
||||
@@ -1239,7 +1239,7 @@ Overrides an integer constant with given ``name`` in the :ref:`theme<class_Contr
|
||||
|
||||
.. _class_Control_method_add_font_override:
|
||||
|
||||
- void **add_font_override** **(** :ref:`String<class_String>` name, :ref:`Font<class_Font>` font **)**
|
||||
- void **add_font_override** **(** :ref:`StringName<class_StringName>` name, :ref:`Font<class_Font>` font **)**
|
||||
|
||||
Overrides the font with given ``name`` in the :ref:`theme<class_Control_property_theme>` resource the control uses. If ``font`` is empty or invalid, the override is cleared and the font from assigned :ref:`Theme<class_Theme>` is used.
|
||||
|
||||
@@ -1247,7 +1247,7 @@ Overrides the font with given ``name`` in the :ref:`theme<class_Control_property
|
||||
|
||||
.. _class_Control_method_add_icon_override:
|
||||
|
||||
- void **add_icon_override** **(** :ref:`String<class_String>` name, :ref:`Texture<class_Texture>` texture **)**
|
||||
- void **add_icon_override** **(** :ref:`StringName<class_StringName>` name, :ref:`Texture2D<class_Texture2D>` texture **)**
|
||||
|
||||
Overrides the icon with given ``name`` in the :ref:`theme<class_Control_property_theme>` resource the control uses. If ``icon`` is empty or invalid, the override is cleared and the icon from assigned :ref:`Theme<class_Theme>` is used.
|
||||
|
||||
@@ -1255,7 +1255,7 @@ Overrides the icon with given ``name`` in the :ref:`theme<class_Control_property
|
||||
|
||||
.. _class_Control_method_add_shader_override:
|
||||
|
||||
- void **add_shader_override** **(** :ref:`String<class_String>` name, :ref:`Shader<class_Shader>` shader **)**
|
||||
- void **add_shader_override** **(** :ref:`StringName<class_StringName>` name, :ref:`Shader<class_Shader>` shader **)**
|
||||
|
||||
Overrides the :ref:`Shader<class_Shader>` with given ``name`` in the :ref:`theme<class_Control_property_theme>` resource the control uses. If ``shader`` is empty or invalid, the override is cleared and the shader from assigned :ref:`Theme<class_Theme>` is used.
|
||||
|
||||
@@ -1263,7 +1263,7 @@ Overrides the :ref:`Shader<class_Shader>` with given ``name`` in the :ref:`theme
|
||||
|
||||
.. _class_Control_method_add_stylebox_override:
|
||||
|
||||
- void **add_stylebox_override** **(** :ref:`String<class_String>` name, :ref:`StyleBox<class_StyleBox>` stylebox **)**
|
||||
- void **add_stylebox_override** **(** :ref:`StringName<class_StringName>` name, :ref:`StyleBox<class_StyleBox>` stylebox **)**
|
||||
|
||||
Overrides the :ref:`StyleBox<class_StyleBox>` with given ``name`` in the :ref:`theme<class_Control_property_theme>` resource the control uses. If ``stylebox`` is empty or invalid, the override is cleared and the :ref:`StyleBox<class_StyleBox>` from assigned :ref:`Theme<class_Theme>` is used.
|
||||
|
||||
@@ -1330,7 +1330,7 @@ Returns :ref:`margin_left<class_Control_property_margin_left>` and :ref:`margin_
|
||||
|
||||
.. _class_Control_method_get_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **get_color** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
|
||||
- :ref:`Color<class_Color>` **get_color** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const
|
||||
|
||||
Returns a color from assigned :ref:`Theme<class_Theme>` with given ``name`` and associated with ``Control`` of given ``type``.
|
||||
|
||||
@@ -1351,7 +1351,7 @@ Returns combined minimum size from :ref:`rect_min_size<class_Control_property_re
|
||||
|
||||
.. _class_Control_method_get_constant:
|
||||
|
||||
- :ref:`int<class_int>` **get_constant** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
|
||||
- :ref:`int<class_int>` **get_constant** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const
|
||||
|
||||
Returns a constant from assigned :ref:`Theme<class_Theme>` with given ``name`` and associated with ``Control`` of given ``type``.
|
||||
|
||||
@@ -1408,7 +1408,7 @@ Returns the control that has the keyboard focus or ``null`` if none.
|
||||
|
||||
.. _class_Control_method_get_font:
|
||||
|
||||
- :ref:`Font<class_Font>` **get_font** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
|
||||
- :ref:`Font<class_Font>` **get_font** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const
|
||||
|
||||
Returns a font from assigned :ref:`Theme<class_Theme>` with given ``name`` and associated with ``Control`` of given ``type``.
|
||||
|
||||
@@ -1424,7 +1424,7 @@ Returns the position and size of the control relative to the top-left corner of
|
||||
|
||||
.. _class_Control_method_get_icon:
|
||||
|
||||
- :ref:`Texture<class_Texture>` **get_icon** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
|
||||
- :ref:`Texture2D<class_Texture2D>` **get_icon** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const
|
||||
|
||||
Returns an icon from assigned :ref:`Theme<class_Theme>` with given ``name`` and associated with ``Control`` of given ``type``.
|
||||
|
||||
@@ -1480,7 +1480,7 @@ Returns the rotation (in radians).
|
||||
|
||||
.. _class_Control_method_get_stylebox:
|
||||
|
||||
- :ref:`StyleBox<class_StyleBox>` **get_stylebox** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
|
||||
- :ref:`StyleBox<class_StyleBox>` **get_stylebox** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const
|
||||
|
||||
Returns a :ref:`StyleBox<class_StyleBox>` from assigned :ref:`Theme<class_Theme>` with given ``name`` and associated with ``Control`` of given ``type``.
|
||||
|
||||
@@ -1517,7 +1517,7 @@ Steal the focus from another control and become the focused control (see :ref:`f
|
||||
|
||||
.. _class_Control_method_has_color:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_color** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
|
||||
- :ref:`bool<class_bool>` **has_color** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const
|
||||
|
||||
Returns ``true`` if :ref:`Color<class_Color>` with given ``name`` and associated with ``Control`` of given ``type`` exists in assigned :ref:`Theme<class_Theme>`.
|
||||
|
||||
@@ -1525,7 +1525,7 @@ Returns ``true`` if :ref:`Color<class_Color>` with given ``name`` and associated
|
||||
|
||||
.. _class_Control_method_has_color_override:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_color_override** **(** :ref:`String<class_String>` name **)** const
|
||||
- :ref:`bool<class_bool>` **has_color_override** **(** :ref:`StringName<class_StringName>` name **)** const
|
||||
|
||||
Returns ``true`` if :ref:`Color<class_Color>` with given ``name`` has a valid override in this ``Control`` node.
|
||||
|
||||
@@ -1533,7 +1533,7 @@ Returns ``true`` if :ref:`Color<class_Color>` with given ``name`` has a valid ov
|
||||
|
||||
.. _class_Control_method_has_constant:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_constant** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
|
||||
- :ref:`bool<class_bool>` **has_constant** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const
|
||||
|
||||
Returns ``true`` if constant with given ``name`` and associated with ``Control`` of given ``type`` exists in assigned :ref:`Theme<class_Theme>`.
|
||||
|
||||
@@ -1541,7 +1541,7 @@ Returns ``true`` if constant with given ``name`` and associated with ``Control``
|
||||
|
||||
.. _class_Control_method_has_constant_override:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_constant_override** **(** :ref:`String<class_String>` name **)** const
|
||||
- :ref:`bool<class_bool>` **has_constant_override** **(** :ref:`StringName<class_StringName>` name **)** const
|
||||
|
||||
Returns ``true`` if constant with given ``name`` has a valid override in this ``Control`` node.
|
||||
|
||||
@@ -1557,7 +1557,7 @@ Returns ``true`` if this is the current focused control. See :ref:`focus_mode<cl
|
||||
|
||||
.. _class_Control_method_has_font:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_font** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
|
||||
- :ref:`bool<class_bool>` **has_font** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const
|
||||
|
||||
Returns ``true`` if font with given ``name`` and associated with ``Control`` of given ``type`` exists in assigned :ref:`Theme<class_Theme>`.
|
||||
|
||||
@@ -1565,7 +1565,7 @@ Returns ``true`` if font with given ``name`` and associated with ``Control`` of
|
||||
|
||||
.. _class_Control_method_has_font_override:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_font_override** **(** :ref:`String<class_String>` name **)** const
|
||||
- :ref:`bool<class_bool>` **has_font_override** **(** :ref:`StringName<class_StringName>` name **)** const
|
||||
|
||||
Returns ``true`` if font with given ``name`` has a valid override in this ``Control`` node.
|
||||
|
||||
@@ -1573,7 +1573,7 @@ Returns ``true`` if font with given ``name`` has a valid override in this ``Cont
|
||||
|
||||
.. _class_Control_method_has_icon:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_icon** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
|
||||
- :ref:`bool<class_bool>` **has_icon** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const
|
||||
|
||||
Returns ``true`` if icon with given ``name`` and associated with ``Control`` of given ``type`` exists in assigned :ref:`Theme<class_Theme>`.
|
||||
|
||||
@@ -1581,7 +1581,7 @@ Returns ``true`` if icon with given ``name`` and associated with ``Control`` of
|
||||
|
||||
.. _class_Control_method_has_icon_override:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_icon_override** **(** :ref:`String<class_String>` name **)** const
|
||||
- :ref:`bool<class_bool>` **has_icon_override** **(** :ref:`StringName<class_StringName>` name **)** const
|
||||
|
||||
Returns ``true`` if icon with given ``name`` has a valid override in this ``Control`` node.
|
||||
|
||||
@@ -1601,7 +1601,7 @@ If not overridden, default behavior is checking if the point is within control's
|
||||
|
||||
.. _class_Control_method_has_shader_override:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_shader_override** **(** :ref:`String<class_String>` name **)** const
|
||||
- :ref:`bool<class_bool>` **has_shader_override** **(** :ref:`StringName<class_StringName>` name **)** const
|
||||
|
||||
Returns ``true`` if :ref:`Shader<class_Shader>` with given ``name`` has a valid override in this ``Control`` node.
|
||||
|
||||
@@ -1609,7 +1609,7 @@ Returns ``true`` if :ref:`Shader<class_Shader>` with given ``name`` has a valid
|
||||
|
||||
.. _class_Control_method_has_stylebox:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_stylebox** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
|
||||
- :ref:`bool<class_bool>` **has_stylebox** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` type="" **)** const
|
||||
|
||||
Returns ``true`` if :ref:`StyleBox<class_StyleBox>` with given ``name`` and associated with ``Control`` of given ``type`` exists in assigned :ref:`Theme<class_Theme>`.
|
||||
|
||||
@@ -1617,7 +1617,7 @@ Returns ``true`` if :ref:`StyleBox<class_StyleBox>` with given ``name`` and asso
|
||||
|
||||
.. _class_Control_method_has_stylebox_override:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_stylebox_override** **(** :ref:`String<class_String>` name **)** const
|
||||
- :ref:`bool<class_bool>` **has_stylebox_override** **(** :ref:`StringName<class_StringName>` name **)** const
|
||||
|
||||
Returns ``true`` if :ref:`StyleBox<class_StyleBox>` with given ``name`` has a valid override in this ``Control`` node.
|
||||
|
||||
|
||||
@@ -21,24 +21,24 @@ Convex polygon shape resource, which can be added to a :ref:`PhysicsBody<class_P
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------------+---------------------------------------------------------+--------------------------+
|
||||
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`points<class_ConvexPolygonShape_property_points>` | ``PoolVector3Array( )`` |
|
||||
+-------------------------------------------------+---------------------------------------------------------+--------------------------+
|
||||
+-----------------------------------------------------+---------------------------------------------------------+----------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`points<class_ConvexPolygonShape_property_points>` | ``PackedVector3Array( )`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------+----------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_ConvexPolygonShape_property_points:
|
||||
|
||||
- :ref:`PoolVector3Array<class_PoolVector3Array>` **points**
|
||||
- :ref:`PackedVector3Array<class_PackedVector3Array>` **points**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | ``PoolVector3Array( )`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_points(value) |
|
||||
+-----------+--------------------------+
|
||||
| *Getter* | get_points() |
|
||||
+-----------+--------------------------+
|
||||
+-----------+----------------------------+
|
||||
| *Default* | ``PackedVector3Array( )`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_points(value) |
|
||||
+-----------+----------------------------+
|
||||
| *Getter* | get_points() |
|
||||
+-----------+----------------------------+
|
||||
|
||||
The list of 3D points forming the convex polygon shape.
|
||||
|
||||
|
||||
@@ -23,31 +23,31 @@ The main difference between a ``ConvexPolygonShape2D`` and a :ref:`ConcavePolygo
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------------+-----------------------------------------------------------+--------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`points<class_ConvexPolygonShape2D_property_points>` | ``PoolVector2Array( )`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------+--------------------------+
|
||||
+-----------------------------------------------------+-----------------------------------------------------------+----------------------------+
|
||||
| :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`points<class_ConvexPolygonShape2D_property_points>` | ``PackedVector2Array( )`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------+----------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_cloud<class_ConvexPolygonShape2D_method_set_point_cloud>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` point_cloud **)** |
|
||||
+------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_cloud<class_ConvexPolygonShape2D_method_set_point_cloud>` **(** :ref:`PackedVector2Array<class_PackedVector2Array>` point_cloud **)** |
|
||||
+------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_ConvexPolygonShape2D_property_points:
|
||||
|
||||
- :ref:`PoolVector2Array<class_PoolVector2Array>` **points**
|
||||
- :ref:`PackedVector2Array<class_PackedVector2Array>` **points**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | ``PoolVector2Array( )`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_points(value) |
|
||||
+-----------+--------------------------+
|
||||
| *Getter* | get_points() |
|
||||
+-----------+--------------------------+
|
||||
+-----------+----------------------------+
|
||||
| *Default* | ``PackedVector2Array( )`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_points(value) |
|
||||
+-----------+----------------------------+
|
||||
| *Getter* | get_points() |
|
||||
+-----------+----------------------------+
|
||||
|
||||
The polygon's list of vertices. Can be in either clockwise or counterclockwise order.
|
||||
|
||||
@@ -56,7 +56,7 @@ Method Descriptions
|
||||
|
||||
.. _class_ConvexPolygonShape2D_method_set_point_cloud:
|
||||
|
||||
- void **set_point_cloud** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` point_cloud **)**
|
||||
- void **set_point_cloud** **(** :ref:`PackedVector2Array<class_PackedVector2Array>` point_cloud **)**
|
||||
|
||||
Based on the set of points provided, this creates and assigns the :ref:`points<class_ConvexPolygonShape2D_property_points>` property using the convex hull algorithm. Removing all unneeded points. See :ref:`Geometry.convex_hull_2d<class_Geometry_method_convex_hull_2d>` for details.
|
||||
|
||||
|
||||
@@ -23,135 +23,135 @@ See also :ref:`Particles<class_Particles>`, which provides the same functionalit
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`amount<class_CPUParticles_property_amount>` | ``8`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angle<class_CPUParticles_property_angle>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`damping<class_CPUParticles_property_damping>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :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`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`direction<class_CPUParticles_property_direction>` | ``Vector3( 1, 0, 0 )`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`DrawOrder<enum_CPUParticles_DrawOrder>` | :ref:`draw_order<class_CPUParticles_property_draw_order>` | ``0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`emission_box_extents<class_CPUParticles_property_emission_box_extents>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`PoolColorArray<class_PoolColorArray>` | :ref:`emission_colors<class_CPUParticles_property_emission_colors>` | ``PoolColorArray( )`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`emission_normals<class_CPUParticles_property_emission_normals>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`emission_points<class_CPUParticles_property_emission_points>` | ``PoolVector3Array( )`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` | :ref:`emission_shape<class_CPUParticles_property_emission_shape>` | ``0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`emission_sphere_radius<class_CPUParticles_property_emission_sphere_radius>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`emitting<class_CPUParticles_property_emitting>` | ``true`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`explosiveness<class_CPUParticles_property_explosiveness>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`fixed_fps<class_CPUParticles_property_fixed_fps>` | ``0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flag_align_y<class_CPUParticles_property_flag_align_y>` | ``false`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flag_disable_z<class_CPUParticles_property_flag_disable_z>` | ``false`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flag_rotate_y<class_CPUParticles_property_flag_rotate_y>` | ``false`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`flatness<class_CPUParticles_property_flatness>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`fract_delta<class_CPUParticles_property_fract_delta>` | ``true`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`gravity<class_CPUParticles_property_gravity>` | ``Vector3( 0, -9.8, 0 )`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`hue_variation_random<class_CPUParticles_property_hue_variation_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`initial_velocity<class_CPUParticles_property_initial_velocity>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`initial_velocity_random<class_CPUParticles_property_initial_velocity_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`one_shot<class_CPUParticles_property_one_shot>` | ``false`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`orbit_velocity<class_CPUParticles_property_orbit_velocity>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`orbit_velocity_curve<class_CPUParticles_property_orbit_velocity_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`orbit_velocity_random<class_CPUParticles_property_orbit_velocity_random>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`preprocess<class_CPUParticles_property_preprocess>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`radial_accel_random<class_CPUParticles_property_radial_accel_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`randomness<class_CPUParticles_property_randomness>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`scale_amount_random<class_CPUParticles_property_scale_amount_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`speed_scale<class_CPUParticles_property_speed_scale>` | ``1.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`spread<class_CPUParticles_property_spread>` | ``45.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tangential_accel_random<class_CPUParticles_property_tangential_accel_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`amount<class_CPUParticles_property_amount>` | ``8`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angle<class_CPUParticles_property_angle>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`damping<class_CPUParticles_property_damping>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :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`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`direction<class_CPUParticles_property_direction>` | ``Vector3( 1, 0, 0 )`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`DrawOrder<enum_CPUParticles_DrawOrder>` | :ref:`draw_order<class_CPUParticles_property_draw_order>` | ``0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`emission_box_extents<class_CPUParticles_property_emission_box_extents>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`PackedColorArray<class_PackedColorArray>` | :ref:`emission_colors<class_CPUParticles_property_emission_colors>` | ``PackedColorArray( )`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`emission_normals<class_CPUParticles_property_emission_normals>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`emission_points<class_CPUParticles_property_emission_points>` | ``PackedVector3Array( )`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` | :ref:`emission_shape<class_CPUParticles_property_emission_shape>` | ``0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`emission_sphere_radius<class_CPUParticles_property_emission_sphere_radius>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`emitting<class_CPUParticles_property_emitting>` | ``true`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`explosiveness<class_CPUParticles_property_explosiveness>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`fixed_fps<class_CPUParticles_property_fixed_fps>` | ``0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flag_align_y<class_CPUParticles_property_flag_align_y>` | ``false`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flag_disable_z<class_CPUParticles_property_flag_disable_z>` | ``false`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flag_rotate_y<class_CPUParticles_property_flag_rotate_y>` | ``false`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`flatness<class_CPUParticles_property_flatness>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`fract_delta<class_CPUParticles_property_fract_delta>` | ``true`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`gravity<class_CPUParticles_property_gravity>` | ``Vector3( 0, -9.8, 0 )`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`hue_variation_random<class_CPUParticles_property_hue_variation_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`initial_velocity<class_CPUParticles_property_initial_velocity>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`initial_velocity_random<class_CPUParticles_property_initial_velocity_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`one_shot<class_CPUParticles_property_one_shot>` | ``false`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`orbit_velocity<class_CPUParticles_property_orbit_velocity>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`orbit_velocity_curve<class_CPUParticles_property_orbit_velocity_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`orbit_velocity_random<class_CPUParticles_property_orbit_velocity_random>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`preprocess<class_CPUParticles_property_preprocess>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`radial_accel_random<class_CPUParticles_property_radial_accel_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`randomness<class_CPUParticles_property_randomness>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`scale_amount_random<class_CPUParticles_property_scale_amount_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`speed_scale<class_CPUParticles_property_speed_scale>` | ``1.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`spread<class_CPUParticles_property_spread>` | ``45.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :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>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tangential_accel_random<class_CPUParticles_property_tangential_accel_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -634,10 +634,10 @@ The rectangle's extents if :ref:`emission_shape<class_CPUParticles_property_emis
|
||||
|
||||
.. _class_CPUParticles_property_emission_colors:
|
||||
|
||||
- :ref:`PoolColorArray<class_PoolColorArray>` **emission_colors**
|
||||
- :ref:`PackedColorArray<class_PackedColorArray>` **emission_colors**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | ``PoolColorArray( )`` |
|
||||
| *Default* | ``PackedColorArray( )`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_emission_colors(value) |
|
||||
+-----------+----------------------------+
|
||||
@@ -650,7 +650,7 @@ Sets the :ref:`Color<class_Color>`\ s to modulate particles by when using :ref:`
|
||||
|
||||
.. _class_CPUParticles_property_emission_normals:
|
||||
|
||||
- :ref:`PoolVector3Array<class_PoolVector3Array>` **emission_normals**
|
||||
- :ref:`PackedVector3Array<class_PackedVector3Array>` **emission_normals**
|
||||
|
||||
+----------+-----------------------------+
|
||||
| *Setter* | set_emission_normals(value) |
|
||||
@@ -664,10 +664,10 @@ Sets the direction the particles will be emitted in when using :ref:`EMISSION_SH
|
||||
|
||||
.. _class_CPUParticles_property_emission_points:
|
||||
|
||||
- :ref:`PoolVector3Array<class_PoolVector3Array>` **emission_points**
|
||||
- :ref:`PackedVector3Array<class_PackedVector3Array>` **emission_points**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | ``PoolVector3Array( )`` |
|
||||
| *Default* | ``PackedVector3Array( )`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_emission_points(value) |
|
||||
+-----------+----------------------------+
|
||||
|
||||
@@ -69,11 +69,11 @@ Properties
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` | :ref:`draw_order<class_CPUParticles2D_property_draw_order>` | ``0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`PoolColorArray<class_PoolColorArray>` | :ref:`emission_colors<class_CPUParticles2D_property_emission_colors>` | |
|
||||
| :ref:`PackedColorArray<class_PackedColorArray>` | :ref:`emission_colors<class_CPUParticles2D_property_emission_colors>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`emission_normals<class_CPUParticles2D_property_emission_normals>` | |
|
||||
| :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`emission_normals<class_CPUParticles2D_property_emission_normals>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`emission_points<class_CPUParticles2D_property_emission_points>` | |
|
||||
| :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`emission_points<class_CPUParticles2D_property_emission_points>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`emission_rect_extents<class_CPUParticles2D_property_emission_rect_extents>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
@@ -115,7 +115,7 @@ Properties
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`local_coords<class_CPUParticles2D_property_local_coords>` | ``true`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`normalmap<class_CPUParticles2D_property_normalmap>` | |
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`normalmap<class_CPUParticles2D_property_normalmap>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`one_shot<class_CPUParticles2D_property_one_shot>` | ``false`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
@@ -151,7 +151,7 @@ Properties
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :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>` | |
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`texture<class_CPUParticles2D_property_texture>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
|
||||
Methods
|
||||
@@ -617,7 +617,7 @@ Particle draw order. Uses :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` values
|
||||
|
||||
.. _class_CPUParticles2D_property_emission_colors:
|
||||
|
||||
- :ref:`PoolColorArray<class_PoolColorArray>` **emission_colors**
|
||||
- :ref:`PackedColorArray<class_PackedColorArray>` **emission_colors**
|
||||
|
||||
+----------+----------------------------+
|
||||
| *Setter* | set_emission_colors(value) |
|
||||
@@ -631,7 +631,7 @@ Sets the :ref:`Color<class_Color>`\ s to modulate particles by when using :ref:`
|
||||
|
||||
.. _class_CPUParticles2D_property_emission_normals:
|
||||
|
||||
- :ref:`PoolVector2Array<class_PoolVector2Array>` **emission_normals**
|
||||
- :ref:`PackedVector2Array<class_PackedVector2Array>` **emission_normals**
|
||||
|
||||
+----------+-----------------------------+
|
||||
| *Setter* | set_emission_normals(value) |
|
||||
@@ -645,7 +645,7 @@ Sets the direction the particles will be emitted in when using :ref:`EMISSION_SH
|
||||
|
||||
.. _class_CPUParticles2D_property_emission_points:
|
||||
|
||||
- :ref:`PoolVector2Array<class_PoolVector2Array>` **emission_points**
|
||||
- :ref:`PackedVector2Array<class_PackedVector2Array>` **emission_points**
|
||||
|
||||
+----------+----------------------------+
|
||||
| *Setter* | set_emission_points(value) |
|
||||
@@ -971,7 +971,7 @@ If ``true``, particles use the parent node's coordinate space. If ``false``, the
|
||||
|
||||
.. _class_CPUParticles2D_property_normalmap:
|
||||
|
||||
- :ref:`Texture<class_Texture>` **normalmap**
|
||||
- :ref:`Texture2D<class_Texture2D>` **normalmap**
|
||||
|
||||
+----------+----------------------+
|
||||
| *Setter* | set_normalmap(value) |
|
||||
@@ -1249,7 +1249,7 @@ Tangential acceleration randomness ratio.
|
||||
|
||||
.. _class_CPUParticles2D_property_texture:
|
||||
|
||||
- :ref:`Texture<class_Texture>` **texture**
|
||||
- :ref:`Texture2D<class_Texture2D>` **texture**
|
||||
|
||||
+----------+--------------------+
|
||||
| *Setter* | set_texture(value) |
|
||||
|
||||
@@ -43,7 +43,7 @@ Methods
|
||||
-------
|
||||
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`generate_random_bytes<class_Crypto_method_generate_random_bytes>` **(** :ref:`int<class_int>` size **)** |
|
||||
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`generate_random_bytes<class_Crypto_method_generate_random_bytes>` **(** :ref:`int<class_int>` size **)** |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`CryptoKey<class_CryptoKey>` | :ref:`generate_rsa<class_Crypto_method_generate_rsa>` **(** :ref:`int<class_int>` size **)** |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -55,9 +55,9 @@ Method Descriptions
|
||||
|
||||
.. _class_Crypto_method_generate_random_bytes:
|
||||
|
||||
- :ref:`PoolByteArray<class_PoolByteArray>` **generate_random_bytes** **(** :ref:`int<class_int>` size **)**
|
||||
- :ref:`PackedByteArray<class_PackedByteArray>` **generate_random_bytes** **(** :ref:`int<class_int>` size **)**
|
||||
|
||||
Generates a :ref:`PoolByteArray<class_PoolByteArray>` of cryptographically secure random bytes with given ``size``.
|
||||
Generates a :ref:`PackedByteArray<class_PackedByteArray>` of cryptographically secure random bytes with given ``size``.
|
||||
|
||||
----
|
||||
|
||||
|
||||
@@ -21,33 +21,33 @@ This node takes a 2D polygon shape and extrudes it to create a 3D mesh.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`depth<class_CSGPolygon_property_depth>` | ``1.0`` |
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+
|
||||
| :ref:`Material<class_Material>` | :ref:`material<class_CSGPolygon_property_material>` | |
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+
|
||||
| :ref:`Mode<enum_CSGPolygon_Mode>` | :ref:`mode<class_CSGPolygon_property_mode>` | ``0`` |
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`path_continuous_u<class_CSGPolygon_property_path_continuous_u>` | |
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`path_interval<class_CSGPolygon_property_path_interval>` | |
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`path_joined<class_CSGPolygon_property_path_joined>` | |
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`path_local<class_CSGPolygon_property_path_local>` | |
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`path_node<class_CSGPolygon_property_path_node>` | |
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+
|
||||
| :ref:`PathRotation<enum_CSGPolygon_PathRotation>` | :ref:`path_rotation<class_CSGPolygon_property_path_rotation>` | |
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`polygon<class_CSGPolygon_property_polygon>` | ``PoolVector2Array( 0, 0, 0, 1, 1, 1, 1, 0 )`` |
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`smooth_faces<class_CSGPolygon_property_smooth_faces>` | ``false`` |
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`spin_degrees<class_CSGPolygon_property_spin_degrees>` | |
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`spin_sides<class_CSGPolygon_property_spin_sides>` | |
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`depth<class_CSGPolygon_property_depth>` | ``1.0`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+
|
||||
| :ref:`Material<class_Material>` | :ref:`material<class_CSGPolygon_property_material>` | |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+
|
||||
| :ref:`Mode<enum_CSGPolygon_Mode>` | :ref:`mode<class_CSGPolygon_property_mode>` | ``0`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`path_continuous_u<class_CSGPolygon_property_path_continuous_u>` | |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`path_interval<class_CSGPolygon_property_path_interval>` | |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`path_joined<class_CSGPolygon_property_path_joined>` | |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`path_local<class_CSGPolygon_property_path_local>` | |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`path_node<class_CSGPolygon_property_path_node>` | |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+
|
||||
| :ref:`PathRotation<enum_CSGPolygon_PathRotation>` | :ref:`path_rotation<class_CSGPolygon_property_path_rotation>` | |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+
|
||||
| :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`polygon<class_CSGPolygon_property_polygon>` | ``PackedVector2Array( 0, 0, 0, 1, 1, 1, 1, 0 )`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`smooth_faces<class_CSGPolygon_property_smooth_faces>` | ``false`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`spin_degrees<class_CSGPolygon_property_spin_degrees>` | |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`spin_sides<class_CSGPolygon_property_spin_sides>` | |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
@@ -221,15 +221,15 @@ The method by which each slice is rotated along the path when :ref:`mode<class_C
|
||||
|
||||
.. _class_CSGPolygon_property_polygon:
|
||||
|
||||
- :ref:`PoolVector2Array<class_PoolVector2Array>` **polygon**
|
||||
- :ref:`PackedVector2Array<class_PackedVector2Array>` **polygon**
|
||||
|
||||
+-----------+------------------------------------------------+
|
||||
| *Default* | ``PoolVector2Array( 0, 0, 0, 1, 1, 1, 1, 0 )`` |
|
||||
+-----------+------------------------------------------------+
|
||||
| *Setter* | set_polygon(value) |
|
||||
+-----------+------------------------------------------------+
|
||||
| *Getter* | get_polygon() |
|
||||
+-----------+------------------------------------------------+
|
||||
+-----------+--------------------------------------------------+
|
||||
| *Default* | ``PackedVector2Array( 0, 0, 0, 1, 1, 1, 1, 0 )`` |
|
||||
+-----------+--------------------------------------------------+
|
||||
| *Setter* | set_polygon(value) |
|
||||
+-----------+--------------------------------------------------+
|
||||
| *Getter* | get_polygon() |
|
||||
+-----------+--------------------------------------------------+
|
||||
|
||||
Point array that defines the shape that we'll extrude.
|
||||
|
||||
|
||||
@@ -16,14 +16,14 @@ CSharpScript
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-----------------------------+------------------------------------------------------------------+
|
||||
| :ref:`Object<class_Object>` | :ref:`new<class_CSharpScript_method_new>` **(** ... **)** vararg |
|
||||
+-----------------------------+------------------------------------------------------------------+
|
||||
+-------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`new<class_CSharpScript_method_new>` **(** ... **)** vararg |
|
||||
+-------------------------------+------------------------------------------------------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_CSharpScript_method_new:
|
||||
|
||||
- :ref:`Object<class_Object>` **new** **(** ... **)** vararg
|
||||
- :ref:`Variant<class_Variant>` **new** **(** ... **)** vararg
|
||||
|
||||
|
||||
@@ -1,197 +1,15 @@
|
||||
:github_url: hide
|
||||
|
||||
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||
.. DO NOT EDIT THIS FILE, but the CubeMap.xml source instead.
|
||||
.. DO NOT EDIT THIS FILE, but the Cubemap.xml source instead.
|
||||
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||||
|
||||
.. _class_CubeMap:
|
||||
.. _class_Cubemap:
|
||||
|
||||
CubeMap
|
||||
Cubemap
|
||||
=======
|
||||
|
||||
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
**Inherits:** :ref:`TextureLayered<class_TextureLayered>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
A CubeMap is a 6-sided 3D texture.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
A 6-sided 3D texture typically used for faking reflections. It can be used to make an object look as if it's reflecting its surroundings. This usually delivers much better performance than other reflection methods.
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+--------------------------------------+----------------------------------------------------------------------------+---------+
|
||||
| :ref:`int<class_int>` | :ref:`flags<class_CubeMap_property_flags>` | ``7`` |
|
||||
+--------------------------------------+----------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`lossy_storage_quality<class_CubeMap_property_lossy_storage_quality>` | ``0.7`` |
|
||||
+--------------------------------------+----------------------------------------------------------------------------+---------+
|
||||
| :ref:`Storage<enum_CubeMap_Storage>` | :ref:`storage_mode<class_CubeMap_property_storage_mode>` | ``0`` |
|
||||
+--------------------------------------+----------------------------------------------------------------------------+---------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_height<class_CubeMap_method_get_height>` **(** **)** const |
|
||||
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Image<class_Image>` | :ref:`get_side<class_CubeMap_method_get_side>` **(** :ref:`Side<enum_CubeMap_Side>` side **)** const |
|
||||
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_width<class_CubeMap_method_get_width>` **(** **)** const |
|
||||
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_side<class_CubeMap_method_set_side>` **(** :ref:`Side<enum_CubeMap_Side>` side, :ref:`Image<class_Image>` image **)** |
|
||||
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_CubeMap_Storage:
|
||||
|
||||
.. _class_CubeMap_constant_STORAGE_RAW:
|
||||
|
||||
.. _class_CubeMap_constant_STORAGE_COMPRESS_LOSSY:
|
||||
|
||||
.. _class_CubeMap_constant_STORAGE_COMPRESS_LOSSLESS:
|
||||
|
||||
enum **Storage**:
|
||||
|
||||
- **STORAGE_RAW** = **0** --- Store the ``CubeMap`` without any compression.
|
||||
|
||||
- **STORAGE_COMPRESS_LOSSY** = **1** --- Store the ``CubeMap`` with strong compression that reduces image quality.
|
||||
|
||||
- **STORAGE_COMPRESS_LOSSLESS** = **2** --- Store the ``CubeMap`` with moderate compression that doesn't reduce image quality.
|
||||
|
||||
----
|
||||
|
||||
.. _enum_CubeMap_Side:
|
||||
|
||||
.. _class_CubeMap_constant_SIDE_LEFT:
|
||||
|
||||
.. _class_CubeMap_constant_SIDE_RIGHT:
|
||||
|
||||
.. _class_CubeMap_constant_SIDE_BOTTOM:
|
||||
|
||||
.. _class_CubeMap_constant_SIDE_TOP:
|
||||
|
||||
.. _class_CubeMap_constant_SIDE_FRONT:
|
||||
|
||||
.. _class_CubeMap_constant_SIDE_BACK:
|
||||
|
||||
enum **Side**:
|
||||
|
||||
- **SIDE_LEFT** = **0** --- Identifier for the left face of the ``CubeMap``.
|
||||
|
||||
- **SIDE_RIGHT** = **1** --- Identifier for the right face of the ``CubeMap``.
|
||||
|
||||
- **SIDE_BOTTOM** = **2** --- Identifier for the bottom face of the ``CubeMap``.
|
||||
|
||||
- **SIDE_TOP** = **3** --- Identifier for the top face of the ``CubeMap``.
|
||||
|
||||
- **SIDE_FRONT** = **4** --- Identifier for the front face of the ``CubeMap``.
|
||||
|
||||
- **SIDE_BACK** = **5** --- Identifier for the back face of the ``CubeMap``.
|
||||
|
||||
----
|
||||
|
||||
.. _enum_CubeMap_Flags:
|
||||
|
||||
.. _class_CubeMap_constant_FLAG_MIPMAPS:
|
||||
|
||||
.. _class_CubeMap_constant_FLAG_REPEAT:
|
||||
|
||||
.. _class_CubeMap_constant_FLAG_FILTER:
|
||||
|
||||
.. _class_CubeMap_constant_FLAGS_DEFAULT:
|
||||
|
||||
enum **Flags**:
|
||||
|
||||
- **FLAG_MIPMAPS** = **1** --- Generate mipmaps, to enable smooth zooming out of the texture.
|
||||
|
||||
- **FLAG_REPEAT** = **2** --- Repeat (instead of clamp to edge).
|
||||
|
||||
- **FLAG_FILTER** = **4** --- Turn on magnifying filter, to enable smooth zooming in of the texture.
|
||||
|
||||
- **FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled.
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CubeMap_property_flags:
|
||||
|
||||
- :ref:`int<class_int>` **flags**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | ``7`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_flags(value) |
|
||||
+-----------+------------------+
|
||||
| *Getter* | get_flags() |
|
||||
+-----------+------------------+
|
||||
|
||||
The render flags for the ``CubeMap``. See the :ref:`Flags<enum_CubeMap_Flags>` constants for details.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CubeMap_property_lossy_storage_quality:
|
||||
|
||||
- :ref:`float<class_float>` **lossy_storage_quality**
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| *Default* | ``0.7`` |
|
||||
+-----------+----------------------------------+
|
||||
| *Setter* | set_lossy_storage_quality(value) |
|
||||
+-----------+----------------------------------+
|
||||
| *Getter* | get_lossy_storage_quality() |
|
||||
+-----------+----------------------------------+
|
||||
|
||||
The lossy storage quality of the ``CubeMap`` if the storage mode is set to :ref:`STORAGE_COMPRESS_LOSSY<class_CubeMap_constant_STORAGE_COMPRESS_LOSSY>`.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CubeMap_property_storage_mode:
|
||||
|
||||
- :ref:`Storage<enum_CubeMap_Storage>` **storage_mode**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+--------------------+
|
||||
| *Setter* | set_storage(value) |
|
||||
+-----------+--------------------+
|
||||
| *Getter* | get_storage() |
|
||||
+-----------+--------------------+
|
||||
|
||||
The ``CubeMap``'s storage mode. See :ref:`Storage<enum_CubeMap_Storage>` constants.
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_CubeMap_method_get_height:
|
||||
|
||||
- :ref:`int<class_int>` **get_height** **(** **)** const
|
||||
|
||||
Returns the ``CubeMap``'s height.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CubeMap_method_get_side:
|
||||
|
||||
- :ref:`Image<class_Image>` **get_side** **(** :ref:`Side<enum_CubeMap_Side>` side **)** const
|
||||
|
||||
Returns an :ref:`Image<class_Image>` for a side of the ``CubeMap`` using one of the :ref:`Side<enum_CubeMap_Side>` constants.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CubeMap_method_get_width:
|
||||
|
||||
- :ref:`int<class_int>` **get_width** **(** **)** const
|
||||
|
||||
Returns the ``CubeMap``'s width.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CubeMap_method_set_side:
|
||||
|
||||
- void **set_side** **(** :ref:`Side<enum_CubeMap_Side>` side, :ref:`Image<class_Image>` image **)**
|
||||
|
||||
Sets an :ref:`Image<class_Image>` for a side of the ``CubeMap`` using one of the :ref:`Side<enum_CubeMap_Side>` constants.
|
||||
|
||||
|
||||
15
classes/class_cubemaparray.rst
Normal file
15
classes/class_cubemaparray.rst
Normal file
@@ -0,0 +1,15 @@
|
||||
:github_url: hide
|
||||
|
||||
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||
.. DO NOT EDIT THIS FILE, but the CubemapArray.xml source instead.
|
||||
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||||
|
||||
.. _class_CubemapArray:
|
||||
|
||||
CubemapArray
|
||||
============
|
||||
|
||||
**Inherits:** :ref:`TextureLayered<class_TextureLayered>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
|
||||
|
||||
@@ -30,43 +30,43 @@ Properties
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_point<class_Curve2D_method_add_point>` **(** :ref:`Vector2<class_Vector2>` position, :ref:`Vector2<class_Vector2>` in=Vector2( 0, 0 ), :ref:`Vector2<class_Vector2>` out=Vector2( 0, 0 ), :ref:`int<class_int>` at_position=-1 **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_points<class_Curve2D_method_clear_points>` **(** **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_baked_length<class_Curve2D_method_get_baked_length>` **(** **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`get_baked_points<class_Curve2D_method_get_baked_points>` **(** **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_closest_offset<class_Curve2D_method_get_closest_offset>` **(** :ref:`Vector2<class_Vector2>` to_point **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_closest_point<class_Curve2D_method_get_closest_point>` **(** :ref:`Vector2<class_Vector2>` to_point **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_point_count<class_Curve2D_method_get_point_count>` **(** **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_point_in<class_Curve2D_method_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_point_out<class_Curve2D_method_get_point_out>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_point_position<class_Curve2D_method_get_point_position>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`interpolate<class_Curve2D_method_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`interpolate_baked<class_Curve2D_method_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`interpolatef<class_Curve2D_method_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_Curve2D_method_remove_point>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_in<class_Curve2D_method_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` position **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_out<class_Curve2D_method_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` position **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_position<class_Curve2D_method_set_point_position>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` position **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`tessellate<class_Curve2D_method_tessellate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_point<class_Curve2D_method_add_point>` **(** :ref:`Vector2<class_Vector2>` position, :ref:`Vector2<class_Vector2>` in=Vector2( 0, 0 ), :ref:`Vector2<class_Vector2>` out=Vector2( 0, 0 ), :ref:`int<class_int>` at_position=-1 **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_points<class_Curve2D_method_clear_points>` **(** **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_baked_length<class_Curve2D_method_get_baked_length>` **(** **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`get_baked_points<class_Curve2D_method_get_baked_points>` **(** **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_closest_offset<class_Curve2D_method_get_closest_offset>` **(** :ref:`Vector2<class_Vector2>` to_point **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_closest_point<class_Curve2D_method_get_closest_point>` **(** :ref:`Vector2<class_Vector2>` to_point **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_point_count<class_Curve2D_method_get_point_count>` **(** **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_point_in<class_Curve2D_method_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_point_out<class_Curve2D_method_get_point_out>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_point_position<class_Curve2D_method_get_point_position>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`interpolate<class_Curve2D_method_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`interpolate_baked<class_Curve2D_method_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`interpolatef<class_Curve2D_method_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_Curve2D_method_remove_point>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_in<class_Curve2D_method_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` position **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_out<class_Curve2D_method_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` position **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_position<class_Curve2D_method_set_point_position>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` position **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`tessellate<class_Curve2D_method_tessellate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -116,9 +116,9 @@ Returns the total length of the curve, based on the cached points. Given enough
|
||||
|
||||
.. _class_Curve2D_method_get_baked_points:
|
||||
|
||||
- :ref:`PoolVector2Array<class_PoolVector2Array>` **get_baked_points** **(** **)** const
|
||||
- :ref:`PackedVector2Array<class_PackedVector2Array>` **get_baked_points** **(** **)** const
|
||||
|
||||
Returns the cache of points as a :ref:`PoolVector2Array<class_PoolVector2Array>`.
|
||||
Returns the cache of points as a :ref:`PackedVector2Array<class_PackedVector2Array>`.
|
||||
|
||||
----
|
||||
|
||||
@@ -238,7 +238,7 @@ Sets the position for the vertex ``idx``. If the index is out of bounds, the fun
|
||||
|
||||
.. _class_Curve2D_method_tessellate:
|
||||
|
||||
- :ref:`PoolVector2Array<class_PoolVector2Array>` **tessellate** **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const
|
||||
- :ref:`PackedVector2Array<class_PackedVector2Array>` **tessellate** **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const
|
||||
|
||||
Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts.
|
||||
|
||||
|
||||
@@ -32,53 +32,53 @@ Properties
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_point<class_Curve3D_method_add_point>` **(** :ref:`Vector3<class_Vector3>` position, :ref:`Vector3<class_Vector3>` in=Vector3( 0, 0, 0 ), :ref:`Vector3<class_Vector3>` out=Vector3( 0, 0, 0 ), :ref:`int<class_int>` at_position=-1 **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_points<class_Curve3D_method_clear_points>` **(** **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_baked_length<class_Curve3D_method_get_baked_length>` **(** **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`get_baked_points<class_Curve3D_method_get_baked_points>` **(** **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolRealArray<class_PoolRealArray>` | :ref:`get_baked_tilts<class_Curve3D_method_get_baked_tilts>` **(** **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`get_baked_up_vectors<class_Curve3D_method_get_baked_up_vectors>` **(** **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_closest_offset<class_Curve3D_method_get_closest_offset>` **(** :ref:`Vector3<class_Vector3>` to_point **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_closest_point<class_Curve3D_method_get_closest_point>` **(** :ref:`Vector3<class_Vector3>` to_point **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_point_count<class_Curve3D_method_get_point_count>` **(** **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_point_in<class_Curve3D_method_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_point_out<class_Curve3D_method_get_point_out>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_point_position<class_Curve3D_method_get_point_position>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_point_tilt<class_Curve3D_method_get_point_tilt>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`interpolate<class_Curve3D_method_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`interpolate_baked<class_Curve3D_method_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`interpolate_baked_up_vector<class_Curve3D_method_interpolate_baked_up_vector>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` apply_tilt=false **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`interpolatef<class_Curve3D_method_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_Curve3D_method_remove_point>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_in<class_Curve3D_method_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` position **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_out<class_Curve3D_method_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` position **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_position<class_Curve3D_method_set_point_position>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` position **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_tilt<class_Curve3D_method_set_point_tilt>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` tilt **)** |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`tessellate<class_Curve3D_method_tessellate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
|
||||
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_point<class_Curve3D_method_add_point>` **(** :ref:`Vector3<class_Vector3>` position, :ref:`Vector3<class_Vector3>` in=Vector3( 0, 0, 0 ), :ref:`Vector3<class_Vector3>` out=Vector3( 0, 0, 0 ), :ref:`int<class_int>` at_position=-1 **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_points<class_Curve3D_method_clear_points>` **(** **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_baked_length<class_Curve3D_method_get_baked_length>` **(** **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`get_baked_points<class_Curve3D_method_get_baked_points>` **(** **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`get_baked_tilts<class_Curve3D_method_get_baked_tilts>` **(** **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`get_baked_up_vectors<class_Curve3D_method_get_baked_up_vectors>` **(** **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_closest_offset<class_Curve3D_method_get_closest_offset>` **(** :ref:`Vector3<class_Vector3>` to_point **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_closest_point<class_Curve3D_method_get_closest_point>` **(** :ref:`Vector3<class_Vector3>` to_point **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_point_count<class_Curve3D_method_get_point_count>` **(** **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_point_in<class_Curve3D_method_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_point_out<class_Curve3D_method_get_point_out>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_point_position<class_Curve3D_method_get_point_position>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_point_tilt<class_Curve3D_method_get_point_tilt>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`interpolate<class_Curve3D_method_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`interpolate_baked<class_Curve3D_method_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`interpolate_baked_up_vector<class_Curve3D_method_interpolate_baked_up_vector>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` apply_tilt=false **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`interpolatef<class_Curve3D_method_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_Curve3D_method_remove_point>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_in<class_Curve3D_method_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` position **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_out<class_Curve3D_method_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` position **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_position<class_Curve3D_method_set_point_position>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` position **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_tilt<class_Curve3D_method_set_point_tilt>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` tilt **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`tessellate<class_Curve3D_method_tessellate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -144,25 +144,25 @@ Returns the total length of the curve, based on the cached points. Given enough
|
||||
|
||||
.. _class_Curve3D_method_get_baked_points:
|
||||
|
||||
- :ref:`PoolVector3Array<class_PoolVector3Array>` **get_baked_points** **(** **)** const
|
||||
- :ref:`PackedVector3Array<class_PackedVector3Array>` **get_baked_points** **(** **)** const
|
||||
|
||||
Returns the cache of points as a :ref:`PoolVector3Array<class_PoolVector3Array>`.
|
||||
Returns the cache of points as a :ref:`PackedVector3Array<class_PackedVector3Array>`.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Curve3D_method_get_baked_tilts:
|
||||
|
||||
- :ref:`PoolRealArray<class_PoolRealArray>` **get_baked_tilts** **(** **)** const
|
||||
- :ref:`PackedFloat32Array<class_PackedFloat32Array>` **get_baked_tilts** **(** **)** const
|
||||
|
||||
Returns the cache of tilts as a :ref:`PoolRealArray<class_PoolRealArray>`.
|
||||
Returns the cache of tilts as a :ref:`PackedFloat32Array<class_PackedFloat32Array>`.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Curve3D_method_get_baked_up_vectors:
|
||||
|
||||
- :ref:`PoolVector3Array<class_PoolVector3Array>` **get_baked_up_vectors** **(** **)** const
|
||||
- :ref:`PackedVector3Array<class_PackedVector3Array>` **get_baked_up_vectors** **(** **)** const
|
||||
|
||||
Returns the cache of up vectors as a :ref:`PoolVector3Array<class_PoolVector3Array>`.
|
||||
Returns the cache of up vectors as a :ref:`PackedVector3Array<class_PackedVector3Array>`.
|
||||
|
||||
If :ref:`up_vector_enabled<class_Curve3D_property_up_vector_enabled>` is ``false``, the cache will be empty.
|
||||
|
||||
@@ -314,7 +314,7 @@ The tilt controls the rotation along the look-at axis an object traveling the pa
|
||||
|
||||
.. _class_Curve3D_method_tessellate:
|
||||
|
||||
- :ref:`PoolVector3Array<class_PoolVector3Array>` **tessellate** **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const
|
||||
- :ref:`PackedVector3Array<class_PackedVector3Array>` **tessellate** **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const
|
||||
|
||||
Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts.
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
CurveTexture
|
||||
============
|
||||
|
||||
**Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
**Inherits:** :ref:`Texture2D<class_Texture2D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
A texture that shows a curve.
|
||||
|
||||
|
||||
@@ -98,13 +98,13 @@ Methods
|
||||
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_Dictionary_method_clear>` **(** **)** |
|
||||
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_Dictionary>` | :ref:`duplicate<class_Dictionary_method_duplicate>` **(** :ref:`bool<class_bool>` deep=False **)** |
|
||||
| :ref:`Dictionary<class_Dictionary>` | :ref:`duplicate<class_Dictionary_method_duplicate>` **(** :ref:`bool<class_bool>` deep=false **)** |
|
||||
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`empty<class_Dictionary_method_empty>` **(** **)** |
|
||||
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`erase<class_Dictionary_method_erase>` **(** :ref:`Variant<class_Variant>` key **)** |
|
||||
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`get<class_Dictionary_method_get>` **(** :ref:`Variant<class_Variant>` key, :ref:`Variant<class_Variant>` default=Null **)** |
|
||||
| void | :ref:`get<class_Dictionary_method_get>` **(** :ref:`Variant<class_Variant>` key, :ref:`Variant<class_Variant>` default=null **)** |
|
||||
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has<class_Dictionary_method_has>` **(** :ref:`Variant<class_Variant>` key **)** |
|
||||
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -132,7 +132,7 @@ Clear the dictionary, removing all key/value pairs.
|
||||
|
||||
.. _class_Dictionary_method_duplicate:
|
||||
|
||||
- :ref:`Dictionary<class_Dictionary>` **duplicate** **(** :ref:`bool<class_bool>` deep=False **)**
|
||||
- :ref:`Dictionary<class_Dictionary>` **duplicate** **(** :ref:`bool<class_bool>` deep=false **)**
|
||||
|
||||
Creates a copy of the dictionary, and returns it.
|
||||
|
||||
@@ -156,7 +156,7 @@ Erase a dictionary key/value pair by key. Returns ``true`` if the given key was
|
||||
|
||||
.. _class_Dictionary_method_get:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **get** **(** :ref:`Variant<class_Variant>` key, :ref:`Variant<class_Variant>` default=Null **)**
|
||||
- void **get** **(** :ref:`Variant<class_Variant>` key, :ref:`Variant<class_Variant>` default=null **)**
|
||||
|
||||
Returns the current value for the specified key in the ``Dictionary``. If the key does not exist, the method returns the value of the optional default argument, or ``null`` if it is omitted.
|
||||
|
||||
|
||||
@@ -33,6 +33,8 @@ Properties
|
||||
+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+----------------+
|
||||
| :ref:`ShadowDepthRange<enum_DirectionalLight_ShadowDepthRange>` | :ref:`directional_shadow_depth_range<class_DirectionalLight_property_directional_shadow_depth_range>` | ``0`` |
|
||||
+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+----------------+
|
||||
| :ref:`float<class_float>` | :ref:`directional_shadow_fade_start<class_DirectionalLight_property_directional_shadow_fade_start>` | ``0.8`` |
|
||||
+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+----------------+
|
||||
| :ref:`float<class_float>` | :ref:`directional_shadow_max_distance<class_DirectionalLight_property_directional_shadow_max_distance>` | ``100.0`` |
|
||||
+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+----------------+
|
||||
| :ref:`ShadowMode<enum_DirectionalLight_ShadowMode>` | :ref:`directional_shadow_mode<class_DirectionalLight_property_directional_shadow_mode>` | ``2`` |
|
||||
@@ -132,6 +134,20 @@ Optimizes shadow rendering for detail versus movement. See :ref:`ShadowDepthRang
|
||||
|
||||
----
|
||||
|
||||
.. _class_DirectionalLight_property_directional_shadow_fade_start:
|
||||
|
||||
- :ref:`float<class_float>` **directional_shadow_fade_start**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | ``0.8`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
| *Getter* | get_param() |
|
||||
+-----------+------------------+
|
||||
|
||||
----
|
||||
|
||||
.. _class_DirectionalLight_property_directional_shadow_max_distance:
|
||||
|
||||
- :ref:`float<class_float>` **directional_shadow_max_distance**
|
||||
|
||||
@@ -57,7 +57,7 @@ Methods
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`file_exists<class_Directory_method_file_exists>` **(** :ref:`String<class_String>` path **)** |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_current_dir<class_Directory_method_get_current_dir>` **(** **)** |
|
||||
| :ref:`String<class_String>` | :ref:`get_current_dir<class_Directory_method_get_current_dir>` **(** :ref:`bool<class_bool>` include_drive=true **)** |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_current_drive<class_Directory_method_get_current_drive>` **(** **)** |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -133,10 +133,12 @@ Returns whether the target file exists. The argument can be relative to the curr
|
||||
|
||||
.. _class_Directory_method_get_current_dir:
|
||||
|
||||
- :ref:`String<class_String>` **get_current_dir** **(** **)**
|
||||
- :ref:`String<class_String>` **get_current_dir** **(** :ref:`bool<class_bool>` include_drive=true **)**
|
||||
|
||||
Returns the absolute path to the currently opened directory (e.g. ``res://folder`` or ``C:\tmp\folder``).
|
||||
|
||||
On Windows, if ``include_drive`` is ``false``, the leading drive specificator is omitted from the returned value (e.g. ``\tmp\folder``).
|
||||
|
||||
----
|
||||
|
||||
.. _class_Directory_method_get_current_drive:
|
||||
|
||||
103
classes/class_dtlsserver.rst
Normal file
103
classes/class_dtlsserver.rst
Normal file
@@ -0,0 +1,103 @@
|
||||
:github_url: hide
|
||||
|
||||
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||
.. DO NOT EDIT THIS FILE, but the DTLSServer.xml source instead.
|
||||
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||||
|
||||
.. _class_DTLSServer:
|
||||
|
||||
DTLSServer
|
||||
==========
|
||||
|
||||
**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
Helper class to implement a DTLS server.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
This class is used to store the state of a DTLS server. Upon :ref:`setup<class_DTLSServer_method_setup>` it converts connected :ref:`PacketPeerUDP<class_PacketPeerUDP>` to :ref:`PacketPeerDTLS<class_PacketPeerDTLS>` accepting them via :ref:`take_connection<class_DTLSServer_method_take_connection>` as DTLS clients. Under the hood, this class is used to store the DTLS state and cookies of the server. The reason of why the state and cookies are needed is outside of the scope of this documentation.
|
||||
|
||||
Below a small example of how to use it:
|
||||
|
||||
::
|
||||
|
||||
# server.gd
|
||||
extends Node
|
||||
|
||||
var dtls := DTLSServer.new()
|
||||
var server := UDPServer.new()
|
||||
var peers = []
|
||||
|
||||
func _ready():
|
||||
server.listen(4242)
|
||||
var key = load("key.key") # Your private key.
|
||||
var cert = load("cert.crt") # Your X509 certificate.
|
||||
dtls.setup(key, cert)
|
||||
|
||||
func _process(delta):
|
||||
while server.is_connection_available():
|
||||
var peer : PacketPeerUDP = server.take_connection()
|
||||
var dtls_peer : PacketPeerDTLS = dtls.take_connection(peer)
|
||||
if dtls_peer.get_status() != PacketPeerDTLS.STATUS_HANDSHAKING:
|
||||
continue # It is normal that 50% of the connections fails due to cookie exchange.
|
||||
print("Peer connected!")
|
||||
peers.append(dtls_peer)
|
||||
for p in peers:
|
||||
p.poll() # Must poll to update the state.
|
||||
if p.get_status() == PacketPeerDTLS.STATUS_CONNECTED:
|
||||
while p.get_available_packet_count() > 0:
|
||||
print("Received message from client: %s" % p.get_packet().get_string_from_utf8())
|
||||
p.put_packet("Hello DTLS client".to_utf8())
|
||||
|
||||
::
|
||||
|
||||
# client.gd
|
||||
extends Node
|
||||
|
||||
var dtls := PacketPeerDTLS.new()
|
||||
var udp := PacketPeerUDP.new()
|
||||
var connected = false
|
||||
|
||||
func _ready():
|
||||
udp.connect_to_host("127.0.0.1", 4242)
|
||||
dtls.connect_to_peer(udp, false) # Use true in production for certificate validation!
|
||||
|
||||
func _process(delta):
|
||||
dtls.poll()
|
||||
if dtls.get_status() == PacketPeerDTLS.STATUS_CONNECTED:
|
||||
if !connected:
|
||||
# Try to contact server
|
||||
dtls.put_packet("The answer is... 42!".to_utf8())
|
||||
while dtls.get_available_packet_count() > 0:
|
||||
print("Connected: %s" % dtls.get_packet().get_string_from_utf8())
|
||||
connected = true
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`setup<class_DTLSServer_method_setup>` **(** :ref:`CryptoKey<class_CryptoKey>` key, :ref:`X509Certificate<class_X509Certificate>` certificate, :ref:`X509Certificate<class_X509Certificate>` chain=null **)** |
|
||||
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PacketPeerDTLS<class_PacketPeerDTLS>` | :ref:`take_connection<class_DTLSServer_method_take_connection>` **(** :ref:`PacketPeerUDP<class_PacketPeerUDP>` udp_peer **)** |
|
||||
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_DTLSServer_method_setup:
|
||||
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **setup** **(** :ref:`CryptoKey<class_CryptoKey>` key, :ref:`X509Certificate<class_X509Certificate>` certificate, :ref:`X509Certificate<class_X509Certificate>` chain=null **)**
|
||||
|
||||
Setup the DTLS server to use the given ``private_key`` and provide the given ``certificate`` to clients. You can pass the optional ``chain`` parameter to provide additional CA chain information along with the certificate.
|
||||
|
||||
----
|
||||
|
||||
.. _class_DTLSServer_method_take_connection:
|
||||
|
||||
- :ref:`PacketPeerDTLS<class_PacketPeerDTLS>` **take_connection** **(** :ref:`PacketPeerUDP<class_PacketPeerUDP>` udp_peer **)**
|
||||
|
||||
Try to initiate the DTLS handshake with the given ``udp_peer`` which must be already connected (see :ref:`PacketPeerUDP.connect_to_host<class_PacketPeerUDP_method_connect_to_host>`).
|
||||
|
||||
**Note**: You must check that the state of the return PacketPeerUDP is :ref:`PacketPeerDTLS.STATUS_HANDSHAKING<class_PacketPeerDTLS_constant_STATUS_HANDSHAKING>`, as it is normal that 50% of the new connections will be invalid due to cookie exchange.
|
||||
|
||||
@@ -47,10 +47,6 @@ Properties
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`size<class_DynamicFont_property_size>` | ``16`` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`use_filter<class_DynamicFont_property_use_filter>` | ``false`` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`use_mipmaps<class_DynamicFont_property_use_mipmaps>` | ``false`` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------+-------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -223,38 +219,6 @@ The font outline's thickness in pixels (not relative to the font size).
|
||||
|
||||
The font size in pixels.
|
||||
|
||||
----
|
||||
|
||||
.. _class_DynamicFont_property_use_filter:
|
||||
|
||||
- :ref:`bool<class_bool>` **use_filter**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_use_filter(value) |
|
||||
+-----------+-----------------------+
|
||||
| *Getter* | get_use_filter() |
|
||||
+-----------+-----------------------+
|
||||
|
||||
If ``true``, filtering is used. This makes the font blurry instead of pixelated when scaling it if font oversampling is disabled or ineffective. It's recommended to enable this when using the font in a control whose size changes over time, unless a pixel art aesthetic is desired.
|
||||
|
||||
----
|
||||
|
||||
.. _class_DynamicFont_property_use_mipmaps:
|
||||
|
||||
- :ref:`bool<class_bool>` **use_mipmaps**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_use_mipmaps(value) |
|
||||
+-----------+------------------------+
|
||||
| *Getter* | get_use_mipmaps() |
|
||||
+-----------+------------------------+
|
||||
|
||||
If ``true``, mipmapping is used. This improves the font's appearance when downscaling it if font oversampling is disabled or ineffective.
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
|
||||
@@ -11,41 +11,43 @@ EditorExportPlugin
|
||||
|
||||
**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
|
||||
A script that is executed when exporting projects.
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_export_begin<class_EditorExportPlugin_method__export_begin>` **(** :ref:`PoolStringArray<class_PoolStringArray>` features, :ref:`bool<class_bool>` is_debug, :ref:`String<class_String>` path, :ref:`int<class_int>` flags **)** virtual |
|
||||
+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_export_end<class_EditorExportPlugin_method__export_end>` **(** **)** virtual |
|
||||
+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_export_file<class_EditorExportPlugin_method__export_file>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type, :ref:`PoolStringArray<class_PoolStringArray>` features **)** virtual |
|
||||
+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_file<class_EditorExportPlugin_method_add_file>` **(** :ref:`String<class_String>` path, :ref:`PoolByteArray<class_PoolByteArray>` file, :ref:`bool<class_bool>` remap **)** |
|
||||
+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_ios_bundle_file<class_EditorExportPlugin_method_add_ios_bundle_file>` **(** :ref:`String<class_String>` path **)** |
|
||||
+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_ios_cpp_code<class_EditorExportPlugin_method_add_ios_cpp_code>` **(** :ref:`String<class_String>` code **)** |
|
||||
+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_ios_framework<class_EditorExportPlugin_method_add_ios_framework>` **(** :ref:`String<class_String>` path **)** |
|
||||
+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_ios_linker_flags<class_EditorExportPlugin_method_add_ios_linker_flags>` **(** :ref:`String<class_String>` flags **)** |
|
||||
+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_ios_plist_content<class_EditorExportPlugin_method_add_ios_plist_content>` **(** :ref:`String<class_String>` plist_content **)** |
|
||||
+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_shared_object<class_EditorExportPlugin_method_add_shared_object>` **(** :ref:`String<class_String>` path, :ref:`PoolStringArray<class_PoolStringArray>` tags **)** |
|
||||
+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`skip<class_EditorExportPlugin_method_skip>` **(** **)** |
|
||||
+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_export_begin<class_EditorExportPlugin_method__export_begin>` **(** :ref:`PackedStringArray<class_PackedStringArray>` features, :ref:`bool<class_bool>` is_debug, :ref:`String<class_String>` path, :ref:`int<class_int>` flags **)** virtual |
|
||||
+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_export_end<class_EditorExportPlugin_method__export_end>` **(** **)** virtual |
|
||||
+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_export_file<class_EditorExportPlugin_method__export_file>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type, :ref:`PackedStringArray<class_PackedStringArray>` features **)** virtual |
|
||||
+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_file<class_EditorExportPlugin_method_add_file>` **(** :ref:`String<class_String>` path, :ref:`PackedByteArray<class_PackedByteArray>` file, :ref:`bool<class_bool>` remap **)** |
|
||||
+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_ios_bundle_file<class_EditorExportPlugin_method_add_ios_bundle_file>` **(** :ref:`String<class_String>` path **)** |
|
||||
+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_ios_cpp_code<class_EditorExportPlugin_method_add_ios_cpp_code>` **(** :ref:`String<class_String>` code **)** |
|
||||
+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_ios_framework<class_EditorExportPlugin_method_add_ios_framework>` **(** :ref:`String<class_String>` path **)** |
|
||||
+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_ios_linker_flags<class_EditorExportPlugin_method_add_ios_linker_flags>` **(** :ref:`String<class_String>` flags **)** |
|
||||
+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_ios_plist_content<class_EditorExportPlugin_method_add_ios_plist_content>` **(** :ref:`String<class_String>` plist_content **)** |
|
||||
+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_shared_object<class_EditorExportPlugin_method_add_shared_object>` **(** :ref:`String<class_String>` path, :ref:`PackedStringArray<class_PackedStringArray>` tags **)** |
|
||||
+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`skip<class_EditorExportPlugin_method_skip>` **(** **)** |
|
||||
+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_EditorExportPlugin_method__export_begin:
|
||||
|
||||
- void **_export_begin** **(** :ref:`PoolStringArray<class_PoolStringArray>` features, :ref:`bool<class_bool>` is_debug, :ref:`String<class_String>` path, :ref:`int<class_int>` flags **)** virtual
|
||||
- void **_export_begin** **(** :ref:`PackedStringArray<class_PackedStringArray>` features, :ref:`bool<class_bool>` is_debug, :ref:`String<class_String>` path, :ref:`int<class_int>` flags **)** virtual
|
||||
|
||||
Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export.
|
||||
|
||||
----
|
||||
|
||||
@@ -53,17 +55,19 @@ Method Descriptions
|
||||
|
||||
- void **_export_end** **(** **)** virtual
|
||||
|
||||
Virtual method to be overridden by the user. Called when the export is finished.
|
||||
|
||||
----
|
||||
|
||||
.. _class_EditorExportPlugin_method__export_file:
|
||||
|
||||
- void **_export_file** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type, :ref:`PoolStringArray<class_PoolStringArray>` features **)** virtual
|
||||
- void **_export_file** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type, :ref:`PackedStringArray<class_PackedStringArray>` features **)** virtual
|
||||
|
||||
----
|
||||
|
||||
.. _class_EditorExportPlugin_method_add_file:
|
||||
|
||||
- void **add_file** **(** :ref:`String<class_String>` path, :ref:`PoolByteArray<class_PoolByteArray>` file, :ref:`bool<class_bool>` remap **)**
|
||||
- void **add_file** **(** :ref:`String<class_String>` path, :ref:`PackedByteArray<class_PackedByteArray>` file, :ref:`bool<class_bool>` remap **)**
|
||||
|
||||
----
|
||||
|
||||
@@ -99,7 +103,7 @@ Method Descriptions
|
||||
|
||||
.. _class_EditorExportPlugin_method_add_shared_object:
|
||||
|
||||
- void **add_shared_object** **(** :ref:`String<class_String>` path, :ref:`PoolStringArray<class_PoolStringArray>` tags **)**
|
||||
- void **add_shared_object** **(** :ref:`String<class_String>` path, :ref:`PackedStringArray<class_PackedStringArray>` tags **)**
|
||||
|
||||
----
|
||||
|
||||
|
||||
@@ -16,29 +16,29 @@ EditorFeatureProfile
|
||||
Methods
|
||||
-------
|
||||
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_feature_name<class_EditorFeatureProfile_method_get_feature_name>` **(** :ref:`Feature<enum_EditorFeatureProfile_Feature>` feature **)** |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_class_disabled<class_EditorFeatureProfile_method_is_class_disabled>` **(** :ref:`String<class_String>` class_name **)** const |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_class_editor_disabled<class_EditorFeatureProfile_method_is_class_editor_disabled>` **(** :ref:`String<class_String>` class_name **)** const |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_class_property_disabled<class_EditorFeatureProfile_method_is_class_property_disabled>` **(** :ref:`String<class_String>` class_name, :ref:`String<class_String>` property **)** const |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_feature_disabled<class_EditorFeatureProfile_method_is_feature_disabled>` **(** :ref:`Feature<enum_EditorFeatureProfile_Feature>` feature **)** const |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load_from_file<class_EditorFeatureProfile_method_load_from_file>` **(** :ref:`String<class_String>` path **)** |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`save_to_file<class_EditorFeatureProfile_method_save_to_file>` **(** :ref:`String<class_String>` path **)** |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_disable_class<class_EditorFeatureProfile_method_set_disable_class>` **(** :ref:`String<class_String>` class_name, :ref:`bool<class_bool>` disable **)** |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_disable_class_editor<class_EditorFeatureProfile_method_set_disable_class_editor>` **(** :ref:`String<class_String>` class_name, :ref:`bool<class_bool>` disable **)** |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_disable_class_property<class_EditorFeatureProfile_method_set_disable_class_property>` **(** :ref:`String<class_String>` class_name, :ref:`String<class_String>` property, :ref:`bool<class_bool>` disable **)** |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_disable_feature<class_EditorFeatureProfile_method_set_disable_feature>` **(** :ref:`Feature<enum_EditorFeatureProfile_Feature>` feature, :ref:`bool<class_bool>` disable **)** |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_feature_name<class_EditorFeatureProfile_method_get_feature_name>` **(** :ref:`Feature<enum_EditorFeatureProfile_Feature>` feature **)** |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_class_disabled<class_EditorFeatureProfile_method_is_class_disabled>` **(** :ref:`StringName<class_StringName>` class_name **)** const |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_class_editor_disabled<class_EditorFeatureProfile_method_is_class_editor_disabled>` **(** :ref:`StringName<class_StringName>` class_name **)** const |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_class_property_disabled<class_EditorFeatureProfile_method_is_class_property_disabled>` **(** :ref:`StringName<class_StringName>` class_name, :ref:`StringName<class_StringName>` property **)** const |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_feature_disabled<class_EditorFeatureProfile_method_is_feature_disabled>` **(** :ref:`Feature<enum_EditorFeatureProfile_Feature>` feature **)** const |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load_from_file<class_EditorFeatureProfile_method_load_from_file>` **(** :ref:`String<class_String>` path **)** |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`save_to_file<class_EditorFeatureProfile_method_save_to_file>` **(** :ref:`String<class_String>` path **)** |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_disable_class<class_EditorFeatureProfile_method_set_disable_class>` **(** :ref:`StringName<class_StringName>` class_name, :ref:`bool<class_bool>` disable **)** |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_disable_class_editor<class_EditorFeatureProfile_method_set_disable_class_editor>` **(** :ref:`StringName<class_StringName>` class_name, :ref:`bool<class_bool>` disable **)** |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_disable_class_property<class_EditorFeatureProfile_method_set_disable_class_property>` **(** :ref:`StringName<class_StringName>` class_name, :ref:`StringName<class_StringName>` property, :ref:`bool<class_bool>` disable **)** |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_disable_feature<class_EditorFeatureProfile_method_set_disable_feature>` **(** :ref:`Feature<enum_EditorFeatureProfile_Feature>` feature, :ref:`bool<class_bool>` disable **)** |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
@@ -90,19 +90,19 @@ Method Descriptions
|
||||
|
||||
.. _class_EditorFeatureProfile_method_is_class_disabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_class_disabled** **(** :ref:`String<class_String>` class_name **)** const
|
||||
- :ref:`bool<class_bool>` **is_class_disabled** **(** :ref:`StringName<class_StringName>` class_name **)** const
|
||||
|
||||
----
|
||||
|
||||
.. _class_EditorFeatureProfile_method_is_class_editor_disabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_class_editor_disabled** **(** :ref:`String<class_String>` class_name **)** const
|
||||
- :ref:`bool<class_bool>` **is_class_editor_disabled** **(** :ref:`StringName<class_StringName>` class_name **)** const
|
||||
|
||||
----
|
||||
|
||||
.. _class_EditorFeatureProfile_method_is_class_property_disabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_class_property_disabled** **(** :ref:`String<class_String>` class_name, :ref:`String<class_String>` property **)** const
|
||||
- :ref:`bool<class_bool>` **is_class_property_disabled** **(** :ref:`StringName<class_StringName>` class_name, :ref:`StringName<class_StringName>` property **)** const
|
||||
|
||||
----
|
||||
|
||||
@@ -126,19 +126,19 @@ Method Descriptions
|
||||
|
||||
.. _class_EditorFeatureProfile_method_set_disable_class:
|
||||
|
||||
- void **set_disable_class** **(** :ref:`String<class_String>` class_name, :ref:`bool<class_bool>` disable **)**
|
||||
- void **set_disable_class** **(** :ref:`StringName<class_StringName>` class_name, :ref:`bool<class_bool>` disable **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_EditorFeatureProfile_method_set_disable_class_editor:
|
||||
|
||||
- void **set_disable_class_editor** **(** :ref:`String<class_String>` class_name, :ref:`bool<class_bool>` disable **)**
|
||||
- void **set_disable_class_editor** **(** :ref:`StringName<class_StringName>` class_name, :ref:`bool<class_bool>` disable **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_EditorFeatureProfile_method_set_disable_class_property:
|
||||
|
||||
- void **set_disable_class_property** **(** :ref:`String<class_String>` class_name, :ref:`String<class_String>` property, :ref:`bool<class_bool>` disable **)**
|
||||
- void **set_disable_class_property** **(** :ref:`StringName<class_StringName>` class_name, :ref:`StringName<class_StringName>` property, :ref:`bool<class_bool>` disable **)**
|
||||
|
||||
----
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ EditorFileDialog
|
||||
|
||||
**Inherits:** :ref:`ConfirmationDialog<class_ConfirmationDialog>` **<** :ref:`AcceptDialog<class_AcceptDialog>` **<** :ref:`WindowDialog<class_WindowDialog>` **<** :ref:`Popup<class_Popup>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
|
||||
A modified version of :ref:`FileDialog<class_FileDialog>` used by the editor.
|
||||
|
||||
Properties
|
||||
----------
|
||||
@@ -74,7 +74,7 @@ Emitted when a file is selected.
|
||||
|
||||
.. _class_EditorFileDialog_signal_files_selected:
|
||||
|
||||
- **files_selected** **(** :ref:`PoolStringArray<class_PoolStringArray>` paths **)**
|
||||
- **files_selected** **(** :ref:`PackedStringArray<class_PackedStringArray>` paths **)**
|
||||
|
||||
Emitted when multiple files are selected.
|
||||
|
||||
|
||||
@@ -54,7 +54,7 @@ Emitted if the filesystem changed.
|
||||
|
||||
.. _class_EditorFileSystem_signal_resources_reimported:
|
||||
|
||||
- **resources_reimported** **(** :ref:`PoolStringArray<class_PoolStringArray>` resources **)**
|
||||
- **resources_reimported** **(** :ref:`PackedStringArray<class_PackedStringArray>` resources **)**
|
||||
|
||||
Remitted if a resource is reimported.
|
||||
|
||||
@@ -62,7 +62,7 @@ Remitted if a resource is reimported.
|
||||
|
||||
.. _class_EditorFileSystem_signal_resources_reload:
|
||||
|
||||
- **resources_reload** **(** :ref:`PoolStringArray<class_PoolStringArray>` resources **)**
|
||||
- **resources_reload** **(** :ref:`PackedStringArray<class_PackedStringArray>` resources **)**
|
||||
|
||||
----
|
||||
|
||||
@@ -143,3 +143,5 @@ Update a file information. Call this if an external program (not Godot) modified
|
||||
|
||||
- void **update_script_classes** **(** **)**
|
||||
|
||||
Scans the script files and updates the list of custom class names.
|
||||
|
||||
|
||||
@@ -38,7 +38,7 @@ Methods
|
||||
+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_file_script_class_name<class_EditorFileSystemDirectory_method_get_file_script_class_name>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_file_type<class_EditorFileSystemDirectory_method_get_file_type>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
| :ref:`StringName<class_StringName>` | :ref:`get_file_type<class_EditorFileSystemDirectory_method_get_file_type>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_name<class_EditorFileSystemDirectory_method_get_name>` **(** **)** |
|
||||
+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -116,7 +116,7 @@ Returns the path to the file at index ``idx``.
|
||||
|
||||
.. _class_EditorFileSystemDirectory_method_get_file_type:
|
||||
|
||||
- :ref:`String<class_String>` **get_file_type** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`StringName<class_StringName>` **get_file_type** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Returns the file extension of the file at index ``idx``.
|
||||
|
||||
|
||||
@@ -11,7 +11,12 @@ EditorInspector
|
||||
|
||||
**Inherits:** :ref:`ScrollContainer<class_ScrollContainer>` **<** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
A tab used to edit properties of the selected node.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
The editor inspector is by default located on the right-hand side of the editor. It's used to edit the properties of the selected node. For example, you can select a node such as the Sprite2D then edit its transform through the inspector tool. The editor inspector is an essential tool in the game development workflow.
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
@@ -38,7 +38,7 @@ Methods
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_property_editor<class_EditorInspectorPlugin_method_add_property_editor>` **(** :ref:`String<class_String>` property, :ref:`Control<class_Control>` editor **)** |
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_property_editor_for_multiple_properties<class_EditorInspectorPlugin_method_add_property_editor_for_multiple_properties>` **(** :ref:`String<class_String>` label, :ref:`PoolStringArray<class_PoolStringArray>` properties, :ref:`Control<class_Control>` editor **)** |
|
||||
| void | :ref:`add_property_editor_for_multiple_properties<class_EditorInspectorPlugin_method_add_property_editor_for_multiple_properties>` **(** :ref:`String<class_String>` label, :ref:`PackedStringArray<class_PackedStringArray>` properties, :ref:`Control<class_Control>` editor **)** |
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_handle<class_EditorInspectorPlugin_method_can_handle>` **(** :ref:`Object<class_Object>` object **)** virtual |
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -72,7 +72,7 @@ Adds a property editor, this must inherit :ref:`EditorProperty<class_EditorPrope
|
||||
|
||||
.. _class_EditorInspectorPlugin_method_add_property_editor_for_multiple_properties:
|
||||
|
||||
- void **add_property_editor_for_multiple_properties** **(** :ref:`String<class_String>` label, :ref:`PoolStringArray<class_PoolStringArray>` properties, :ref:`Control<class_Control>` editor **)**
|
||||
- void **add_property_editor_for_multiple_properties** **(** :ref:`String<class_String>` label, :ref:`PackedStringArray<class_PackedStringArray>` properties, :ref:`Control<class_Control>` editor **)**
|
||||
|
||||
Adds an editor that allows modifying multiple properties, this must inherit :ref:`EditorProperty<class_EditorProperty>`.
|
||||
|
||||
|
||||
@@ -192,7 +192,7 @@ Returns the enabled status of a plugin. The plugin name is the same as its direc
|
||||
|
||||
- :ref:`Array<class_Array>` **make_mesh_previews** **(** :ref:`Array<class_Array>` meshes, :ref:`int<class_int>` preview_size **)**
|
||||
|
||||
Returns mesh previews rendered at the given size as an :ref:`Array<class_Array>` of :ref:`Texture<class_Texture>`\ s.
|
||||
Returns mesh previews rendered at the given size as an :ref:`Array<class_Array>` of :ref:`Texture2D<class_Texture2D>`\ s.
|
||||
|
||||
----
|
||||
|
||||
|
||||
@@ -35,7 +35,7 @@ Methods
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_control_to_dock<class_EditorPlugin_method_add_control_to_dock>` **(** :ref:`DockSlot<enum_EditorPlugin_DockSlot>` slot, :ref:`Control<class_Control>` control **)** |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_custom_type<class_EditorPlugin_method_add_custom_type>` **(** :ref:`String<class_String>` type, :ref:`String<class_String>` base, :ref:`Script<class_Script>` script, :ref:`Texture<class_Texture>` icon **)** |
|
||||
| void | :ref:`add_custom_type<class_EditorPlugin_method_add_custom_type>` **(** :ref:`String<class_String>` type, :ref:`String<class_String>` base, :ref:`Script<class_Script>` script, :ref:`Texture2D<class_Texture2D>` icon **)** |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_export_plugin<class_EditorPlugin_method_add_export_plugin>` **(** :ref:`EditorExportPlugin<class_EditorExportPlugin>` plugin **)** |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -71,11 +71,11 @@ Methods
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`forward_spatial_gui_input<class_EditorPlugin_method_forward_spatial_gui_input>` **(** :ref:`Camera<class_Camera>` camera, :ref:`InputEvent<class_InputEvent>` event **)** virtual |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_breakpoints<class_EditorPlugin_method_get_breakpoints>` **(** **)** virtual |
|
||||
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_breakpoints<class_EditorPlugin_method_get_breakpoints>` **(** **)** virtual |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorInterface<class_EditorInterface>` | :ref:`get_editor_interface<class_EditorPlugin_method_get_editor_interface>` **(** **)** |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_Object>` | :ref:`get_plugin_icon<class_EditorPlugin_method_get_plugin_icon>` **(** **)** virtual |
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`get_plugin_icon<class_EditorPlugin_method_get_plugin_icon>` **(** **)** virtual |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_plugin_name<class_EditorPlugin_method_get_plugin_name>` **(** **)** virtual |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -307,11 +307,11 @@ When your plugin is deactivated, make sure to remove your custom control with :r
|
||||
|
||||
.. _class_EditorPlugin_method_add_custom_type:
|
||||
|
||||
- void **add_custom_type** **(** :ref:`String<class_String>` type, :ref:`String<class_String>` base, :ref:`Script<class_Script>` script, :ref:`Texture<class_Texture>` icon **)**
|
||||
- void **add_custom_type** **(** :ref:`String<class_String>` type, :ref:`String<class_String>` base, :ref:`Script<class_Script>` script, :ref:`Texture2D<class_Texture2D>` icon **)**
|
||||
|
||||
Adds a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed.
|
||||
|
||||
When given node or resource is selected, the base type will be instanced (ie, "Spatial", "Control", "Resource"), then the script will be loaded and set to this object.
|
||||
When given node or resource is selected, the base type will be instanced (e.g. "Spatial", "Control", "Resource"), then the script will be loaded and set to this object.
|
||||
|
||||
You can use the virtual method :ref:`handles<class_EditorPlugin_method_handles>` to check if your custom object is being edited by checking the script or using the ``is`` keyword.
|
||||
|
||||
@@ -479,7 +479,7 @@ Must ``return false`` in order to forward the :ref:`InputEvent<class_InputEvent>
|
||||
|
||||
.. _class_EditorPlugin_method_get_breakpoints:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **get_breakpoints** **(** **)** virtual
|
||||
- :ref:`PackedStringArray<class_PackedStringArray>` **get_breakpoints** **(** **)** virtual
|
||||
|
||||
This is for editors that edit script-based objects. You can return a list of breakpoints in the format (``script:line``), for example: ``res://path_to_script.gd:25``.
|
||||
|
||||
@@ -495,7 +495,21 @@ Returns the :ref:`EditorInterface<class_EditorInterface>` object that gives you
|
||||
|
||||
.. _class_EditorPlugin_method_get_plugin_icon:
|
||||
|
||||
- :ref:`Object<class_Object>` **get_plugin_icon** **(** **)** virtual
|
||||
- :ref:`Texture2D<class_Texture2D>` **get_plugin_icon** **(** **)** virtual
|
||||
|
||||
Override this method in your plugin to return a :ref:`Texture2D<class_Texture2D>` in order to give it an icon.
|
||||
|
||||
For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons.
|
||||
|
||||
Ideally, the plugin icon should be white with a transparent background and 16x16 pixels in size.
|
||||
|
||||
::
|
||||
|
||||
func get_plugin_icon():
|
||||
# You can use a custom icon:
|
||||
return preload("res://addons/my_plugin/my_plugin_icon.svg")
|
||||
# Or use a built-in icon:
|
||||
return get_editor_interface().get_base_control().get_icon("Node", "EditorIcons")
|
||||
|
||||
----
|
||||
|
||||
@@ -503,6 +517,10 @@ Returns the :ref:`EditorInterface<class_EditorInterface>` object that gives you
|
||||
|
||||
- :ref:`String<class_String>` **get_plugin_name** **(** **)** virtual
|
||||
|
||||
Override this method in your plugin to provide the name of the plugin when displayed in the Godot editor.
|
||||
|
||||
For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons.
|
||||
|
||||
----
|
||||
|
||||
.. _class_EditorPlugin_method_get_script_create_dialog:
|
||||
|
||||
@@ -38,28 +38,28 @@ Properties
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_focusable<class_EditorProperty_method_add_focusable>` **(** :ref:`Control<class_Control>` control **)** |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`emit_changed<class_EditorProperty_method_emit_changed>` **(** :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value, :ref:`String<class_String>` field="", :ref:`bool<class_bool>` changing=false **)** |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_Object>` | :ref:`get_edited_object<class_EditorProperty_method_get_edited_object>` **(** **)** |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_edited_property<class_EditorProperty_method_get_edited_property>` **(** **)** |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_tooltip_text<class_EditorProperty_method_get_tooltip_text>` **(** **)** const |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bottom_editor<class_EditorProperty_method_set_bottom_editor>` **(** :ref:`Control<class_Control>` editor **)** |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`update_property<class_EditorProperty_method_update_property>` **(** **)** virtual |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_focusable<class_EditorProperty_method_add_focusable>` **(** :ref:`Control<class_Control>` control **)** |
|
||||
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`emit_changed<class_EditorProperty_method_emit_changed>` **(** :ref:`StringName<class_StringName>` property, :ref:`Variant<class_Variant>` value, :ref:`StringName<class_StringName>` field=@"", :ref:`bool<class_bool>` changing=false **)** |
|
||||
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_Object>` | :ref:`get_edited_object<class_EditorProperty_method_get_edited_object>` **(** **)** |
|
||||
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`StringName<class_StringName>` | :ref:`get_edited_property<class_EditorProperty_method_get_edited_property>` **(** **)** |
|
||||
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_tooltip_text<class_EditorProperty_method_get_tooltip_text>` **(** **)** const |
|
||||
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bottom_editor<class_EditorProperty_method_set_bottom_editor>` **(** :ref:`Control<class_Control>` editor **)** |
|
||||
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`update_property<class_EditorProperty_method_update_property>` **(** **)** virtual |
|
||||
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_EditorProperty_signal_multiple_properties_changed:
|
||||
|
||||
- **multiple_properties_changed** **(** :ref:`PoolStringArray<class_PoolStringArray>` properties, :ref:`Array<class_Array>` value **)**
|
||||
- **multiple_properties_changed** **(** :ref:`PackedStringArray<class_PackedStringArray>` properties, :ref:`Array<class_Array>` value **)**
|
||||
|
||||
Emit it if you want multiple properties modified at the same time. Do not use if added via :ref:`EditorInspectorPlugin.parse_property<class_EditorInspectorPlugin_method_parse_property>`.
|
||||
|
||||
@@ -67,7 +67,7 @@ Emit it if you want multiple properties modified at the same time. Do not use if
|
||||
|
||||
.. _class_EditorProperty_signal_object_id_selected:
|
||||
|
||||
- **object_id_selected** **(** :ref:`String<class_String>` property, :ref:`int<class_int>` id **)**
|
||||
- **object_id_selected** **(** :ref:`StringName<class_StringName>` property, :ref:`int<class_int>` id **)**
|
||||
|
||||
Used by sub-inspectors. Emit it if what was selected was an Object ID.
|
||||
|
||||
@@ -75,7 +75,7 @@ Used by sub-inspectors. Emit it if what was selected was an Object ID.
|
||||
|
||||
.. _class_EditorProperty_signal_property_changed:
|
||||
|
||||
- **property_changed** **(** :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value **)**
|
||||
- **property_changed** **(** :ref:`StringName<class_StringName>` property, :ref:`Variant<class_Variant>` value **)**
|
||||
|
||||
Do not emit this manually, use the :ref:`emit_changed<class_EditorProperty_method_emit_changed>` method instead.
|
||||
|
||||
@@ -83,7 +83,7 @@ Do not emit this manually, use the :ref:`emit_changed<class_EditorProperty_metho
|
||||
|
||||
.. _class_EditorProperty_signal_property_checked:
|
||||
|
||||
- **property_checked** **(** :ref:`String<class_String>` property, :ref:`String<class_String>` bool **)**
|
||||
- **property_checked** **(** :ref:`StringName<class_StringName>` property, :ref:`String<class_String>` bool **)**
|
||||
|
||||
Emitted when a property was checked. Used internally.
|
||||
|
||||
@@ -91,7 +91,7 @@ Emitted when a property was checked. Used internally.
|
||||
|
||||
.. _class_EditorProperty_signal_property_keyed:
|
||||
|
||||
- **property_keyed** **(** :ref:`String<class_String>` property **)**
|
||||
- **property_keyed** **(** :ref:`StringName<class_StringName>` property **)**
|
||||
|
||||
Emit it if you want to add this value as an animation key (check for keying being enabled first).
|
||||
|
||||
@@ -99,7 +99,7 @@ Emit it if you want to add this value as an animation key (check for keying bein
|
||||
|
||||
.. _class_EditorProperty_signal_property_keyed_with_value:
|
||||
|
||||
- **property_keyed_with_value** **(** :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value **)**
|
||||
- **property_keyed_with_value** **(** :ref:`StringName<class_StringName>` property, :ref:`Variant<class_Variant>` value **)**
|
||||
|
||||
Emit it if you want to key a property with a single value.
|
||||
|
||||
@@ -229,7 +229,7 @@ If any of the controls added can gain keyboard focus, add it here. This ensures
|
||||
|
||||
.. _class_EditorProperty_method_emit_changed:
|
||||
|
||||
- void **emit_changed** **(** :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value, :ref:`String<class_String>` field="", :ref:`bool<class_bool>` changing=false **)**
|
||||
- void **emit_changed** **(** :ref:`StringName<class_StringName>` property, :ref:`Variant<class_Variant>` value, :ref:`StringName<class_StringName>` field=@"", :ref:`bool<class_bool>` changing=false **)**
|
||||
|
||||
If one or several properties have changed, this must be called. ``field`` is used in case your editor can modify fields separately (as an example, Vector3.x). The ``changing`` argument avoids the editor requesting this property to be refreshed (leave as ``false`` if unsure).
|
||||
|
||||
@@ -245,7 +245,7 @@ Gets the edited object.
|
||||
|
||||
.. _class_EditorProperty_method_get_edited_property:
|
||||
|
||||
- :ref:`String<class_String>` **get_edited_property** **(** **)**
|
||||
- :ref:`StringName<class_StringName>` **get_edited_property** **(** **)**
|
||||
|
||||
Gets the edited property. If your editor is for a single property (added via :ref:`EditorInspectorPlugin.parse_property<class_EditorInspectorPlugin_method_parse_property>`), then this will return the property.
|
||||
|
||||
|
||||
@@ -21,17 +21,17 @@ This object is used to generate previews for resources of files.
|
||||
Methods
|
||||
-------
|
||||
|
||||
+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_preview_generator<class_EditorResourcePreview_method_add_preview_generator>` **(** :ref:`EditorResourcePreviewGenerator<class_EditorResourcePreviewGenerator>` generator **)** |
|
||||
+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`check_for_invalidation<class_EditorResourcePreview_method_check_for_invalidation>` **(** :ref:`String<class_String>` path **)** |
|
||||
+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`queue_edited_resource_preview<class_EditorResourcePreview_method_queue_edited_resource_preview>` **(** :ref:`Resource<class_Resource>` resource, :ref:`Object<class_Object>` receiver, :ref:`String<class_String>` receiver_func, :ref:`Variant<class_Variant>` userdata **)** |
|
||||
+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`queue_resource_preview<class_EditorResourcePreview_method_queue_resource_preview>` **(** :ref:`String<class_String>` path, :ref:`Object<class_Object>` receiver, :ref:`String<class_String>` receiver_func, :ref:`Variant<class_Variant>` userdata **)** |
|
||||
+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_preview_generator<class_EditorResourcePreview_method_remove_preview_generator>` **(** :ref:`EditorResourcePreviewGenerator<class_EditorResourcePreviewGenerator>` generator **)** |
|
||||
+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_preview_generator<class_EditorResourcePreview_method_add_preview_generator>` **(** :ref:`EditorResourcePreviewGenerator<class_EditorResourcePreviewGenerator>` generator **)** |
|
||||
+------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`check_for_invalidation<class_EditorResourcePreview_method_check_for_invalidation>` **(** :ref:`String<class_String>` path **)** |
|
||||
+------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`queue_edited_resource_preview<class_EditorResourcePreview_method_queue_edited_resource_preview>` **(** :ref:`Resource<class_Resource>` resource, :ref:`Object<class_Object>` receiver, :ref:`StringName<class_StringName>` receiver_func, :ref:`Variant<class_Variant>` userdata **)** |
|
||||
+------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`queue_resource_preview<class_EditorResourcePreview_method_queue_resource_preview>` **(** :ref:`String<class_String>` path, :ref:`Object<class_Object>` receiver, :ref:`StringName<class_StringName>` receiver_func, :ref:`Variant<class_Variant>` userdata **)** |
|
||||
+------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_preview_generator<class_EditorResourcePreview_method_remove_preview_generator>` **(** :ref:`EditorResourcePreviewGenerator<class_EditorResourcePreviewGenerator>` generator **)** |
|
||||
+------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
@@ -63,7 +63,7 @@ Check if the resource changed, if so, it will be invalidated and the correspondi
|
||||
|
||||
.. _class_EditorResourcePreview_method_queue_edited_resource_preview:
|
||||
|
||||
- void **queue_edited_resource_preview** **(** :ref:`Resource<class_Resource>` resource, :ref:`Object<class_Object>` receiver, :ref:`String<class_String>` receiver_func, :ref:`Variant<class_Variant>` userdata **)**
|
||||
- void **queue_edited_resource_preview** **(** :ref:`Resource<class_Resource>` resource, :ref:`Object<class_Object>` receiver, :ref:`StringName<class_StringName>` receiver_func, :ref:`Variant<class_Variant>` userdata **)**
|
||||
|
||||
Queue a resource being edited for preview (using an instance). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texture (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything.
|
||||
|
||||
@@ -71,7 +71,7 @@ Queue a resource being edited for preview (using an instance). Once the preview
|
||||
|
||||
.. _class_EditorResourcePreview_method_queue_resource_preview:
|
||||
|
||||
- void **queue_resource_preview** **(** :ref:`String<class_String>` path, :ref:`Object<class_Object>` receiver, :ref:`String<class_String>` receiver_func, :ref:`Variant<class_Variant>` userdata **)**
|
||||
- void **queue_resource_preview** **(** :ref:`String<class_String>` path, :ref:`Object<class_Object>` receiver, :ref:`StringName<class_StringName>` receiver_func, :ref:`Variant<class_Variant>` userdata **)**
|
||||
|
||||
Queue a resource file for preview (using a path). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texture (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything.
|
||||
|
||||
|
||||
@@ -21,17 +21,17 @@ Custom code to generate previews. Please check ``file_dialog/thumbnail_size`` in
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_generate_small_preview<class_EditorResourcePreviewGenerator_method_can_generate_small_preview>` **(** **)** virtual |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`generate<class_EditorResourcePreviewGenerator_method_generate>` **(** :ref:`Resource<class_Resource>` from, :ref:`Vector2<class_Vector2>` size **)** virtual |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`generate_from_path<class_EditorResourcePreviewGenerator_method_generate_from_path>` **(** :ref:`String<class_String>` path, :ref:`Vector2<class_Vector2>` size **)** virtual |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`generate_small_preview_automatically<class_EditorResourcePreviewGenerator_method_generate_small_preview_automatically>` **(** **)** virtual |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`handles<class_EditorResourcePreviewGenerator_method_handles>` **(** :ref:`String<class_String>` type **)** virtual |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_generate_small_preview<class_EditorResourcePreviewGenerator_method_can_generate_small_preview>` **(** **)** virtual |
|
||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`generate<class_EditorResourcePreviewGenerator_method_generate>` **(** :ref:`Resource<class_Resource>` from, :ref:`Vector2<class_Vector2>` size **)** virtual |
|
||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`generate_from_path<class_EditorResourcePreviewGenerator_method_generate_from_path>` **(** :ref:`String<class_String>` path, :ref:`Vector2<class_Vector2>` size **)** virtual |
|
||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`generate_small_preview_automatically<class_EditorResourcePreviewGenerator_method_generate_small_preview_automatically>` **(** **)** virtual |
|
||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`handles<class_EditorResourcePreviewGenerator_method_handles>` **(** :ref:`String<class_String>` type **)** virtual |
|
||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
@@ -48,7 +48,7 @@ By default, it returns ``false``.
|
||||
|
||||
.. _class_EditorResourcePreviewGenerator_method_generate:
|
||||
|
||||
- :ref:`Texture<class_Texture>` **generate** **(** :ref:`Resource<class_Resource>` from, :ref:`Vector2<class_Vector2>` size **)** virtual
|
||||
- :ref:`Texture2D<class_Texture2D>` **generate** **(** :ref:`Resource<class_Resource>` from, :ref:`Vector2<class_Vector2>` size **)** virtual
|
||||
|
||||
Generate a preview from a given resource with the specified size. This must always be implemented.
|
||||
|
||||
@@ -60,7 +60,7 @@ Care must be taken because this function is always called from a thread (not the
|
||||
|
||||
.. _class_EditorResourcePreviewGenerator_method_generate_from_path:
|
||||
|
||||
- :ref:`Texture<class_Texture>` **generate_from_path** **(** :ref:`String<class_String>` path, :ref:`Vector2<class_Vector2>` size **)** virtual
|
||||
- :ref:`Texture2D<class_Texture2D>` **generate_from_path** **(** :ref:`String<class_String>` path, :ref:`Vector2<class_Vector2>` size **)** virtual
|
||||
|
||||
Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call :ref:`generate<class_EditorResourcePreviewGenerator_method_generate>`.
|
||||
|
||||
|
||||
@@ -11,12 +11,12 @@ EditorSceneImporterAssimp
|
||||
|
||||
**Inherits:** :ref:`EditorSceneImporter<class_EditorSceneImporter>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
Multi-format 3D asset importer based on `Assimp <http://assimp.org/>`_.
|
||||
FBX 3D asset importer based on `Assimp <http://assimp.org/>`_.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
This is a multi-format 3D asset importer based on `Assimp <http://assimp.org/>`_. See `this page <https://assimp-docs.readthedocs.io/en/latest/about/intoduction.html#installation>`_ for a full list of supported formats.
|
||||
This is an FBX 3D asset importer based on `Assimp <http://assimp.org/>`_. It currently has many known limitations and works best with static meshes. Most animated meshes won't import correctly.
|
||||
|
||||
If exporting a FBX scene from Autodesk Maya, use these FBX export settings:
|
||||
|
||||
|
||||
@@ -29,39 +29,39 @@ Accessing the settings is done by using the regular :ref:`Object<class_Object>`
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_property_info<class_EditorSettings_method_add_property_info>` **(** :ref:`Dictionary<class_Dictionary>` info **)** |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase<class_EditorSettings_method_erase>` **(** :ref:`String<class_String>` property **)** |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_favorites<class_EditorSettings_method_get_favorites>` **(** **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`get_project_metadata<class_EditorSettings_method_get_project_metadata>` **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` default=null **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_project_settings_dir<class_EditorSettings_method_get_project_settings_dir>` **(** **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_recent_dirs<class_EditorSettings_method_get_recent_dirs>` **(** **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`get_setting<class_EditorSettings_method_get_setting>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_settings_dir<class_EditorSettings_method_get_settings_dir>` **(** **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_setting<class_EditorSettings_method_has_setting>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`property_can_revert<class_EditorSettings_method_property_can_revert>` **(** :ref:`String<class_String>` name **)** |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`property_get_revert<class_EditorSettings_method_property_get_revert>` **(** :ref:`String<class_String>` name **)** |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_favorites<class_EditorSettings_method_set_favorites>` **(** :ref:`PoolStringArray<class_PoolStringArray>` dirs **)** |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_initial_value<class_EditorSettings_method_set_initial_value>` **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` value, :ref:`bool<class_bool>` update_current **)** |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_project_metadata<class_EditorSettings_method_set_project_metadata>` **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` data **)** |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_recent_dirs<class_EditorSettings_method_set_recent_dirs>` **(** :ref:`PoolStringArray<class_PoolStringArray>` dirs **)** |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_setting<class_EditorSettings_method_set_setting>` **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` value **)** |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_property_info<class_EditorSettings_method_add_property_info>` **(** :ref:`Dictionary<class_Dictionary>` info **)** |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase<class_EditorSettings_method_erase>` **(** :ref:`String<class_String>` property **)** |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_favorites<class_EditorSettings_method_get_favorites>` **(** **)** const |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`get_project_metadata<class_EditorSettings_method_get_project_metadata>` **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` default=null **)** const |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_project_settings_dir<class_EditorSettings_method_get_project_settings_dir>` **(** **)** const |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_recent_dirs<class_EditorSettings_method_get_recent_dirs>` **(** **)** const |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`get_setting<class_EditorSettings_method_get_setting>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_settings_dir<class_EditorSettings_method_get_settings_dir>` **(** **)** const |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_setting<class_EditorSettings_method_has_setting>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`property_can_revert<class_EditorSettings_method_property_can_revert>` **(** :ref:`String<class_String>` name **)** |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`property_get_revert<class_EditorSettings_method_property_get_revert>` **(** :ref:`String<class_String>` name **)** |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_favorites<class_EditorSettings_method_set_favorites>` **(** :ref:`PackedStringArray<class_PackedStringArray>` dirs **)** |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_initial_value<class_EditorSettings_method_set_initial_value>` **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value, :ref:`bool<class_bool>` update_current **)** |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_project_metadata<class_EditorSettings_method_set_project_metadata>` **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` data **)** |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_recent_dirs<class_EditorSettings_method_set_recent_dirs>` **(** :ref:`PackedStringArray<class_PackedStringArray>` dirs **)** |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_setting<class_EditorSettings_method_set_setting>` **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` value **)** |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
@@ -121,7 +121,7 @@ Erase a given setting (pass full property path).
|
||||
|
||||
.. _class_EditorSettings_method_get_favorites:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **get_favorites** **(** **)** const
|
||||
- :ref:`PackedStringArray<class_PackedStringArray>` **get_favorites** **(** **)** const
|
||||
|
||||
Gets the list of favorite files and directories for this project.
|
||||
|
||||
@@ -143,7 +143,7 @@ Gets the specific project settings path. Projects all have a unique sub-director
|
||||
|
||||
.. _class_EditorSettings_method_get_recent_dirs:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **get_recent_dirs** **(** **)** const
|
||||
- :ref:`PackedStringArray<class_PackedStringArray>` **get_recent_dirs** **(** **)** const
|
||||
|
||||
Gets the list of recently visited folders in the file dialog for this project.
|
||||
|
||||
@@ -187,7 +187,7 @@ Gets the global settings path for the engine. Inside this path, you can find som
|
||||
|
||||
.. _class_EditorSettings_method_set_favorites:
|
||||
|
||||
- void **set_favorites** **(** :ref:`PoolStringArray<class_PoolStringArray>` dirs **)**
|
||||
- void **set_favorites** **(** :ref:`PackedStringArray<class_PackedStringArray>` dirs **)**
|
||||
|
||||
Sets the list of favorite files and directories for this project.
|
||||
|
||||
@@ -195,7 +195,7 @@ Sets the list of favorite files and directories for this project.
|
||||
|
||||
.. _class_EditorSettings_method_set_initial_value:
|
||||
|
||||
- void **set_initial_value** **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` value, :ref:`bool<class_bool>` update_current **)**
|
||||
- void **set_initial_value** **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value, :ref:`bool<class_bool>` update_current **)**
|
||||
|
||||
----
|
||||
|
||||
@@ -207,7 +207,7 @@ Sets the list of favorite files and directories for this project.
|
||||
|
||||
.. _class_EditorSettings_method_set_recent_dirs:
|
||||
|
||||
- void **set_recent_dirs** **(** :ref:`PoolStringArray<class_PoolStringArray>` dirs **)**
|
||||
- void **set_recent_dirs** **(** :ref:`PackedStringArray<class_PackedStringArray>` dirs **)**
|
||||
|
||||
Sets the list of recently visited folders in the file dialog for this project.
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user