classref: Sync with current master branch

This commit is contained in:
Rémi Verschelde
2017-04-07 22:11:07 +02:00
parent 447b439db5
commit c282b77a58
392 changed files with 14087 additions and 12472 deletions

View File

@@ -1,12 +1,10 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_SpatialSound2DServerSW:
.. _class_@DLScript:
SpatialSound2DServerSW
======================
**Inherits:** :ref:`SpatialSound2DServer<class_spatialsound2dserver>` **<** :ref:`Object<class_object>`
@DLScript
=========
**Category:** Core

View File

@@ -19,6 +19,8 @@ Member Functions
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`Color8<class_@GDScript_Color8>` **(** :ref:`int<class_int>` r8, :ref:`int<class_int>` g8, :ref:`int<class_int>` b8, :ref:`int<class_int>` a8 **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`ColorN<class_@GDScript_ColorN>` **(** :ref:`String<class_string>` name, :ref:`float<class_float>` alpha **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`abs<class_@GDScript_abs>` **(** :ref:`float<class_float>` s **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`acos<class_@GDScript_acos>` **(** :ref:`float<class_float>` s **)** |
@@ -31,10 +33,12 @@ Member Functions
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`atan2<class_@GDScript_atan2>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`bytes2var<class_@GDScript_bytes2var>` **(** :ref:`RawArray<class_rawarray>` bytes **)** |
| :ref:`Variant<class_variant>` | :ref:`bytes2var<class_@GDScript_bytes2var>` **(** :ref:`PoolByteArray<class_poolbytearray>` bytes **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`ceil<class_@GDScript_ceil>` **(** :ref:`float<class_float>` s **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`char<class_@GDScript_char>` **(** :ref:`int<class_int>` ascii **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`clamp<class_@GDScript_clamp>` **(** :ref:`float<class_float>` val, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`convert<class_@GDScript_convert>` **(** :ref:`Variant<class_variant>` what, :ref:`int<class_int>` type **)** |
@@ -89,6 +93,8 @@ Member Functions
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`nearest_po2<class_@GDScript_nearest_po2>` **(** :ref:`int<class_int>` val **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`parse_json<class_@GDScript_parse_json>` **(** :ref:`String<class_string>` json **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`pow<class_@GDScript_pow>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Resource<class_resource>` | :ref:`preload<class_@GDScript_preload>` **(** :ref:`String<class_string>` path **)** |
@@ -141,11 +147,15 @@ Member Functions
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tanh<class_@GDScript_tanh>` **(** :ref:`float<class_float>` s **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`to_json<class_@GDScript_to_json>` **(** :ref:`Variant<class_variant>` var:Variant **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`type_exists<class_@GDScript_type_exists>` **(** :ref:`String<class_string>` type **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`typeof<class_@GDScript_typeof>` **(** :ref:`Variant<class_variant>` what **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RawArray<class_rawarray>` | :ref:`var2bytes<class_@GDScript_var2bytes>` **(** :ref:`Variant<class_variant>` var **)** |
| :ref:`Variant<class_variant>` | :ref:`validate_json<class_@GDScript_validate_json>` **(** :ref:`String<class_string>` json **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`var2bytes<class_@GDScript_var2bytes>` **(** :ref:`Variant<class_variant>` var **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`var2str<class_@GDScript_var2str>` **(** :ref:`Variant<class_variant>` var **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -158,6 +168,8 @@ Numeric Constants
-----------------
- **PI** = **3.141593** --- Constant that represents how many times the diameter of a circumference fits around its perimeter.
- **INF** = **inf**
- **NAN** = **nan**
Description
-----------
@@ -173,6 +185,10 @@ Member Function Description
Make a color from red, green, blue and alpha. Arguments can range from 0 to 255.
.. _class_@GDScript_ColorN:
- :ref:`Color<class_color>` **ColorN** **(** :ref:`String<class_string>` name, :ref:`float<class_float>` alpha **)**
.. _class_@GDScript_abs:
- :ref:`float<class_float>` **abs** **(** :ref:`float<class_float>` s **)**
@@ -211,7 +227,7 @@ Arc-tangent that takes a 2D vector as argument, returns the full -pi to +pi rang
.. _class_@GDScript_bytes2var:
- :ref:`Variant<class_variant>` **bytes2var** **(** :ref:`RawArray<class_rawarray>` bytes **)**
- :ref:`Variant<class_variant>` **bytes2var** **(** :ref:`PoolByteArray<class_poolbytearray>` bytes **)**
Decode a byte array back to a value.
@@ -221,6 +237,10 @@ Decode a byte array back to a value.
Ceiling (rounds up to nearest integer).
.. _class_@GDScript_char:
- :ref:`String<class_string>` **char** **(** :ref:`int<class_int>` ascii **)**
.. _class_@GDScript_clamp:
- :ref:`float<class_float>` **clamp** **(** :ref:`float<class_float>` val, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)**
@@ -379,6 +399,12 @@ Return the minimum of two values.
Return the nearest larger power of 2 for an integer.
.. _class_@GDScript_parse_json:
- :ref:`Variant<class_variant>` **parse_json** **(** :ref:`String<class_string>` json **)**
Parse json text to a Variant (use :ref:`typeof<class_@GDScript_typeof>` to check if it is what you expect).
.. _class_@GDScript_pow:
- :ref:`float<class_float>` **pow** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**
@@ -437,31 +463,31 @@ Convert from radians to degrees.
- :ref:`float<class_float>` **rand_range** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to **)**
Random range, any floating point value between 'from' and 'to'
Random range, any floating point value between 'from' and 'to'.
.. _class_@GDScript_rand_seed:
- :ref:`Array<class_array>` **rand_seed** **(** :ref:`int<class_int>` seed **)**
Random from seed, pass a seed and an array with both number and new seed is returned.
Random from seed: pass a seed, and an array with both number and new seed is returned. "Seed" here refers to the internal state of the pseudo random number generator. The internal state of the current implementation is 64 bits.
.. _class_@GDScript_randf:
- :ref:`float<class_float>` **randf** **(** **)**
Random value (0 to 1 float).
Return a random floating point value between 0 and 1.
.. _class_@GDScript_randi:
- :ref:`int<class_int>` **randi** **(** **)**
Random 32 bits value (integer). To obtain a value from 0 to N, you can use remainder, like (for random from 0 to 19): randi() % 20.
Return a random 32 bits integer value. To obtain a random value between 0 to N (where N is smaller than 2^32 - 1), you can use remainder. For example, to get a random integer between 0 and 19 inclusive, you can use randi() % 20.
.. _class_@GDScript_randomize:
- :ref:`Nil<class_nil>` **randomize** **(** **)**
Reset the seed of the random number generator with a new, different one.
Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time.
.. _class_@GDScript_range:
@@ -535,6 +561,12 @@ Standard tangent function.
Hyperbolic tangent.
.. _class_@GDScript_to_json:
- :ref:`String<class_string>` **to_json** **(** :ref:`Variant<class_variant>` var:Variant **)**
Convert a Variant to json text.
.. _class_@GDScript_type_exists:
- :ref:`bool<class_bool>` **type_exists** **(** :ref:`String<class_string>` type **)**
@@ -545,9 +577,13 @@ Hyperbolic tangent.
Return the internal type of the given Variant object, using the TYPE\_\* enum in :ref:`@Global Scope<class_@global scope>`.
.. _class_@GDScript_validate_json:
- :ref:`Variant<class_variant>` **validate_json** **(** :ref:`String<class_string>` json **)**
.. _class_@GDScript_var2bytes:
- :ref:`RawArray<class_rawarray>` **var2bytes** **(** :ref:`Variant<class_variant>` var **)**
- :ref:`PoolByteArray<class_poolbytearray>` **var2bytes** **(** :ref:`Variant<class_variant>` var **)**
Encode a variable value to a byte array.
@@ -569,6 +605,6 @@ Return a weak reference to an object.
Stop the function execution and return the current state. Call :ref:`GDFunctionState.resume<class_GDFunctionState_resume>` on the state to resume execution. This invalidates the state.
Returns anything that was passed to the resume function call. If passed an object and a signal, the execution is resumed when the object's signal is emmited.
Returns anything that was passed to the resume function call. If passed an object and a signal, the execution is resumed when the object's signal is emitted.

View File

@@ -16,30 +16,22 @@ Global scope constants and variables.
Member Variables
----------------
- :ref:`AudioServer<class_audioserver>` **AS** - [AudioServer] singleton
- :ref:`AudioServer<class_audioserver>` **AudioServer** - [AudioServer] singleton
- :ref:`ClassDB<class_classdb>` **ClassDB**
- :ref:`Engine<class_engine>` **Engine**
- :ref:`Geometry<class_geometry>` **Geometry** - [Geometry] singleton
- :ref:`Globals<class_globals>` **Globals** - [Globals] singleton
- :ref:`GlobalConfig<class_globalconfig>` **GlobalConfig**
- :ref:`IP<class_ip>` **IP** - [IP] singleton
- :ref:`Input<class_input>` **Input** - [Input] singleton
- :ref:`InputMap<class_inputmap>` **InputMap** - [InputMap] singleton
- :ref:`Reference<class_reference>` **Marshalls** - [Marshalls] singleton
- :ref:`OS<class_os>` **OS** - [OS] singleton
- :ref:`PhysicsServer<class_physicsserver>` **PS** - [PhysicsServer] singleton
- :ref:`Physics2DServer<class_physics2dserver>` **PS2D** - [Physics2DServer] singleton
- :ref:`PathRemap<class_pathremap>` **PathRemap** - [PathRemap] singleton
- :ref:`Performance<class_performance>` **Performance** - [Performance] singleton
- :ref:`Physics2DServer<class_physics2dserver>` **Physics2DServer** - [Physics2DServer] singleton
- :ref:`PhysicsServer<class_physicsserver>` **PhysicsServer** - [PhysicsServer] singleton
- :ref:`ResourceLoader<class_resourceloader>` **ResourceLoader** - [ResourceLoader] singleton
- :ref:`ResourceSaver<class_resourcesaver>` **ResourceSaver** - [ResourceSaver] singleton
- :ref:`SpatialSoundServer<class_spatialsoundserver>` **SS** - [SpatialSoundServer] singleton
- :ref:`SpatialSound2DServer<class_spatialsound2dserver>` **SS2D** - [SpatialSound2DServer] singleton
- :ref:`SpatialSound2DServer<class_spatialsound2dserver>` **SpatialSound2DServer** - [SpatialSound2DServer] singleton
- :ref:`SpatialSoundServer<class_spatialsoundserver>` **SpatialSoundServer** - [SpatialSoundServer] singleton
- :ref:`TranslationServer<class_translationserver>` **TS** - [TranslationServer] singleton
- :ref:`TranslationServer<class_translationserver>` **TranslationServer** - [TranslationServer] singleton
- :ref:`VisualServer<class_visualserver>` **VS** - [VisualServer] singleton
- :ref:`VisualServer<class_visualserver>` **VisualServer** - [VisualServer] singleton
Numeric Constants
@@ -320,35 +312,27 @@ Numeric Constants
- **BUTTON_MASK_LEFT** = **1**
- **BUTTON_MASK_RIGHT** = **2**
- **BUTTON_MASK_MIDDLE** = **4**
- **JOY_BUTTON_0** = **0** --- Joystick Button 0
- **JOY_BUTTON_1** = **1** --- Joystick Button 1
- **JOY_BUTTON_2** = **2** --- Joystick Button 2
- **JOY_BUTTON_3** = **3** --- Joystick Button 3
- **JOY_BUTTON_4** = **4** --- Joystick Button 4
- **JOY_BUTTON_5** = **5** --- Joystick Button 5
- **JOY_BUTTON_6** = **6** --- Joystick Button 6
- **JOY_BUTTON_7** = **7** --- Joystick Button 7
- **JOY_BUTTON_8** = **8** --- Joystick Button 8
- **JOY_BUTTON_9** = **9** --- Joystick Button 9
- **JOY_BUTTON_10** = **10** --- Joystick Button 10
- **JOY_BUTTON_11** = **11** --- Joystick Button 11
- **JOY_BUTTON_12** = **12** --- Joystick Button 12
- **JOY_BUTTON_13** = **13** --- Joystick Button 13
- **JOY_BUTTON_14** = **14** --- Joystick Button 14
- **JOY_BUTTON_15** = **15** --- Joystick Button 15
- **JOY_BUTTON_MAX** = **16** --- Joystick Button 16
- **JOY_SNES_A** = **1** --- Super Nintendo Entertaiment System controller A button
- **JOY_SNES_B** = **0** --- Super Nintendo Entertaiment System controller B button
- **JOY_SNES_X** = **3** --- Super Nintendo Entertaiment System controller X button
- **JOY_SNES_Y** = **2** --- Super Nintendo Entertaiment System controller Y button
- **JOY_BUTTON_0** = **0** --- Joypad Button 0
- **JOY_BUTTON_1** = **1** --- Joypad Button 1
- **JOY_BUTTON_2** = **2** --- Joypad Button 2
- **JOY_BUTTON_3** = **3** --- Joypad Button 3
- **JOY_BUTTON_4** = **4** --- Joypad Button 4
- **JOY_BUTTON_5** = **5** --- Joypad Button 5
- **JOY_BUTTON_6** = **6** --- Joypad Button 6
- **JOY_BUTTON_7** = **7** --- Joypad Button 7
- **JOY_BUTTON_8** = **8** --- Joypad Button 8
- **JOY_BUTTON_9** = **9** --- Joypad Button 9
- **JOY_BUTTON_10** = **10** --- Joypad Button 10
- **JOY_BUTTON_11** = **11** --- Joypad Button 11
- **JOY_BUTTON_12** = **12** --- Joypad Button 12
- **JOY_BUTTON_13** = **13** --- Joypad Button 13
- **JOY_BUTTON_14** = **14** --- Joypad Button 14
- **JOY_BUTTON_15** = **15** --- Joypad Button 15
- **JOY_BUTTON_MAX** = **16** --- Joypad Button 16
- **JOY_SONY_CIRCLE** = **1** --- DUALSHOCK circle button
- **JOY_SONY_X** = **0** --- DUALSHOCK X button
- **JOY_SONY_SQUARE** = **2** --- DUALSHOCK square button
- **JOY_SONY_TRIANGLE** = **3** --- DUALSHOCK triangle button
- **JOY_SEGA_B** = **1** --- SEGA controller B button
- **JOY_SEGA_A** = **0** --- SEGA controller A button
- **JOY_SEGA_X** = **2** --- SEGA controller X button
- **JOY_SEGA_Y** = **3** --- SEGA controller Y button
- **JOY_XBOX_B** = **1** --- XBOX controller B button
- **JOY_XBOX_A** = **0** --- XBOX controller A button
- **JOY_XBOX_X** = **2** --- XBOX controller X button
@@ -357,33 +341,31 @@ Numeric Constants
- **JOY_DS_B** = **0**
- **JOY_DS_X** = **3**
- **JOY_DS_Y** = **2**
- **JOY_SELECT** = **10** --- Joystick Button Select
- **JOY_START** = **11** --- Joystick Button Start
- **JOY_DPAD_UP** = **12** --- Joystick DPad Up
- **JOY_DPAD_DOWN** = **13** --- Joystick DPad Down
- **JOY_DPAD_LEFT** = **14** --- Joystick DPad Left
- **JOY_DPAD_RIGHT** = **15** --- Joystick DPad Right
- **JOY_L** = **4** --- Joystick Left Shoulder Button
- **JOY_L2** = **6** --- Joystick Left Trigger
- **JOY_L3** = **8** --- Joystick Left Stick Click
- **JOY_R** = **5** --- Joystick Right Shoulder Button
- **JOY_R2** = **7** --- Joystick Right Trigger
- **JOY_R3** = **9** --- Joystick Right Stick Click
- **JOY_AXIS_0** = **0** --- Joystick Left Stick Horizontal Axis
- **JOY_AXIS_1** = **1** --- Joystick Left Stick Vertical Axis
- **JOY_AXIS_2** = **2** --- Joystick Right Stick Horizontal Axis
- **JOY_AXIS_3** = **3** --- Joystick Right Stick Vertical Axis
- **JOY_SELECT** = **10** --- Joypad Button Select
- **JOY_START** = **11** --- Joypad Button Start
- **JOY_DPAD_UP** = **12** --- Joypad DPad Up
- **JOY_DPAD_DOWN** = **13** --- Joypad DPad Down
- **JOY_DPAD_LEFT** = **14** --- Joypad DPad Left
- **JOY_DPAD_RIGHT** = **15** --- Joypad DPad Right
- **JOY_L** = **4** --- Joypad Left Shoulder Button
- **JOY_L2** = **6** --- Joypad Left Trigger
- **JOY_L3** = **8** --- Joypad Left Stick Click
- **JOY_R** = **5** --- Joypad Right Shoulder Button
- **JOY_R2** = **7** --- Joypad Right Trigger
- **JOY_R3** = **9** --- Joypad Right Stick Click
- **JOY_AXIS_0** = **0** --- Joypad Left Stick Horizontal Axis
- **JOY_AXIS_1** = **1** --- Joypad Left Stick Vertical Axis
- **JOY_AXIS_2** = **2** --- Joypad Right Stick Horizontal Axis
- **JOY_AXIS_3** = **3** --- Joypad Right Stick Vertical Axis
- **JOY_AXIS_4** = **4**
- **JOY_AXIS_5** = **5**
- **JOY_AXIS_6** = **6** --- Joystick Left Trigger Analog Axis
- **JOY_AXIS_7** = **7** --- Joystick Right Trigger Analog Axis
- **JOY_AXIS_6** = **6** --- Joypad Left Trigger Analog Axis
- **JOY_AXIS_7** = **7** --- Joypad Right Trigger Analog Axis
- **JOY_AXIS_MAX** = **8**
- **JOY_ANALOG_0_X** = **0** --- Joystick Left Stick Horizontal Axis
- **JOY_ANALOG_0_Y** = **1** --- Joystick Left Stick Vertical Axis
- **JOY_ANALOG_1_X** = **2** --- Joystick Right Stick Horizontal Axis
- **JOY_ANALOG_1_Y** = **3** --- Joystick Right Stick Vertical Axis
- **JOY_ANALOG_2_X** = **4**
- **JOY_ANALOG_2_Y** = **5**
- **JOY_ANALOG_LX** = **0** --- Joypad Left Stick Horizontal Axis
- **JOY_ANALOG_LY** = **1** --- Joypad Left Stick Vertical Axis
- **JOY_ANALOG_RX** = **2** --- Joypad Right Stick Horizontal Axis
- **JOY_ANALOG_RY** = **3** --- Joypad Right Stick Vertical Axis
- **JOY_ANALOG_L2** = **6**
- **JOY_ANALOG_R2** = **7**
- **OK** = **0** --- Functions that return Error return OK when everything went ok. Most functions don't return error anyway and/or just print errors to stdout.
@@ -408,7 +390,7 @@ Numeric Constants
- **ERR_CANT_OPEN** = **19**
- **ERR_CANT_CREATE** = **20**
- **ERR_PARSE_ERROR** = **43**
- **ERROR_QUERY_FAILED** = **21**
- **ERR_QUERY_FAILED** = **21**
- **ERR_ALREADY_IN_USE** = **22**
- **ERR_LOCKED** = **23**
- **ERR_TIMEOUT** = **24**
@@ -436,16 +418,19 @@ Numeric Constants
- **PROPERTY_HINT_LENGTH** = **5**
- **PROPERTY_HINT_KEY_ACCEL** = **7**
- **PROPERTY_HINT_FLAGS** = **8** --- Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers.
- **PROPERTY_HINT_ALL_FLAGS** = **9** --- Property hint for a bitmask description that covers all 32 bits. Valid only for integers.
- **PROPERTY_HINT_FILE** = **10** --- String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "\*.doc".
- **PROPERTY_HINT_DIR** = **11** --- String property is a directory (so pop up a file dialog when edited).
- **PROPERTY_HINT_GLOBAL_FILE** = **12**
- **PROPERTY_HINT_GLOBAL_DIR** = **13**
- **PROPERTY_HINT_RESOURCE_TYPE** = **14** --- String property is a resource, so open the resource popup menu when edited.
- **PROPERTY_HINT_MULTILINE_TEXT** = **15**
- **PROPERTY_HINT_COLOR_NO_ALPHA** = **16**
- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSY** = **17**
- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **18**
- **PROPERTY_HINT_LAYERS_2D_RENDER** = **9**
- **PROPERTY_HINT_LAYERS_2D_PHYSICS** = **10**
- **PROPERTY_HINT_LAYERS_3D_RENDER** = **11**
- **PROPERTY_HINT_LAYERS_3D_PHYSICS** = **12**
- **PROPERTY_HINT_FILE** = **13** --- String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "\*.doc".
- **PROPERTY_HINT_DIR** = **14** --- String property is a directory (so pop up a file dialog when edited).
- **PROPERTY_HINT_GLOBAL_FILE** = **15**
- **PROPERTY_HINT_GLOBAL_DIR** = **16**
- **PROPERTY_HINT_RESOURCE_TYPE** = **17** --- String property is a resource, so open the resource popup menu when edited.
- **PROPERTY_HINT_MULTILINE_TEXT** = **18**
- **PROPERTY_HINT_COLOR_NO_ALPHA** = **19**
- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSY** = **20**
- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **21**
- **PROPERTY_USAGE_STORAGE** = **1** --- Property will be used as storage (default).
- **PROPERTY_USAGE_EDITOR** = **2** --- Property will be visible in editor (default).
- **PROPERTY_USAGE_NETWORK** = **4**
@@ -453,7 +438,7 @@ Numeric Constants
- **PROPERTY_USAGE_CHECKABLE** = **16**
- **PROPERTY_USAGE_CHECKED** = **32**
- **PROPERTY_USAGE_INTERNATIONALIZED** = **64**
- **PROPERTY_USAGE_BUNDLE** = **128**
- **PROPERTY_USAGE_GROUP** = **128**
- **PROPERTY_USAGE_CATEGORY** = **256**
- **PROPERTY_USAGE_STORE_IF_NONZERO** = **512**
- **PROPERTY_USAGE_STORE_IF_NONONE** = **1024**
@@ -479,11 +464,11 @@ Numeric Constants
- **TYPE_VECTOR2** = **5** --- Variable is of type :ref:`Vector2<class_vector2>`.
- **TYPE_RECT2** = **6** --- Variable is of type :ref:`Rect2<class_rect2>`.
- **TYPE_VECTOR3** = **7** --- Variable is of type :ref:`Vector3<class_vector3>`.
- **TYPE_MATRIX32** = **8** --- Variable is of type :ref:`Matrix32<class_matrix32>`.
- **TYPE_TRANSFORM2D** = **8** --- Variable is of type :ref:`Transform2D<class_transform2d>`.
- **TYPE_PLANE** = **9** --- Variable is of type :ref:`Plane<class_plane>`.
- **TYPE_QUAT** = **10** --- Variable is of type :ref:`Quat<class_quat>`.
- **TYPE_AABB** = **11** --- Variable is of type :ref:`AABB<class_aabb>`.
- **TYPE_MATRIX3** = **12** --- Variable is of type :ref:`Matrix3<class_matrix3>`.
- **TYPE_RECT3** = **11** --- Variable is of type :ref:`Rect3<class_rect3>`.
- **TYPE_BASIS** = **12** --- Variable is of type :ref:`Basis<class_basis>`.
- **TYPE_TRANSFORM** = **13** --- Variable is of type :ref:`Transform<class_transform>`.
- **TYPE_COLOR** = **14** --- Variable is of type :ref:`Color<class_color>`.
- **TYPE_IMAGE** = **15** --- Variable is of type :ref:`Image<class_image>`.

View File

@@ -1,204 +0,0 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AABB:
AABB
====
**Category:** Built-In Types
Brief Description
-----------------
Axis-Aligned Bounding Box.
Member Functions
----------------
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_aabb>` | :ref:`AABB<class_AABB_AABB>` **(** :ref:`Vector3<class_vector3>` pos, :ref:`Vector3<class_vector3>` size **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`encloses<class_AABB_encloses>` **(** :ref:`AABB<class_aabb>` with **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_aabb>` | :ref:`expand<class_AABB_expand>` **(** :ref:`Vector3<class_vector3>` to_point **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_area<class_AABB_get_area>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_endpoint<class_AABB_get_endpoint>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_longest_axis<class_AABB_get_longest_axis>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_longest_axis_index<class_AABB_get_longest_axis_index>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_longest_axis_size<class_AABB_get_longest_axis_size>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_shortest_axis<class_AABB_get_shortest_axis>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_shortest_axis_index<class_AABB_get_shortest_axis_index>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_shortest_axis_size<class_AABB_get_shortest_axis_size>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_support<class_AABB_get_support>` **(** :ref:`Vector3<class_vector3>` dir **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_aabb>` | :ref:`grow<class_AABB_grow>` **(** :ref:`float<class_float>` by **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_no_area<class_AABB_has_no_area>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_no_surface<class_AABB_has_no_surface>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_point<class_AABB_has_point>` **(** :ref:`Vector3<class_vector3>` point **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_aabb>` | :ref:`intersection<class_AABB_intersection>` **(** :ref:`AABB<class_aabb>` with **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`intersects<class_AABB_intersects>` **(** :ref:`AABB<class_aabb>` with **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`intersects_plane<class_AABB_intersects_plane>` **(** :ref:`Plane<class_plane>` plane **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`intersects_segment<class_AABB_intersects_segment>` **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_aabb>` | :ref:`merge<class_AABB_merge>` **(** :ref:`AABB<class_aabb>` with **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`Vector3<class_vector3>` **end** - Ending corner.
- :ref:`Vector3<class_vector3>` **pos** - Position (starting corner).
- :ref:`Vector3<class_vector3>` **size** - Size from position to end.
Description
-----------
AABB provides an 3D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for simple (fast) overlap tests.
Member Function Description
---------------------------
.. _class_AABB_AABB:
- :ref:`AABB<class_aabb>` **AABB** **(** :ref:`Vector3<class_vector3>` pos, :ref:`Vector3<class_vector3>` size **)**
Optional constructor, accepts position and size.
.. _class_AABB_encloses:
- :ref:`bool<class_bool>` **encloses** **(** :ref:`AABB<class_aabb>` with **)**
Return true if this :ref:`AABB<class_aabb>` completely encloses another one.
.. _class_AABB_expand:
- :ref:`AABB<class_aabb>` **expand** **(** :ref:`Vector3<class_vector3>` to_point **)**
Return this :ref:`AABB<class_aabb>` expanded to include a given point.
.. _class_AABB_get_area:
- :ref:`float<class_float>` **get_area** **(** **)**
Get the area of the :ref:`AABB<class_aabb>`.
.. _class_AABB_get_endpoint:
- :ref:`Vector3<class_vector3>` **get_endpoint** **(** :ref:`int<class_int>` idx **)**
Get the position of the 8 endpoints of the :ref:`AABB<class_aabb>` in space.
.. _class_AABB_get_longest_axis:
- :ref:`Vector3<class_vector3>` **get_longest_axis** **(** **)**
Return the normalized longest axis of the :ref:`AABB<class_aabb>`.
.. _class_AABB_get_longest_axis_index:
- :ref:`int<class_int>` **get_longest_axis_index** **(** **)**
Return the index of the longest axis of the :ref:`AABB<class_aabb>` (according to :ref:`Vector3<class_vector3>`::AXIS\* enum).
.. _class_AABB_get_longest_axis_size:
- :ref:`float<class_float>` **get_longest_axis_size** **(** **)**
Return the scalar length of the longest axis of the :ref:`AABB<class_aabb>`.
.. _class_AABB_get_shortest_axis:
- :ref:`Vector3<class_vector3>` **get_shortest_axis** **(** **)**
Return the normalized shortest axis of the :ref:`AABB<class_aabb>`.
.. _class_AABB_get_shortest_axis_index:
- :ref:`int<class_int>` **get_shortest_axis_index** **(** **)**
Return the index of the shortest axis of the :ref:`AABB<class_aabb>` (according to :ref:`Vector3<class_vector3>`::AXIS\* enum).
.. _class_AABB_get_shortest_axis_size:
- :ref:`float<class_float>` **get_shortest_axis_size** **(** **)**
Return the scalar length of the shortest axis of the :ref:`AABB<class_aabb>`.
.. _class_AABB_get_support:
- :ref:`Vector3<class_vector3>` **get_support** **(** :ref:`Vector3<class_vector3>` dir **)**
Return the support point in a given direction. This is useful for collision detection algorithms.
.. _class_AABB_grow:
- :ref:`AABB<class_aabb>` **grow** **(** :ref:`float<class_float>` by **)**
Return a copy of the :ref:`AABB<class_aabb>` grown a given amount of units towards all the sides.
.. _class_AABB_has_no_area:
- :ref:`bool<class_bool>` **has_no_area** **(** **)**
Return true if the :ref:`AABB<class_aabb>` is flat or empty.
.. _class_AABB_has_no_surface:
- :ref:`bool<class_bool>` **has_no_surface** **(** **)**
Return true if the :ref:`AABB<class_aabb>` is empty.
.. _class_AABB_has_point:
- :ref:`bool<class_bool>` **has_point** **(** :ref:`Vector3<class_vector3>` point **)**
Return true if the :ref:`AABB<class_aabb>` contains a point.
.. _class_AABB_intersection:
- :ref:`AABB<class_aabb>` **intersection** **(** :ref:`AABB<class_aabb>` with **)**
Return the intersection between two :ref:`AABB<class_aabb>`. An empty AABB (size 0,0,0) is returned on failure.
.. _class_AABB_intersects:
- :ref:`bool<class_bool>` **intersects** **(** :ref:`AABB<class_aabb>` with **)**
Return true if the :ref:`AABB<class_aabb>` overlaps with another.
.. _class_AABB_intersects_plane:
- :ref:`bool<class_bool>` **intersects_plane** **(** :ref:`Plane<class_plane>` plane **)**
Return true if the :ref:`AABB<class_aabb>` is at both sides of a plane.
.. _class_AABB_intersects_segment:
- :ref:`bool<class_bool>` **intersects_segment** **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to **)**
Return true if the :ref:`AABB<class_aabb>` intersects the line segment between from and to
.. _class_AABB_merge:
- :ref:`AABB<class_aabb>` **merge** **(** :ref:`AABB<class_aabb>` with **)**
Combine this :ref:`AABB<class_aabb>` with another, a larger one is returned that contains both.

View File

@@ -35,8 +35,6 @@ Member Functions
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`LineEdit<class_lineedit>` | :ref:`register_text_enter<class_AcceptDialog_register_text_enter>` **(** :ref:`Object<class_object>` line_edit **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_child_rect<class_AcceptDialog_set_child_rect>` **(** :ref:`Control<class_control>` child **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_hide_on_ok<class_AcceptDialog_set_hide_on_ok>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_text<class_AcceptDialog_set_text>` **(** :ref:`String<class_string>` text **)** |
@@ -48,6 +46,12 @@ Signals
- **confirmed** **(** **)**
- **custom_action** **(** :ref:`String<class_string>` action **)**
Member Variables
----------------
- :ref:`bool<class_bool>` **dialog_hide_on_ok**
- :ref:`String<class_string>` **dialog_text**
Description
-----------
@@ -100,10 +104,6 @@ Return the built-in label text.
Register a :ref:`LineEdit<class_lineedit>` in the dialog. When the enter key is pressed, the dialog will be accepted.
.. _class_AcceptDialog_set_child_rect:
- void **set_child_rect** **(** :ref:`Control<class_control>` child **)**
.. _class_AcceptDialog_set_hide_on_ok:
- void **set_hide_on_ok** **(** :ref:`bool<class_bool>` enabled **)**

View File

@@ -23,8 +23,6 @@ Member Functions
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_frame<class_AnimatedSprite_get_frame>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_modulate<class_AnimatedSprite_get_modulate>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_AnimatedSprite_get_offset>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`SpriteFrames<class_spriteframes>` | :ref:`get_sprite_frames<class_AnimatedSprite_get_sprite_frames>` **(** **)** const |
@@ -49,8 +47,6 @@ Member Functions
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_frame<class_AnimatedSprite_set_frame>` **(** :ref:`int<class_int>` frame **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_modulate<class_AnimatedSprite_set_modulate>` **(** :ref:`Color<class_color>` modulate **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offset<class_AnimatedSprite_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_sprite_frames<class_AnimatedSprite_set_sprite_frames>` **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)** |
@@ -61,8 +57,20 @@ Member Functions
Signals
-------
- **animation_finished** **(** **)**
- **frame_changed** **(** **)**
- **finished** **(** **)**
Member Variables
----------------
- :ref:`String<class_string>` **animation**
- :ref:`bool<class_bool>` **centered**
- :ref:`bool<class_bool>` **flip_h**
- :ref:`bool<class_bool>` **flip_v**
- :ref:`int<class_int>` **frame**
- :ref:`SpriteFrames<class_spriteframes>` **frames**
- :ref:`Vector2<class_vector2>` **offset**
- :ref:`bool<class_bool>` **playing**
Description
-----------
@@ -84,12 +92,6 @@ Return the name of the current animation set to the node.
Return the visible frame index.
.. _class_AnimatedSprite_get_modulate:
- :ref:`Color<class_color>` **get_modulate** **(** **)** const
Return the color modulation for this sprite.
.. _class_AnimatedSprite_get_offset:
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
@@ -162,12 +164,6 @@ If true, sprite is flipped vertically.
Set the visible sprite frame index (from the list of frames inside the :ref:`SpriteFrames<class_spriteframes>` resource).
.. _class_AnimatedSprite_set_modulate:
- void **set_modulate** **(** :ref:`Color<class_color>` modulate **)**
Change the color modulation (multiplication) for this sprite.
.. _class_AnimatedSprite_set_offset:
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**

View File

@@ -43,6 +43,14 @@ Signals
- **frame_changed** **(** **)**
Member Variables
----------------
- :ref:`String<class_string>` **animation**
- :ref:`int<class_int>` **frame**
- :ref:`SpriteFrames<class_spriteframes>` **frames**
- :ref:`bool<class_bool>` **playing**
Member Function Description
---------------------------

View File

@@ -18,83 +18,87 @@ Contains data used to animate everything in the engine.
Member Functions
----------------
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`add_track<class_Animation_add_track>` **(** :ref:`int<class_int>` type, :ref:`int<class_int>` at_pos=-1 **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_Animation_clear>` **(** **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`find_track<class_Animation_find_track>` **(** :ref:`NodePath<class_nodepath>` path **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_length<class_Animation_get_length>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_step<class_Animation_get_step>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_track_count<class_Animation_get_track_count>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_loop<class_Animation_has_loop>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`IntArray<class_intarray>` | :ref:`method_track_get_key_indices<class_Animation_method_track_get_key_indices>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`method_track_get_name<class_Animation_method_track_get_name>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`method_track_get_params<class_Animation_method_track_get_params>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_track<class_Animation_remove_track>` **(** :ref:`int<class_int>` idx **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_length<class_Animation_set_length>` **(** :ref:`float<class_float>` time_sec **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop<class_Animation_set_loop>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_step<class_Animation_set_step>` **(** :ref:`float<class_float>` size_sec **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`track_find_key<class_Animation_track_find_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`bool<class_bool>` exact=false **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`track_get_interpolation_type<class_Animation_track_get_interpolation_type>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`track_get_key_count<class_Animation_track_get_key_count>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`track_get_key_time<class_Animation_track_get_key_time>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`track_get_key_transition<class_Animation_track_get_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_get_key_value<class_Animation_track_get_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`track_get_path<class_Animation_track_get_path>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`track_get_type<class_Animation_track_get_type>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_insert_key<class_Animation_track_insert_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Variant<class_variant>` key, :ref:`float<class_float>` transition=1 **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`track_is_imported<class_Animation_track_is_imported>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_move_down<class_Animation_track_move_down>` **(** :ref:`int<class_int>` idx **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_move_up<class_Animation_track_move_up>` **(** :ref:`int<class_int>` idx **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_remove_key<class_Animation_track_remove_key>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_remove_key_at_pos<class_Animation_track_remove_key_at_pos>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` pos **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_imported<class_Animation_track_set_imported>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` imported **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_interpolation_type<class_Animation_track_set_interpolation_type>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` interpolation **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_key_transition<class_Animation_track_set_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` transition **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_key_value<class_Animation_track_set_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key, :ref:`Variant<class_variant>` value **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_path<class_Animation_track_set_path>` **(** :ref:`int<class_int>` idx, :ref:`NodePath<class_nodepath>` path **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`transform_track_insert_key<class_Animation_transform_track_insert_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Vector3<class_vector3>` loc, :ref:`Quat<class_quat>` rot, :ref:`Vector3<class_vector3>` scale **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`transform_track_interpolate<class_Animation_transform_track_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`IntArray<class_intarray>` | :ref:`value_track_get_key_indices<class_Animation_value_track_get_key_indices>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`value_track_get_update_mode<class_Animation_value_track_get_update_mode>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`value_track_set_update_mode<class_Animation_value_track_set_update_mode>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` mode **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`add_track<class_Animation_add_track>` **(** :ref:`int<class_int>` type, :ref:`int<class_int>` at_pos=-1 **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_Animation_clear>` **(** **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`find_track<class_Animation_find_track>` **(** :ref:`NodePath<class_nodepath>` path **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_length<class_Animation_get_length>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_step<class_Animation_get_step>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_track_count<class_Animation_get_track_count>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_loop<class_Animation_has_loop>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`method_track_get_key_indices<class_Animation_method_track_get_key_indices>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`method_track_get_name<class_Animation_method_track_get_name>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`method_track_get_params<class_Animation_method_track_get_params>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_track<class_Animation_remove_track>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_length<class_Animation_set_length>` **(** :ref:`float<class_float>` time_sec **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop<class_Animation_set_loop>` **(** :ref:`bool<class_bool>` enabled **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_step<class_Animation_set_step>` **(** :ref:`float<class_float>` size_sec **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`track_find_key<class_Animation_track_find_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`bool<class_bool>` exact=false **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`track_get_interpolation_loop_wrap<class_Animation_track_get_interpolation_loop_wrap>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`track_get_interpolation_type<class_Animation_track_get_interpolation_type>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`track_get_key_count<class_Animation_track_get_key_count>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`track_get_key_time<class_Animation_track_get_key_time>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`track_get_key_transition<class_Animation_track_get_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_get_key_value<class_Animation_track_get_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`track_get_path<class_Animation_track_get_path>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`track_get_type<class_Animation_track_get_type>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_insert_key<class_Animation_track_insert_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Variant<class_variant>` key, :ref:`float<class_float>` transition=1 **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`track_is_imported<class_Animation_track_is_imported>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_move_down<class_Animation_track_move_down>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_move_up<class_Animation_track_move_up>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_remove_key<class_Animation_track_remove_key>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_remove_key_at_pos<class_Animation_track_remove_key_at_pos>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` pos **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_imported<class_Animation_track_set_imported>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` imported **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_interpolation_loop_wrap<class_Animation_track_set_interpolation_loop_wrap>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` interpolation **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_interpolation_type<class_Animation_track_set_interpolation_type>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` interpolation **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_key_transition<class_Animation_track_set_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` transition **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_key_value<class_Animation_track_set_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key, :ref:`Variant<class_variant>` value **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_path<class_Animation_track_set_path>` **(** :ref:`int<class_int>` idx, :ref:`NodePath<class_nodepath>` path **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`transform_track_insert_key<class_Animation_transform_track_insert_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Vector3<class_vector3>` loc, :ref:`Quat<class_quat>` rot, :ref:`Vector3<class_vector3>` scale **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`transform_track_interpolate<class_Animation_transform_track_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`value_track_get_key_indices<class_Animation_value_track_get_key_indices>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`value_track_get_update_mode<class_Animation_value_track_get_update_mode>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`value_track_set_update_mode<class_Animation_value_track_set_update_mode>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` mode **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
@@ -163,7 +167,7 @@ Return whether the animation has the loop flag set.
.. _class_Animation_method_track_get_key_indices:
- :ref:`IntArray<class_intarray>` **method_track_get_key_indices** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const
- :ref:`PoolIntArray<class_poolintarray>` **method_track_get_key_indices** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const
Return all the key indices of a method track, given a position and delta time.
@@ -209,6 +213,10 @@ Set the animation step value.
Find the key index by time in a given track. Optionally, only find it if the exact time is given.
.. _class_Animation_track_get_interpolation_loop_wrap:
- :ref:`bool<class_bool>` **track_get_interpolation_loop_wrap** **(** :ref:`int<class_int>` idx **)** const
.. _class_Animation_track_get_interpolation_type:
- :ref:`int<class_int>` **track_get_interpolation_type** **(** :ref:`int<class_int>` idx **)** const
@@ -293,6 +301,10 @@ Remove a key by position (seconds) in a given track.
Set the given track as imported or not.
.. _class_Animation_track_set_interpolation_loop_wrap:
- void **track_set_interpolation_loop_wrap** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` interpolation **)**
.. _class_Animation_track_set_interpolation_type:
- void **track_set_interpolation_type** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` interpolation **)**
@@ -331,7 +343,7 @@ Return the interpolated value of a transform track at a given time (in seconds).
.. _class_Animation_value_track_get_key_indices:
- :ref:`IntArray<class_intarray>` **value_track_get_key_indices** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const
- :ref:`PoolIntArray<class_poolintarray>` **value_track_get_key_indices** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const
Return all the key indices of a value track, given a position and delta time.

View File

@@ -18,90 +18,97 @@ Container and player of :ref:`Animation<class_animation>` resources.
Member Functions
----------------
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`add_animation<class_AnimationPlayer_add_animation>` **(** :ref:`String<class_string>` name, :ref:`Animation<class_animation>` animation **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`advance<class_AnimationPlayer_advance>` **(** :ref:`float<class_float>` delta **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`animation_get_next<class_AnimationPlayer_animation_get_next>` **(** :ref:`String<class_string>` anim_from **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`animation_set_next<class_AnimationPlayer_animation_set_next>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_caches<class_AnimationPlayer_clear_caches>` **(** **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_queue<class_AnimationPlayer_clear_queue>` **(** **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`find_animation<class_AnimationPlayer_find_animation>` **(** :ref:`Animation<class_animation>` animation **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Animation<class_animation>` | :ref:`get_animation<class_AnimationPlayer_get_animation>` **(** :ref:`String<class_string>` name **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_animation_list<class_AnimationPlayer_get_animation_list>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_animation_process_mode<class_AnimationPlayer_get_animation_process_mode>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_autoplay<class_AnimationPlayer_get_autoplay>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_blend_time<class_AnimationPlayer_get_blend_time>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_current_animation<class_AnimationPlayer_get_current_animation>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_current_animation_length<class_AnimationPlayer_get_current_animation_length>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_current_animation_pos<class_AnimationPlayer_get_current_animation_pos>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_default_blend_time<class_AnimationPlayer_get_default_blend_time>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pos<class_AnimationPlayer_get_pos>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`get_root<class_AnimationPlayer_get_root>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_speed<class_AnimationPlayer_get_speed>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_animation<class_AnimationPlayer_has_animation>` **(** :ref:`String<class_string>` name **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_active<class_AnimationPlayer_is_active>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationPlayer_is_playing>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`play<class_AnimationPlayer_play>` **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1, :ref:`bool<class_bool>` from_end=false **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`play_backwards<class_AnimationPlayer_play_backwards>` **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1 **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`queue<class_AnimationPlayer_queue>` **(** :ref:`String<class_string>` name **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_animation<class_AnimationPlayer_remove_animation>` **(** :ref:`String<class_string>` name **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rename_animation<class_AnimationPlayer_rename_animation>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` newname **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`seek<class_AnimationPlayer_seek>` **(** :ref:`float<class_float>` pos_sec, :ref:`bool<class_bool>` update=false **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_active<class_AnimationPlayer_set_active>` **(** :ref:`bool<class_bool>` active **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_animation_process_mode<class_AnimationPlayer_set_animation_process_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_autoplay<class_AnimationPlayer_set_autoplay>` **(** :ref:`String<class_string>` name **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_blend_time<class_AnimationPlayer_set_blend_time>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to, :ref:`float<class_float>` sec **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_current_animation<class_AnimationPlayer_set_current_animation>` **(** :ref:`String<class_string>` anim **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_default_blend_time<class_AnimationPlayer_set_default_blend_time>` **(** :ref:`float<class_float>` sec **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_root<class_AnimationPlayer_set_root>` **(** :ref:`NodePath<class_nodepath>` path **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_speed<class_AnimationPlayer_set_speed>` **(** :ref:`float<class_float>` speed **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop<class_AnimationPlayer_stop>` **(** :ref:`bool<class_bool>` reset=true **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop_all<class_AnimationPlayer_stop_all>` **(** **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`add_animation<class_AnimationPlayer_add_animation>` **(** :ref:`String<class_string>` name, :ref:`Animation<class_animation>` animation **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`advance<class_AnimationPlayer_advance>` **(** :ref:`float<class_float>` delta **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`animation_get_next<class_AnimationPlayer_animation_get_next>` **(** :ref:`String<class_string>` anim_from **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`animation_set_next<class_AnimationPlayer_animation_set_next>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_caches<class_AnimationPlayer_clear_caches>` **(** **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_queue<class_AnimationPlayer_clear_queue>` **(** **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`find_animation<class_AnimationPlayer_find_animation>` **(** :ref:`Animation<class_animation>` animation **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Animation<class_animation>` | :ref:`get_animation<class_AnimationPlayer_get_animation>` **(** :ref:`String<class_string>` name **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_animation_list<class_AnimationPlayer_get_animation_list>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_animation_process_mode<class_AnimationPlayer_get_animation_process_mode>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_autoplay<class_AnimationPlayer_get_autoplay>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_blend_time<class_AnimationPlayer_get_blend_time>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_current_animation<class_AnimationPlayer_get_current_animation>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_current_animation_length<class_AnimationPlayer_get_current_animation_length>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_current_animation_pos<class_AnimationPlayer_get_current_animation_pos>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_default_blend_time<class_AnimationPlayer_get_default_blend_time>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pos<class_AnimationPlayer_get_pos>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`get_root<class_AnimationPlayer_get_root>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_speed_scale<class_AnimationPlayer_get_speed_scale>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_animation<class_AnimationPlayer_has_animation>` **(** :ref:`String<class_string>` name **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_active<class_AnimationPlayer_is_active>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationPlayer_is_playing>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`play<class_AnimationPlayer_play>` **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1, :ref:`bool<class_bool>` from_end=false **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`play_backwards<class_AnimationPlayer_play_backwards>` **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1 **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`queue<class_AnimationPlayer_queue>` **(** :ref:`String<class_string>` name **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_animation<class_AnimationPlayer_remove_animation>` **(** :ref:`String<class_string>` name **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rename_animation<class_AnimationPlayer_rename_animation>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` newname **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`seek<class_AnimationPlayer_seek>` **(** :ref:`float<class_float>` pos_sec, :ref:`bool<class_bool>` update=false **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_active<class_AnimationPlayer_set_active>` **(** :ref:`bool<class_bool>` active **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_animation_process_mode<class_AnimationPlayer_set_animation_process_mode>` **(** :ref:`int<class_int>` mode **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_autoplay<class_AnimationPlayer_set_autoplay>` **(** :ref:`String<class_string>` name **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_blend_time<class_AnimationPlayer_set_blend_time>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to, :ref:`float<class_float>` sec **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_current_animation<class_AnimationPlayer_set_current_animation>` **(** :ref:`String<class_string>` anim **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_default_blend_time<class_AnimationPlayer_set_default_blend_time>` **(** :ref:`float<class_float>` sec **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_root<class_AnimationPlayer_set_root>` **(** :ref:`NodePath<class_nodepath>` path **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_speed_scale<class_AnimationPlayer_set_speed_scale>` **(** :ref:`float<class_float>` speed **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop<class_AnimationPlayer_stop>` **(** :ref:`bool<class_bool>` reset=true **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop_all<class_AnimationPlayer_stop_all>` **(** **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
- **animation_changed** **(** :ref:`String<class_string>` old_name, :ref:`String<class_string>` new_name **)**
- **animation_finished** **(** :ref:`String<class_string>` name **)**
- **animation_started** **(** :ref:`String<class_string>` name **)**
- **finished** **(** **)**
Member Variables
----------------
- :ref:`float<class_float>` **playback_default_blend_time**
- :ref:`int<class_int>` **playback_process_mode**
- :ref:`NodePath<class_nodepath>` **root_node**
Numeric Constants
-----------------
@@ -163,7 +170,7 @@ Get an :ref:`Animation<class_animation>` resource by requesting a name.
.. _class_AnimationPlayer_get_animation_list:
- :ref:`StringArray<class_stringarray>` **get_animation_list** **(** **)** const
- :ref:`PoolStringArray<class_poolstringarray>` **get_animation_list** **(** **)** const
Get the list of names of the animations stored in the player.
@@ -221,9 +228,9 @@ Return the playback position (in seconds) in an animation channel (or channel 0
Return path to root node (see :ref:`set_root<class_AnimationPlayer_set_root>`).
.. _class_AnimationPlayer_get_speed:
.. _class_AnimationPlayer_get_speed_scale:
- :ref:`float<class_float>` **get_speed** **(** **)** const
- :ref:`float<class_float>` **get_speed_scale** **(** **)** const
Get the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is *1* (no scaling).
@@ -323,9 +330,9 @@ Set the default blend time between animations.
AnimationPlayer resolves animation track paths from this node (which is relative to itself), by default root is "..", but it can be changed.
.. _class_AnimationPlayer_set_speed:
.. _class_AnimationPlayer_set_speed_scale:
- void **set_speed** **(** :ref:`float<class_float>` speed **)**
- void **set_speed_scale** **(** :ref:`float<class_float>` speed **)**
Set a speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is *1* (no scaling).

View File

@@ -18,135 +18,140 @@ Animation Player that uses a node graph for the blending.
Member Functions
----------------
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_node<class_AnimationTreePlayer_add_node>` **(** :ref:`int<class_int>` type, :ref:`String<class_string>` id **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`advance<class_AnimationTreePlayer_advance>` **(** :ref:`float<class_float>` delta **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Animation<class_animation>` | :ref:`animation_node_get_animation<class_AnimationTreePlayer_animation_node_get_animation>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`animation_node_get_master_animation<class_AnimationTreePlayer_animation_node_get_master_animation>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`animation_node_set_animation<class_AnimationTreePlayer_animation_node_set_animation>` **(** :ref:`String<class_string>` id, :ref:`Animation<class_animation>` animation **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`animation_node_set_filter_path<class_AnimationTreePlayer_animation_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`animation_node_set_master_animation<class_AnimationTreePlayer_animation_node_set_master_animation>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` source **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`blend2_node_get_amount<class_AnimationTreePlayer_blend2_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend2_node_set_amount<class_AnimationTreePlayer_blend2_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend2_node_set_filter_path<class_AnimationTreePlayer_blend2_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`blend3_node_get_amount<class_AnimationTreePlayer_blend3_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend3_node_set_amount<class_AnimationTreePlayer_blend3_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`blend4_node_get_amount<class_AnimationTreePlayer_blend4_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend4_node_set_amount<class_AnimationTreePlayer_blend4_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` blend **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`connect<class_AnimationTreePlayer_connect>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect<class_AnimationTreePlayer_disconnect>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` dst_input_idx **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_animation_process_mode<class_AnimationTreePlayer_get_animation_process_mode>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`get_base_path<class_AnimationTreePlayer_get_base_path>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`get_master_player<class_AnimationTreePlayer_get_master_player>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_node_list<class_AnimationTreePlayer_get_node_list>` **(** **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_active<class_AnimationTreePlayer_is_active>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_connected<class_AnimationTreePlayer_is_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:`mix_node_get_amount<class_AnimationTreePlayer_mix_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`mix_node_set_amount<class_AnimationTreePlayer_mix_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` ratio **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`node_exists<class_AnimationTreePlayer_node_exists>` **(** :ref:`String<class_string>` node **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`node_get_input_count<class_AnimationTreePlayer_node_get_input_count>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`node_get_input_source<class_AnimationTreePlayer_node_get_input_source>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` idx **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`node_get_pos<class_AnimationTreePlayer_node_get_pos>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`node_get_type<class_AnimationTreePlayer_node_get_type>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`node_rename<class_AnimationTreePlayer_node_rename>` **(** :ref:`String<class_string>` node, :ref:`String<class_string>` new_name **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`node_set_pos<class_AnimationTreePlayer_node_set_pos>` **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` screen_pos **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_delay>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_random_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadein_time<class_AnimationTreePlayer_oneshot_node_get_fadein_time>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadeout_time<class_AnimationTreePlayer_oneshot_node_get_fadeout_time>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`oneshot_node_has_autorestart<class_AnimationTreePlayer_oneshot_node_has_autorestart>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`oneshot_node_is_active<class_AnimationTreePlayer_oneshot_node_is_active>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_autorestart<class_AnimationTreePlayer_oneshot_node_set_autorestart>` **(** :ref:`String<class_string>` id, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_autorestart_delay<class_AnimationTreePlayer_oneshot_node_set_autorestart_delay>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` delay_sec **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_autorestart_random_delay<class_AnimationTreePlayer_oneshot_node_set_autorestart_random_delay>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` rand_sec **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_fadein_time<class_AnimationTreePlayer_oneshot_node_set_fadein_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_fadeout_time<class_AnimationTreePlayer_oneshot_node_set_fadeout_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_filter_path<class_AnimationTreePlayer_oneshot_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_start<class_AnimationTreePlayer_oneshot_node_start>` **(** :ref:`String<class_string>` id **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_stop<class_AnimationTreePlayer_oneshot_node_stop>` **(** :ref:`String<class_string>` id **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`recompute_caches<class_AnimationTreePlayer_recompute_caches>` **(** **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_node<class_AnimationTreePlayer_remove_node>` **(** :ref:`String<class_string>` id **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`reset<class_AnimationTreePlayer_reset>` **(** **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_active<class_AnimationTreePlayer_set_active>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_animation_process_mode<class_AnimationTreePlayer_set_animation_process_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_base_path<class_AnimationTreePlayer_set_base_path>` **(** :ref:`NodePath<class_nodepath>` path **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_master_player<class_AnimationTreePlayer_set_master_player>` **(** :ref:`NodePath<class_nodepath>` nodepath **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`timescale_node_get_scale<class_AnimationTreePlayer_timescale_node_get_scale>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`timescale_node_set_scale<class_AnimationTreePlayer_timescale_node_set_scale>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` scale **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`timeseek_node_seek<class_AnimationTreePlayer_timeseek_node_seek>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` pos_sec **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_delete_input<class_AnimationTreePlayer_transition_node_delete_input>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`transition_node_get_current<class_AnimationTreePlayer_transition_node_get_current>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`transition_node_get_input_count<class_AnimationTreePlayer_transition_node_get_input_count>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`transition_node_get_xfade_time<class_AnimationTreePlayer_transition_node_get_xfade_time>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`transition_node_has_input_auto_advance<class_AnimationTreePlayer_transition_node_has_input_auto_advance>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_current<class_AnimationTreePlayer_transition_node_set_current>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_input_auto_advance<class_AnimationTreePlayer_transition_node_set_input_auto_advance>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_input_count<class_AnimationTreePlayer_transition_node_set_input_count>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` count **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_xfade_time<class_AnimationTreePlayer_transition_node_set_xfade_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_node<class_AnimationTreePlayer_add_node>` **(** :ref:`int<class_int>` type, :ref:`String<class_string>` id **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`advance<class_AnimationTreePlayer_advance>` **(** :ref:`float<class_float>` delta **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Animation<class_animation>` | :ref:`animation_node_get_animation<class_AnimationTreePlayer_animation_node_get_animation>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`animation_node_get_master_animation<class_AnimationTreePlayer_animation_node_get_master_animation>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`animation_node_set_animation<class_AnimationTreePlayer_animation_node_set_animation>` **(** :ref:`String<class_string>` id, :ref:`Animation<class_animation>` animation **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`animation_node_set_filter_path<class_AnimationTreePlayer_animation_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`animation_node_set_master_animation<class_AnimationTreePlayer_animation_node_set_master_animation>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` source **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`are_nodes_connected<class_AnimationTreePlayer_are_nodes_connected>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`blend2_node_get_amount<class_AnimationTreePlayer_blend2_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend2_node_set_amount<class_AnimationTreePlayer_blend2_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend2_node_set_filter_path<class_AnimationTreePlayer_blend2_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`blend3_node_get_amount<class_AnimationTreePlayer_blend3_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend3_node_set_amount<class_AnimationTreePlayer_blend3_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`blend4_node_get_amount<class_AnimationTreePlayer_blend4_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend4_node_set_amount<class_AnimationTreePlayer_blend4_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` blend **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`connect_nodes<class_AnimationTreePlayer_connect_nodes>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect_nodes<class_AnimationTreePlayer_disconnect_nodes>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` dst_input_idx **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_animation_process_mode<class_AnimationTreePlayer_get_animation_process_mode>` **(** **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`get_base_path<class_AnimationTreePlayer_get_base_path>` **(** **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`get_master_player<class_AnimationTreePlayer_get_master_player>` **(** **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_node_list<class_AnimationTreePlayer_get_node_list>` **(** **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_active<class_AnimationTreePlayer_is_active>` **(** **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`mix_node_get_amount<class_AnimationTreePlayer_mix_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`mix_node_set_amount<class_AnimationTreePlayer_mix_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` ratio **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`node_exists<class_AnimationTreePlayer_node_exists>` **(** :ref:`String<class_string>` node **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`node_get_input_count<class_AnimationTreePlayer_node_get_input_count>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`node_get_input_source<class_AnimationTreePlayer_node_get_input_source>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` idx **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`node_get_pos<class_AnimationTreePlayer_node_get_pos>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`node_get_type<class_AnimationTreePlayer_node_get_type>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`node_rename<class_AnimationTreePlayer_node_rename>` **(** :ref:`String<class_string>` node, :ref:`String<class_string>` new_name **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`node_set_pos<class_AnimationTreePlayer_node_set_pos>` **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` screen_pos **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_delay>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_random_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadein_time<class_AnimationTreePlayer_oneshot_node_get_fadein_time>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadeout_time<class_AnimationTreePlayer_oneshot_node_get_fadeout_time>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`oneshot_node_has_autorestart<class_AnimationTreePlayer_oneshot_node_has_autorestart>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`oneshot_node_is_active<class_AnimationTreePlayer_oneshot_node_is_active>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_autorestart<class_AnimationTreePlayer_oneshot_node_set_autorestart>` **(** :ref:`String<class_string>` id, :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_autorestart_delay<class_AnimationTreePlayer_oneshot_node_set_autorestart_delay>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` delay_sec **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_autorestart_random_delay<class_AnimationTreePlayer_oneshot_node_set_autorestart_random_delay>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` rand_sec **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_fadein_time<class_AnimationTreePlayer_oneshot_node_set_fadein_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_fadeout_time<class_AnimationTreePlayer_oneshot_node_set_fadeout_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_filter_path<class_AnimationTreePlayer_oneshot_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_start<class_AnimationTreePlayer_oneshot_node_start>` **(** :ref:`String<class_string>` id **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_stop<class_AnimationTreePlayer_oneshot_node_stop>` **(** :ref:`String<class_string>` id **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`recompute_caches<class_AnimationTreePlayer_recompute_caches>` **(** **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_node<class_AnimationTreePlayer_remove_node>` **(** :ref:`String<class_string>` id **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`reset<class_AnimationTreePlayer_reset>` **(** **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_active<class_AnimationTreePlayer_set_active>` **(** :ref:`bool<class_bool>` enabled **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_animation_process_mode<class_AnimationTreePlayer_set_animation_process_mode>` **(** :ref:`int<class_int>` mode **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_base_path<class_AnimationTreePlayer_set_base_path>` **(** :ref:`NodePath<class_nodepath>` path **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_master_player<class_AnimationTreePlayer_set_master_player>` **(** :ref:`NodePath<class_nodepath>` nodepath **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`timescale_node_get_scale<class_AnimationTreePlayer_timescale_node_get_scale>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`timescale_node_set_scale<class_AnimationTreePlayer_timescale_node_set_scale>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` scale **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`timeseek_node_seek<class_AnimationTreePlayer_timeseek_node_seek>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` pos_sec **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_delete_input<class_AnimationTreePlayer_transition_node_delete_input>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`transition_node_get_current<class_AnimationTreePlayer_transition_node_get_current>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`transition_node_get_input_count<class_AnimationTreePlayer_transition_node_get_input_count>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`transition_node_get_xfade_time<class_AnimationTreePlayer_transition_node_get_xfade_time>` **(** :ref:`String<class_string>` id **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`transition_node_has_input_auto_advance<class_AnimationTreePlayer_transition_node_has_input_auto_advance>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_current<class_AnimationTreePlayer_transition_node_set_current>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_input_auto_advance<class_AnimationTreePlayer_transition_node_set_input_auto_advance>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_input_count<class_AnimationTreePlayer_transition_node_set_input_count>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` count **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_xfade_time<class_AnimationTreePlayer_transition_node_set_xfade_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`int<class_int>` **playback_process_mode**
Numeric Constants
-----------------
@@ -202,6 +207,10 @@ Set the animation for an animation node.
- void **animation_node_set_master_animation** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` source **)**
.. _class_AnimationTreePlayer_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
.. _class_AnimationTreePlayer_blend2_node_get_amount:
- :ref:`float<class_float>` **blend2_node_get_amount** **(** :ref:`String<class_string>` id **)** const
@@ -230,13 +239,13 @@ Set the animation for an animation node.
- void **blend4_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` blend **)**
.. _class_AnimationTreePlayer_connect:
.. _class_AnimationTreePlayer_connect_nodes:
- :ref:`int<class_int>` **connect** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)**
- :ref:`int<class_int>` **connect_nodes** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)**
.. _class_AnimationTreePlayer_disconnect:
.. _class_AnimationTreePlayer_disconnect_nodes:
- void **disconnect** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` dst_input_idx **)**
- void **disconnect_nodes** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` dst_input_idx **)**
.. _class_AnimationTreePlayer_get_animation_process_mode:
@@ -252,16 +261,12 @@ Set the animation for an animation node.
.. _class_AnimationTreePlayer_get_node_list:
- :ref:`StringArray<class_stringarray>` **get_node_list** **(** **)**
- :ref:`PoolStringArray<class_poolstringarray>` **get_node_list** **(** **)**
.. _class_AnimationTreePlayer_is_active:
- :ref:`bool<class_bool>` **is_active** **(** **)** const
.. _class_AnimationTreePlayer_is_connected:
- :ref:`bool<class_bool>` **is_connected** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const
.. _class_AnimationTreePlayer_mix_node_get_amount:
- :ref:`float<class_float>` **mix_node_get_amount** **(** :ref:`String<class_string>` id **)** const

View File

@@ -49,7 +49,7 @@ Member Functions
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_monitorable<class_Area_is_monitorable>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_monitoring_enabled<class_Area_is_monitoring_enabled>` **(** **)** const |
| :ref:`bool<class_bool>` | :ref:`is_monitoring<class_Area_is_monitoring>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area_overlaps_area>` **(** :ref:`Object<class_object>` area **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
@@ -61,8 +61,6 @@ Member Functions
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_mask_bit<class_Area_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_enable_monitoring<class_Area_set_enable_monitoring>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity<class_Area_set_gravity>` **(** :ref:`float<class_float>` gravity **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity_distance_scale<class_Area_set_gravity_distance_scale>` **(** :ref:`float<class_float>` distance_scale **)** |
@@ -79,6 +77,8 @@ Member Functions
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_monitorable<class_Area_set_monitorable>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_monitoring<class_Area_set_monitoring>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_priority<class_Area_set_priority>` **(** :ref:`float<class_float>` priority **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_space_override_mode<class_Area_set_space_override_mode>` **(** :ref:`int<class_int>` enable **)** |
@@ -87,14 +87,30 @@ Member Functions
Signals
-------
- **area_enter** **(** :ref:`Object<class_object>` area **)**
- **area_enter_shape** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
- **area_exit** **(** :ref:`Object<class_object>` area **)**
- **area_exit_shape** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
- **body_enter** **(** :ref:`Object<class_object>` body **)**
- **body_enter_shape** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
- **body_exit** **(** :ref:`Object<class_object>` body **)**
- **body_exit_shape** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
- **area_entered** **(** :ref:`Object<class_object>` area **)**
- **area_exited** **(** :ref:`Object<class_object>` area **)**
- **area_shape_entered** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
- **area_shape_exited** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
- **body_entered** **(** :ref:`Object<class_object>` body **)**
- **body_exited** **(** :ref:`Object<class_object>` body **)**
- **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
- **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
Member Variables
----------------
- :ref:`float<class_float>` **angular_damp**
- :ref:`int<class_int>` **collision_layers**
- :ref:`int<class_int>` **collision_mask**
- :ref:`float<class_float>` **gravity**
- :ref:`float<class_float>` **gravity_distance_scale**
- :ref:`bool<class_bool>` **gravity_point**
- :ref:`Vector3<class_vector3>` **gravity_vec**
- :ref:`float<class_float>` **linear_damp**
- :ref:`bool<class_bool>` **monitorable**
- :ref:`bool<class_bool>` **monitoring**
- :ref:`int<class_int>` **priority**
- :ref:`int<class_int>` **space_override**
Description
-----------
@@ -194,9 +210,9 @@ Return whether gravity is a point. A point gravity will attract objects towards
Return whether this area can be detected by other, monitoring, areas.
.. _class_Area_is_monitoring_enabled:
.. _class_Area_is_monitoring:
- :ref:`bool<class_bool>` **is_monitoring_enabled** **(** **)** const
- :ref:`bool<class_bool>` **is_monitoring** **(** **)** const
Return whether this area detects bodies/areas entering/exiting it.
@@ -232,12 +248,6 @@ Set the physics layers this area can scan for collisions.
Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
.. _class_Area_set_enable_monitoring:
- void **set_enable_monitoring** **(** :ref:`bool<class_bool>` enable **)**
Set whether this area can detect bodies/areas entering/exiting it.
.. _class_Area_set_gravity:
- void **set_gravity** **(** :ref:`float<class_float>` gravity **)**
@@ -296,6 +306,12 @@ In practice, as the fraction of speed lost gets smaller with each frame, a value
Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so.
.. _class_Area_set_monitoring:
- void **set_monitoring** **(** :ref:`bool<class_bool>` enable **)**
Set whether this area can detect bodies/areas entering/exiting it.
.. _class_Area_set_priority:
- void **set_priority** **(** :ref:`float<class_float>` priority **)**

View File

@@ -49,7 +49,7 @@ Member Functions
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_monitorable<class_Area2D_is_monitorable>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_monitoring_enabled<class_Area2D_is_monitoring_enabled>` **(** **)** const |
| :ref:`bool<class_bool>` | :ref:`is_monitoring<class_Area2D_is_monitoring>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area2D_overlaps_area>` **(** :ref:`Object<class_object>` area **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
@@ -61,8 +61,6 @@ Member Functions
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_mask_bit<class_Area2D_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_enable_monitoring<class_Area2D_set_enable_monitoring>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity<class_Area2D_set_gravity>` **(** :ref:`float<class_float>` gravity **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity_distance_scale<class_Area2D_set_gravity_distance_scale>` **(** :ref:`float<class_float>` distance_scale **)** |
@@ -79,6 +77,8 @@ Member Functions
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_monitorable<class_Area2D_set_monitorable>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_monitoring<class_Area2D_set_monitoring>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_priority<class_Area2D_set_priority>` **(** :ref:`float<class_float>` priority **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_space_override_mode<class_Area2D_set_space_override_mode>` **(** :ref:`int<class_int>` enable **)** |
@@ -87,14 +87,30 @@ Member Functions
Signals
-------
- **area_enter** **(** :ref:`Object<class_object>` area **)**
- **area_enter_shape** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
- **area_exit** **(** :ref:`Object<class_object>` area **)**
- **area_exit_shape** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
- **body_enter** **(** :ref:`Object<class_object>` body **)**
- **body_enter_shape** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
- **body_exit** **(** :ref:`Object<class_object>` body **)**
- **body_exit_shape** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
- **area_entered** **(** :ref:`Object<class_object>` area **)**
- **area_exited** **(** :ref:`Object<class_object>` area **)**
- **area_shape_entered** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
- **area_shape_exited** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
- **body_entered** **(** :ref:`Object<class_object>` body **)**
- **body_exited** **(** :ref:`Object<class_object>` body **)**
- **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
- **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
Member Variables
----------------
- :ref:`float<class_float>` **angular_damp**
- :ref:`int<class_int>` **collision_layers**
- :ref:`int<class_int>` **collision_mask**
- :ref:`float<class_float>` **gravity**
- :ref:`float<class_float>` **gravity_distance_scale**
- :ref:`bool<class_bool>` **gravity_point**
- :ref:`Vector2<class_vector2>` **gravity_vec**
- :ref:`float<class_float>` **linear_damp**
- :ref:`bool<class_bool>` **monitorable**
- :ref:`bool<class_bool>` **monitoring**
- :ref:`int<class_int>` **priority**
- :ref:`int<class_int>` **space_override**
Description
-----------
@@ -194,9 +210,9 @@ Return whether gravity is a point. A point gravity will attract objects towards
Return whether this area can be detected by other, monitoring, areas.
.. _class_Area2D_is_monitoring_enabled:
.. _class_Area2D_is_monitoring:
- :ref:`bool<class_bool>` **is_monitoring_enabled** **(** **)** const
- :ref:`bool<class_bool>` **is_monitoring** **(** **)** const
Return whether this area detects bodies/areas entering/exiting it.
@@ -232,12 +248,6 @@ Set the physics layers this area can scan for collisions.
Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
.. _class_Area2D_set_enable_monitoring:
- void **set_enable_monitoring** **(** :ref:`bool<class_bool>` enable **)**
Set whether this area can detect bodies/areas entering/exiting it.
.. _class_Area2D_set_gravity:
- void **set_gravity** **(** :ref:`float<class_float>` gravity **)**
@@ -296,6 +306,12 @@ In practice, as the fraction of speed lost gets smaller with each frame, a value
Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so.
.. _class_Area2D_set_monitoring:
- void **set_monitoring** **(** :ref:`bool<class_bool>` enable **)**
Set whether this area can detect bodies/areas entering/exiting it.
.. _class_Area2D_set_priority:
- void **set_priority** **(** :ref:`float<class_float>` priority **)**

View File

@@ -16,69 +16,67 @@ Generic array datatype.
Member Functions
----------------
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`ColorArray<class_colorarray>` from **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`Vector3Array<class_vector3array>` from **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`Vector2Array<class_vector2array>` from **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`StringArray<class_stringarray>` from **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`RealArray<class_realarray>` from **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`IntArray<class_intarray>` from **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`RawArray<class_rawarray>` from **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`append<class_Array_append>` **(** var value **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_Array_clear>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`count<class_Array_count>` **(** var value **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`empty<class_Array_empty>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase<class_Array_erase>` **(** var value **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`front<class_Array_front>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`back<class_Array_back>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`find<class_Array_find>` **(** var what, :ref:`int<class_int>` from=0 **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`find_last<class_Array_find_last>` **(** var value **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has<class_Array_has>` **(** var value **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`hash<class_Array_hash>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`insert<class_Array_insert>` **(** :ref:`int<class_int>` pos, var value **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`invert<class_Array_invert>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_shared<class_Array_is_shared>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`pop_back<class_Array_pop_back>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`pop_front<class_Array_pop_front>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_back<class_Array_push_back>` **(** var value **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_front<class_Array_push_front>` **(** var value **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove<class_Array_remove>` **(** :ref:`int<class_int>` pos **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`resize<class_Array_resize>` **(** :ref:`int<class_int>` pos **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`rfind<class_Array_rfind>` **(** var what, :ref:`int<class_int>` from=-1 **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size<class_Array_size>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sort<class_Array_sort>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sort_custom<class_Array_sort_custom>` **(** :ref:`Object<class_object>` obj, :ref:`String<class_string>` func **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolColorArray<class_poolcolorarray>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolVector3Array<class_poolvector3array>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolVector2Array<class_poolvector2array>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolStringArray<class_poolstringarray>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolRealArray<class_poolrealarray>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolIntArray<class_poolintarray>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolByteArray<class_poolbytearray>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`append<class_Array_append>` **(** var value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`back<class_Array_back>` **(** **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_Array_clear>` **(** **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`count<class_Array_count>` **(** var value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`empty<class_Array_empty>` **(** **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase<class_Array_erase>` **(** var value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`find<class_Array_find>` **(** var what, :ref:`int<class_int>` from=0 **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`find_last<class_Array_find_last>` **(** var value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`front<class_Array_front>` **(** **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has<class_Array_has>` **(** var value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`hash<class_Array_hash>` **(** **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`insert<class_Array_insert>` **(** :ref:`int<class_int>` pos, var value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`invert<class_Array_invert>` **(** **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`pop_back<class_Array_pop_back>` **(** **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`pop_front<class_Array_pop_front>` **(** **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_back<class_Array_push_back>` **(** var value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_front<class_Array_push_front>` **(** var value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove<class_Array_remove>` **(** :ref:`int<class_int>` pos **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`resize<class_Array_resize>` **(** :ref:`int<class_int>` pos **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`rfind<class_Array_rfind>` **(** var what, :ref:`int<class_int>` from=-1 **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size<class_Array_size>` **(** **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sort<class_Array_sort>` **(** **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sort_custom<class_Array_sort_custom>` **(** :ref:`Object<class_object>` obj, :ref:`String<class_string>` func **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -90,45 +88,45 @@ Member Function Description
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`ColorArray<class_colorarray>` from **)**
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolColorArray<class_poolcolorarray>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
Construct an array from a :ref:`PoolByteArray<class_poolbytearray>`.
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`Vector3Array<class_vector3array>` from **)**
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolVector3Array<class_poolvector3array>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
Construct an array from a :ref:`PoolByteArray<class_poolbytearray>`.
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`Vector2Array<class_vector2array>` from **)**
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolVector2Array<class_poolvector2array>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
Construct an array from a :ref:`PoolByteArray<class_poolbytearray>`.
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`StringArray<class_stringarray>` from **)**
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolStringArray<class_poolstringarray>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
Construct an array from a :ref:`PoolStringArray<class_poolstringarray>`.
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`RealArray<class_realarray>` from **)**
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolRealArray<class_poolrealarray>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
Construct an array from a :ref:`PoolRealArray<class_poolrealarray>`.
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`IntArray<class_intarray>` from **)**
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolIntArray<class_poolintarray>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
Construct an array from a :ref:`PoolByteArray<class_poolbytearray>`.
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`RawArray<class_rawarray>` from **)**
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolByteArray<class_poolbytearray>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
Construct an array from a :ref:`PoolByteArray<class_poolbytearray>`.
.. _class_Array_append:
@@ -136,6 +134,12 @@ Construct an array from a :ref:`RawArray<class_rawarray>`.
Append an element at the end of the array (alias of :ref:`push_back<class_Array_push_back>`).
.. _class_Array_back:
- void **back** **(** **)**
Returns the last element of the array if the array is not empty (size>0).
.. _class_Array_clear:
- void **clear** **(** **)**
@@ -160,18 +164,6 @@ Return true if the array is empty (size==0).
Remove the first occurrence of a value from the array.
.. _class_Array_front:
- :ref:`Variant<class_variant>` **front** **(** **)**
Returns the first element of the array if the array is not empty (size>0).
.. _class_Array_back:
- :ref:`Variant<class_variant>` **back** **(** **)**
Returns the last element of the array if the array is not empty (size>0).
.. _class_Array_find:
- :ref:`int<class_int>` **find** **(** var what, :ref:`int<class_int>` from=0 **)**
@@ -184,6 +176,12 @@ Searches the array for a value and returns its index or -1 if not found. Optiona
Searches the array in reverse order for a value and returns its index or -1 if not found.
.. _class_Array_front:
- void **front** **(** **)**
Returns the first element of the array if the array is not empty (size>0).
.. _class_Array_has:
- :ref:`bool<class_bool>` **has** **(** var value **)**
@@ -208,12 +206,6 @@ Insert a new element at a given position in the array. The position must be vali
Reverse the order of the elements in the array (so first element will now be the last).
.. _class_Array_is_shared:
- :ref:`bool<class_bool>` **is_shared** **(** **)**
Get whether this is a shared array instance.
.. _class_Array_pop_back:
- void **pop_back** **(** **)**

View File

@@ -18,37 +18,49 @@ Brief Description
Member Functions
----------------
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_AStar_add_point>` **(** :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` pos, :ref:`float<class_float>` weight_scale=1 **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`are_points_connected<class_AStar_are_points_connected>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_AStar_clear>` **(** **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`connect_points<class_AStar_connect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect_points<class_AStar_disconnect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_available_point_id<class_AStar_get_available_point_id>` **(** **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_closest_point<class_AStar_get_closest_point>` **(** :ref:`Vector3<class_vector3>` to_pos **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_closest_pos_in_segment<class_AStar_get_closest_pos_in_segment>` **(** :ref:`Vector3<class_vector3>` to_pos **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`IntArray<class_intarray>` | :ref:`get_id_path<class_AStar_get_id_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`get_point_path<class_AStar_get_point_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_pos<class_AStar_get_point_pos>` **(** :ref:`int<class_int>` id **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_point_weight_scale<class_AStar_get_point_weight_scale>` **(** :ref:`int<class_int>` id **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_AStar_remove_point>` **(** :ref:`int<class_int>` id **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_compute_cost<class_AStar__compute_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_estimate_cost<class_AStar__estimate_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_AStar_add_point>` **(** :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` pos, :ref:`float<class_float>` weight_scale=1 **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`are_points_connected<class_AStar_are_points_connected>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_AStar_clear>` **(** **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`connect_points<class_AStar_connect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect_points<class_AStar_disconnect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_available_point_id<class_AStar_get_available_point_id>` **(** **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_closest_point<class_AStar_get_closest_point>` **(** :ref:`Vector3<class_vector3>` to_pos **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_closest_pos_in_segment<class_AStar_get_closest_pos_in_segment>` **(** :ref:`Vector3<class_vector3>` to_pos **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_id_path<class_AStar_get_id_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_point_path<class_AStar_get_point_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_pos<class_AStar_get_point_pos>` **(** :ref:`int<class_int>` id **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_point_weight_scale<class_AStar_get_point_weight_scale>` **(** :ref:`int<class_int>` id **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_AStar_remove_point>` **(** :ref:`int<class_int>` id **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_AStar__compute_cost:
- void **_compute_cost** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual
.. _class_AStar__estimate_cost:
- void **_estimate_cost** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual
.. _class_AStar_add_point:
- void **add_point** **(** :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` pos, :ref:`float<class_float>` weight_scale=1 **)**
@@ -83,11 +95,11 @@ Member Function Description
.. _class_AStar_get_id_path:
- :ref:`IntArray<class_intarray>` **get_id_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
- :ref:`PoolIntArray<class_poolintarray>` **get_id_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
.. _class_AStar_get_point_path:
- :ref:`Vector3Array<class_vector3array>` **get_point_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
- :ref:`PoolVector3Array<class_poolvector3array>` **get_point_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
.. _class_AStar_get_point_pos:

View File

@@ -37,6 +37,13 @@ Signals
- **atlas_changed** **(** **)**
Member Variables
----------------
- :ref:`Texture<class_texture>` **atlas**
- :ref:`Rect2<class_rect2>` **margin**
- :ref:`Rect2<class_rect2>` **region**
Member Function Description
---------------------------

View File

@@ -1,12 +1,12 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_MaterialShader:
.. _class_AudioBusLayout:
MaterialShader
AudioBusLayout
==============
**Inherits:** :ref:`Shader<class_shader>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core

View File

@@ -0,0 +1,19 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffect:
AudioEffect
===========
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Inherited By:** :ref:`AudioEffectCompressor<class_audioeffectcompressor>`, :ref:`AudioEffectAmplify<class_audioeffectamplify>`, :ref:`AudioEffectFilter<class_audioeffectfilter>`, :ref:`AudioEffectDistortion<class_audioeffectdistortion>`, :ref:`AudioEffectLimiter<class_audioeffectlimiter>`, :ref:`AudioEffectDelay<class_audioeffectdelay>`, :ref:`AudioEffectStereoEnhance<class_audioeffectstereoenhance>`, :ref:`AudioEffectReverb<class_audioeffectreverb>`, :ref:`AudioEffectPanner<class_audioeffectpanner>`, :ref:`AudioEffectEQ<class_audioeffecteq>`, :ref:`AudioEffectChorus<class_audioeffectchorus>`, :ref:`AudioEffectPitchShift<class_audioeffectpitchshift>`, :ref:`AudioEffectPhaser<class_audioeffectphaser>`
**Category:** Core
Brief Description
-----------------

View File

@@ -0,0 +1,43 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectAmplify:
AudioEffectAmplify
==================
**Inherits:** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+----------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_volume_db<class_AudioEffectAmplify_get_volume_db>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_volume_db<class_AudioEffectAmplify_set_volume_db>` **(** :ref:`float<class_float>` volume **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **volume_db**
Member Function Description
---------------------------
.. _class_AudioEffectAmplify_get_volume_db:
- :ref:`float<class_float>` **get_volume_db** **(** **)** const
.. _class_AudioEffectAmplify_set_volume_db:
- void **set_volume_db** **(** :ref:`float<class_float>` volume **)**

View File

@@ -0,0 +1,17 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectBandLimitFilter:
AudioEffectBandLimitFilter
==========================
**Inherits:** :ref:`AudioEffectFilter<class_audioeffectfilter>` **<** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------

View File

@@ -0,0 +1,17 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectBandPassFilter:
AudioEffectBandPassFilter
=========================
**Inherits:** :ref:`AudioEffectFilter<class_audioeffectfilter>` **<** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------

View File

@@ -0,0 +1,165 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectChorus:
AudioEffectChorus
=================
**Inherits:** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_dry<class_AudioEffectChorus_get_dry>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_voice_count<class_AudioEffectChorus_get_voice_count>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_voice_cutoff_hz<class_AudioEffectChorus_get_voice_cutoff_hz>` **(** :ref:`int<class_int>` voice_idx **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_voice_delay_ms<class_AudioEffectChorus_get_voice_delay_ms>` **(** :ref:`int<class_int>` voice_idx **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_voice_depth_ms<class_AudioEffectChorus_get_voice_depth_ms>` **(** :ref:`int<class_int>` voice_idx **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_voice_level_db<class_AudioEffectChorus_get_voice_level_db>` **(** :ref:`int<class_int>` voice_idx **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_voice_pan<class_AudioEffectChorus_get_voice_pan>` **(** :ref:`int<class_int>` voice_idx **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_voice_rate_hz<class_AudioEffectChorus_get_voice_rate_hz>` **(** :ref:`int<class_int>` voice_idx **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_wet<class_AudioEffectChorus_get_wet>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_dry<class_AudioEffectChorus_set_dry>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_voice_count<class_AudioEffectChorus_set_voice_count>` **(** :ref:`int<class_int>` voices **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_voice_cutoff_hz<class_AudioEffectChorus_set_voice_cutoff_hz>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_voice_delay_ms<class_AudioEffectChorus_set_voice_delay_ms>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_voice_depth_ms<class_AudioEffectChorus_set_voice_depth_ms>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_voice_level_db<class_AudioEffectChorus_set_voice_level_db>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_voice_pan<class_AudioEffectChorus_set_voice_pan>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_voice_rate_hz<class_AudioEffectChorus_set_voice_rate_hz>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_wet<class_AudioEffectChorus_set_wet>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **dry**
- :ref:`float<class_float>` **voice/1/cutoff_hz**
- :ref:`float<class_float>` **voice/1/delay_ms**
- :ref:`float<class_float>` **voice/1/depth_ms**
- :ref:`float<class_float>` **voice/1/level_db**
- :ref:`float<class_float>` **voice/1/pan**
- :ref:`float<class_float>` **voice/1/rate_hz**
- :ref:`float<class_float>` **voice/2/cutoff_hz**
- :ref:`float<class_float>` **voice/2/delay_ms**
- :ref:`float<class_float>` **voice/2/depth_ms**
- :ref:`float<class_float>` **voice/2/level_db**
- :ref:`float<class_float>` **voice/2/pan**
- :ref:`float<class_float>` **voice/2/rate_hz**
- :ref:`float<class_float>` **voice/3/cutoff_hz**
- :ref:`float<class_float>` **voice/3/delay_ms**
- :ref:`float<class_float>` **voice/3/depth_ms**
- :ref:`float<class_float>` **voice/3/level_db**
- :ref:`float<class_float>` **voice/3/pan**
- :ref:`float<class_float>` **voice/3/rate_hz**
- :ref:`float<class_float>` **voice/4/cutoff_hz**
- :ref:`float<class_float>` **voice/4/delay_ms**
- :ref:`float<class_float>` **voice/4/depth_ms**
- :ref:`float<class_float>` **voice/4/level_db**
- :ref:`float<class_float>` **voice/4/pan**
- :ref:`float<class_float>` **voice/4/rate_hz**
- :ref:`int<class_int>` **voice_count**
- :ref:`float<class_float>` **wet**
Member Function Description
---------------------------
.. _class_AudioEffectChorus_get_dry:
- :ref:`float<class_float>` **get_dry** **(** **)** const
.. _class_AudioEffectChorus_get_voice_count:
- :ref:`int<class_int>` **get_voice_count** **(** **)** const
.. _class_AudioEffectChorus_get_voice_cutoff_hz:
- :ref:`float<class_float>` **get_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx **)** const
.. _class_AudioEffectChorus_get_voice_delay_ms:
- :ref:`float<class_float>` **get_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx **)** const
.. _class_AudioEffectChorus_get_voice_depth_ms:
- :ref:`float<class_float>` **get_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx **)** const
.. _class_AudioEffectChorus_get_voice_level_db:
- :ref:`float<class_float>` **get_voice_level_db** **(** :ref:`int<class_int>` voice_idx **)** const
.. _class_AudioEffectChorus_get_voice_pan:
- :ref:`float<class_float>` **get_voice_pan** **(** :ref:`int<class_int>` voice_idx **)** const
.. _class_AudioEffectChorus_get_voice_rate_hz:
- :ref:`float<class_float>` **get_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx **)** const
.. _class_AudioEffectChorus_get_wet:
- :ref:`float<class_float>` **get_wet** **(** **)** const
.. _class_AudioEffectChorus_set_dry:
- void **set_dry** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectChorus_set_voice_count:
- void **set_voice_count** **(** :ref:`int<class_int>` voices **)**
.. _class_AudioEffectChorus_set_voice_cutoff_hz:
- void **set_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)**
.. _class_AudioEffectChorus_set_voice_delay_ms:
- void **set_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)**
.. _class_AudioEffectChorus_set_voice_depth_ms:
- void **set_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)**
.. _class_AudioEffectChorus_set_voice_level_db:
- void **set_voice_level_db** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)**
.. _class_AudioEffectChorus_set_voice_pan:
- void **set_voice_pan** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)**
.. _class_AudioEffectChorus_set_voice_rate_hz:
- void **set_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)**
.. _class_AudioEffectChorus_set_wet:
- void **set_wet** **(** :ref:`float<class_float>` amount **)**

View File

@@ -0,0 +1,121 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectCompressor:
AudioEffectCompressor
=====================
**Inherits:** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_attack_us<class_AudioEffectCompressor_get_attack_us>` **(** **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_gain<class_AudioEffectCompressor_get_gain>` **(** **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_mix<class_AudioEffectCompressor_get_mix>` **(** **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_ratio<class_AudioEffectCompressor_get_ratio>` **(** **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_release_ms<class_AudioEffectCompressor_get_release_ms>` **(** **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_sidechain<class_AudioEffectCompressor_get_sidechain>` **(** **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_treshold<class_AudioEffectCompressor_get_treshold>` **(** **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_attack_us<class_AudioEffectCompressor_set_attack_us>` **(** :ref:`float<class_float>` attack_us **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gain<class_AudioEffectCompressor_set_gain>` **(** :ref:`float<class_float>` gain **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mix<class_AudioEffectCompressor_set_mix>` **(** :ref:`float<class_float>` mix **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ratio<class_AudioEffectCompressor_set_ratio>` **(** :ref:`float<class_float>` ratio **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_release_ms<class_AudioEffectCompressor_set_release_ms>` **(** :ref:`float<class_float>` release_ms **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_sidechain<class_AudioEffectCompressor_set_sidechain>` **(** :ref:`String<class_string>` sidechain **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_treshold<class_AudioEffectCompressor_set_treshold>` **(** :ref:`float<class_float>` treshold **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **attack_us**
- :ref:`float<class_float>` **gain**
- :ref:`float<class_float>` **mix**
- :ref:`float<class_float>` **ratio**
- :ref:`float<class_float>` **release_ms**
- :ref:`float<class_float>` **sidechain**
- :ref:`float<class_float>` **treshold**
Member Function Description
---------------------------
.. _class_AudioEffectCompressor_get_attack_us:
- :ref:`float<class_float>` **get_attack_us** **(** **)** const
.. _class_AudioEffectCompressor_get_gain:
- :ref:`float<class_float>` **get_gain** **(** **)** const
.. _class_AudioEffectCompressor_get_mix:
- :ref:`float<class_float>` **get_mix** **(** **)** const
.. _class_AudioEffectCompressor_get_ratio:
- :ref:`float<class_float>` **get_ratio** **(** **)** const
.. _class_AudioEffectCompressor_get_release_ms:
- :ref:`float<class_float>` **get_release_ms** **(** **)** const
.. _class_AudioEffectCompressor_get_sidechain:
- :ref:`String<class_string>` **get_sidechain** **(** **)** const
.. _class_AudioEffectCompressor_get_treshold:
- :ref:`float<class_float>` **get_treshold** **(** **)** const
.. _class_AudioEffectCompressor_set_attack_us:
- void **set_attack_us** **(** :ref:`float<class_float>` attack_us **)**
.. _class_AudioEffectCompressor_set_gain:
- void **set_gain** **(** :ref:`float<class_float>` gain **)**
.. _class_AudioEffectCompressor_set_mix:
- void **set_mix** **(** :ref:`float<class_float>` mix **)**
.. _class_AudioEffectCompressor_set_ratio:
- void **set_ratio** **(** :ref:`float<class_float>` ratio **)**
.. _class_AudioEffectCompressor_set_release_ms:
- void **set_release_ms** **(** :ref:`float<class_float>` release_ms **)**
.. _class_AudioEffectCompressor_set_sidechain:
- void **set_sidechain** **(** :ref:`String<class_string>` sidechain **)**
.. _class_AudioEffectCompressor_set_treshold:
- void **set_treshold** **(** :ref:`float<class_float>` treshold **)**

View File

@@ -0,0 +1,199 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectDelay:
AudioEffectDelay
================
**Inherits:** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_dry<class_AudioEffectDelay_get_dry>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_feedback_delay_ms<class_AudioEffectDelay_get_feedback_delay_ms>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_feedback_level_db<class_AudioEffectDelay_get_feedback_level_db>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_feedback_lowpass<class_AudioEffectDelay_get_feedback_lowpass>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tap1_delay_ms<class_AudioEffectDelay_get_tap1_delay_ms>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tap1_level_db<class_AudioEffectDelay_get_tap1_level_db>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tap1_pan<class_AudioEffectDelay_get_tap1_pan>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tap2_delay_ms<class_AudioEffectDelay_get_tap2_delay_ms>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tap2_level_db<class_AudioEffectDelay_get_tap2_level_db>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tap2_pan<class_AudioEffectDelay_get_tap2_pan>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_feedback_active<class_AudioEffectDelay_is_feedback_active>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_tap1_active<class_AudioEffectDelay_is_tap1_active>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_tap2_active<class_AudioEffectDelay_is_tap2_active>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_dry<class_AudioEffectDelay_set_dry>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_feedback_active<class_AudioEffectDelay_set_feedback_active>` **(** :ref:`bool<class_bool>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_feedback_delay_ms<class_AudioEffectDelay_set_feedback_delay_ms>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_feedback_level_db<class_AudioEffectDelay_set_feedback_level_db>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_feedback_lowpass<class_AudioEffectDelay_set_feedback_lowpass>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tap1_active<class_AudioEffectDelay_set_tap1_active>` **(** :ref:`bool<class_bool>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tap1_delay_ms<class_AudioEffectDelay_set_tap1_delay_ms>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tap1_level_db<class_AudioEffectDelay_set_tap1_level_db>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tap1_pan<class_AudioEffectDelay_set_tap1_pan>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tap2_active<class_AudioEffectDelay_set_tap2_active>` **(** :ref:`bool<class_bool>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tap2_delay_ms<class_AudioEffectDelay_set_tap2_delay_ms>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tap2_level_db<class_AudioEffectDelay_set_tap2_level_db>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tap2_pan<class_AudioEffectDelay_set_tap2_pan>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **dry**
- :ref:`bool<class_bool>` **feedback/active**
- :ref:`float<class_float>` **feedback/delay_ms**
- :ref:`float<class_float>` **feedback/level_db**
- :ref:`float<class_float>` **feedback/lowpass**
- :ref:`bool<class_bool>` **tap1/active**
- :ref:`float<class_float>` **tap1/delay_ms**
- :ref:`float<class_float>` **tap1/level_db**
- :ref:`float<class_float>` **tap1/pan**
- :ref:`bool<class_bool>` **tap2/active**
- :ref:`float<class_float>` **tap2/delay_ms**
- :ref:`float<class_float>` **tap2/level_db**
- :ref:`float<class_float>` **tap2/pan**
Member Function Description
---------------------------
.. _class_AudioEffectDelay_get_dry:
- :ref:`float<class_float>` **get_dry** **(** **)**
.. _class_AudioEffectDelay_get_feedback_delay_ms:
- :ref:`float<class_float>` **get_feedback_delay_ms** **(** **)** const
.. _class_AudioEffectDelay_get_feedback_level_db:
- :ref:`float<class_float>` **get_feedback_level_db** **(** **)** const
.. _class_AudioEffectDelay_get_feedback_lowpass:
- :ref:`float<class_float>` **get_feedback_lowpass** **(** **)** const
.. _class_AudioEffectDelay_get_tap1_delay_ms:
- :ref:`float<class_float>` **get_tap1_delay_ms** **(** **)** const
.. _class_AudioEffectDelay_get_tap1_level_db:
- :ref:`float<class_float>` **get_tap1_level_db** **(** **)** const
.. _class_AudioEffectDelay_get_tap1_pan:
- :ref:`float<class_float>` **get_tap1_pan** **(** **)** const
.. _class_AudioEffectDelay_get_tap2_delay_ms:
- :ref:`float<class_float>` **get_tap2_delay_ms** **(** **)** const
.. _class_AudioEffectDelay_get_tap2_level_db:
- :ref:`float<class_float>` **get_tap2_level_db** **(** **)** const
.. _class_AudioEffectDelay_get_tap2_pan:
- :ref:`float<class_float>` **get_tap2_pan** **(** **)** const
.. _class_AudioEffectDelay_is_feedback_active:
- :ref:`bool<class_bool>` **is_feedback_active** **(** **)** const
.. _class_AudioEffectDelay_is_tap1_active:
- :ref:`bool<class_bool>` **is_tap1_active** **(** **)** const
.. _class_AudioEffectDelay_is_tap2_active:
- :ref:`bool<class_bool>` **is_tap2_active** **(** **)** const
.. _class_AudioEffectDelay_set_dry:
- void **set_dry** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectDelay_set_feedback_active:
- void **set_feedback_active** **(** :ref:`bool<class_bool>` amount **)**
.. _class_AudioEffectDelay_set_feedback_delay_ms:
- void **set_feedback_delay_ms** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectDelay_set_feedback_level_db:
- void **set_feedback_level_db** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectDelay_set_feedback_lowpass:
- void **set_feedback_lowpass** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectDelay_set_tap1_active:
- void **set_tap1_active** **(** :ref:`bool<class_bool>` amount **)**
.. _class_AudioEffectDelay_set_tap1_delay_ms:
- void **set_tap1_delay_ms** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectDelay_set_tap1_level_db:
- void **set_tap1_level_db** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectDelay_set_tap1_pan:
- void **set_tap1_pan** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectDelay_set_tap2_active:
- void **set_tap2_active** **(** :ref:`bool<class_bool>` amount **)**
.. _class_AudioEffectDelay_set_tap2_delay_ms:
- void **set_tap2_delay_ms** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectDelay_set_tap2_level_db:
- void **set_tap2_level_db** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectDelay_set_tap2_pan:
- void **set_tap2_pan** **(** :ref:`float<class_float>` amount **)**

View File

@@ -0,0 +1,95 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectDistortion:
AudioEffectDistortion
=====================
**Inherits:** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_drive<class_AudioEffectDistortion_get_drive>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_keep_hf_hz<class_AudioEffectDistortion_get_keep_hf_hz>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mode<class_AudioEffectDistortion_get_mode>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_post_gain<class_AudioEffectDistortion_get_post_gain>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pre_gain<class_AudioEffectDistortion_get_pre_gain>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_drive<class_AudioEffectDistortion_set_drive>` **(** :ref:`float<class_float>` drive **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_keep_hf_hz<class_AudioEffectDistortion_set_keep_hf_hz>` **(** :ref:`float<class_float>` keep_hf_hz **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mode<class_AudioEffectDistortion_set_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_post_gain<class_AudioEffectDistortion_set_post_gain>` **(** :ref:`float<class_float>` post_gain **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pre_gain<class_AudioEffectDistortion_set_pre_gain>` **(** :ref:`float<class_float>` pre_gain **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **drive**
- :ref:`float<class_float>` **keep_hf_hz**
- :ref:`int<class_int>` **mode**
- :ref:`float<class_float>` **post_gain**
- :ref:`float<class_float>` **pre_gain**
Member Function Description
---------------------------
.. _class_AudioEffectDistortion_get_drive:
- :ref:`float<class_float>` **get_drive** **(** **)** const
.. _class_AudioEffectDistortion_get_keep_hf_hz:
- :ref:`float<class_float>` **get_keep_hf_hz** **(** **)** const
.. _class_AudioEffectDistortion_get_mode:
- :ref:`int<class_int>` **get_mode** **(** **)** const
.. _class_AudioEffectDistortion_get_post_gain:
- :ref:`float<class_float>` **get_post_gain** **(** **)** const
.. _class_AudioEffectDistortion_get_pre_gain:
- :ref:`float<class_float>` **get_pre_gain** **(** **)** const
.. _class_AudioEffectDistortion_set_drive:
- void **set_drive** **(** :ref:`float<class_float>` drive **)**
.. _class_AudioEffectDistortion_set_keep_hf_hz:
- void **set_keep_hf_hz** **(** :ref:`float<class_float>` keep_hf_hz **)**
.. _class_AudioEffectDistortion_set_mode:
- void **set_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_AudioEffectDistortion_set_post_gain:
- void **set_post_gain** **(** :ref:`float<class_float>` post_gain **)**
.. _class_AudioEffectDistortion_set_pre_gain:
- void **set_pre_gain** **(** :ref:`float<class_float>` pre_gain **)**

View File

@@ -0,0 +1,46 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectEQ:
AudioEffectEQ
=============
**Inherits:** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Inherited By:** :ref:`AudioEffectEQ6<class_audioeffecteq6>`, :ref:`AudioEffectEQ21<class_audioeffecteq21>`, :ref:`AudioEffectEQ10<class_audioeffecteq10>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_band_count<class_AudioEffectEQ_get_band_count>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_band_gain_db<class_AudioEffectEQ_get_band_gain_db>` **(** :ref:`int<class_int>` band_idx **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_band_gain_db<class_AudioEffectEQ_set_band_gain_db>` **(** :ref:`int<class_int>` band_idx, :ref:`float<class_float>` volume_db **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_AudioEffectEQ_get_band_count:
- :ref:`int<class_int>` **get_band_count** **(** **)** const
.. _class_AudioEffectEQ_get_band_gain_db:
- :ref:`float<class_float>` **get_band_gain_db** **(** :ref:`int<class_int>` band_idx **)** const
.. _class_AudioEffectEQ_set_band_gain_db:
- void **set_band_gain_db** **(** :ref:`int<class_int>` band_idx, :ref:`float<class_float>` volume_db **)**

View File

@@ -0,0 +1,17 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectEQ10:
AudioEffectEQ10
===============
**Inherits:** :ref:`AudioEffectEQ<class_audioeffecteq>` **<** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------

View File

@@ -0,0 +1,17 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectEQ21:
AudioEffectEQ21
===============
**Inherits:** :ref:`AudioEffectEQ<class_audioeffecteq>` **<** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------

View File

@@ -0,0 +1,17 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectEQ6:
AudioEffectEQ6
==============
**Inherits:** :ref:`AudioEffectEQ<class_audioeffecteq>` **<** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------

View File

@@ -0,0 +1,84 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectFilter:
AudioEffectFilter
=================
**Inherits:** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Inherited By:** :ref:`AudioEffectHighPassFilter<class_audioeffecthighpassfilter>`, :ref:`AudioEffectBandLimitFilter<class_audioeffectbandlimitfilter>`, :ref:`AudioEffectLowShelfFilter<class_audioeffectlowshelffilter>`, :ref:`AudioEffectHighShelfFilter<class_audioeffecthighshelffilter>`, :ref:`AudioEffectBandPassFilter<class_audioeffectbandpassfilter>`, :ref:`AudioEffectNotchFilter<class_audioeffectnotchfilter>`, :ref:`AudioEffectLowPassFilter<class_audioeffectlowpassfilter>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+----------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_cutoff<class_AudioEffectFilter_get_cutoff>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_db<class_AudioEffectFilter_get_db>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_gain<class_AudioEffectFilter_get_gain>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_resonance<class_AudioEffectFilter_get_resonance>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cutoff<class_AudioEffectFilter_set_cutoff>` **(** :ref:`float<class_float>` freq **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_db<class_AudioEffectFilter_set_db>` **(** :ref:`int<class_int>` amount **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gain<class_AudioEffectFilter_set_gain>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_resonance<class_AudioEffectFilter_set_resonance>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **cutoff_hz**
- :ref:`int<class_int>` **dB**
- :ref:`float<class_float>` **gain**
- :ref:`float<class_float>` **resonance**
Member Function Description
---------------------------
.. _class_AudioEffectFilter_get_cutoff:
- :ref:`float<class_float>` **get_cutoff** **(** **)** const
.. _class_AudioEffectFilter_get_db:
- :ref:`int<class_int>` **get_db** **(** **)** const
.. _class_AudioEffectFilter_get_gain:
- :ref:`float<class_float>` **get_gain** **(** **)** const
.. _class_AudioEffectFilter_get_resonance:
- :ref:`float<class_float>` **get_resonance** **(** **)** const
.. _class_AudioEffectFilter_set_cutoff:
- void **set_cutoff** **(** :ref:`float<class_float>` freq **)**
.. _class_AudioEffectFilter_set_db:
- void **set_db** **(** :ref:`int<class_int>` amount **)**
.. _class_AudioEffectFilter_set_gain:
- void **set_gain** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectFilter_set_resonance:
- void **set_resonance** **(** :ref:`float<class_float>` amount **)**

View File

@@ -0,0 +1,17 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectHighPassFilter:
AudioEffectHighPassFilter
=========================
**Inherits:** :ref:`AudioEffectFilter<class_audioeffectfilter>` **<** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------

View File

@@ -0,0 +1,17 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectHighShelfFilter:
AudioEffectHighShelfFilter
==========================
**Inherits:** :ref:`AudioEffectFilter<class_audioeffectfilter>` **<** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------

View File

@@ -0,0 +1,82 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectLimiter:
AudioEffectLimiter
==================
**Inherits:** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_ceiling_db<class_AudioEffectLimiter_get_ceiling_db>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_soft_clip_db<class_AudioEffectLimiter_get_soft_clip_db>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_soft_clip_ratio<class_AudioEffectLimiter_get_soft_clip_ratio>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_treshold_db<class_AudioEffectLimiter_get_treshold_db>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ceiling_db<class_AudioEffectLimiter_set_ceiling_db>` **(** :ref:`float<class_float>` ceiling **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_soft_clip_db<class_AudioEffectLimiter_set_soft_clip_db>` **(** :ref:`float<class_float>` soft_clip **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_soft_clip_ratio<class_AudioEffectLimiter_set_soft_clip_ratio>` **(** :ref:`float<class_float>` soft_clip **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_treshold_db<class_AudioEffectLimiter_set_treshold_db>` **(** :ref:`float<class_float>` treshold **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **ceiling_db**
- :ref:`float<class_float>` **soft_clip_db**
- :ref:`float<class_float>` **soft_clip_ratio**
- :ref:`float<class_float>` **treshold_db**
Member Function Description
---------------------------
.. _class_AudioEffectLimiter_get_ceiling_db:
- :ref:`float<class_float>` **get_ceiling_db** **(** **)** const
.. _class_AudioEffectLimiter_get_soft_clip_db:
- :ref:`float<class_float>` **get_soft_clip_db** **(** **)** const
.. _class_AudioEffectLimiter_get_soft_clip_ratio:
- :ref:`float<class_float>` **get_soft_clip_ratio** **(** **)** const
.. _class_AudioEffectLimiter_get_treshold_db:
- :ref:`float<class_float>` **get_treshold_db** **(** **)** const
.. _class_AudioEffectLimiter_set_ceiling_db:
- void **set_ceiling_db** **(** :ref:`float<class_float>` ceiling **)**
.. _class_AudioEffectLimiter_set_soft_clip_db:
- void **set_soft_clip_db** **(** :ref:`float<class_float>` soft_clip **)**
.. _class_AudioEffectLimiter_set_soft_clip_ratio:
- void **set_soft_clip_ratio** **(** :ref:`float<class_float>` soft_clip **)**
.. _class_AudioEffectLimiter_set_treshold_db:
- void **set_treshold_db** **(** :ref:`float<class_float>` treshold **)**

View File

@@ -0,0 +1,17 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectLowPassFilter:
AudioEffectLowPassFilter
========================
**Inherits:** :ref:`AudioEffectFilter<class_audioeffectfilter>` **<** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------

View File

@@ -0,0 +1,17 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectLowShelfFilter:
AudioEffectLowShelfFilter
=========================
**Inherits:** :ref:`AudioEffectFilter<class_audioeffectfilter>` **<** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------

View File

@@ -1,12 +1,12 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_RenderTargetTexture:
.. _class_AudioEffectNotchFilter:
RenderTargetTexture
===================
AudioEffectNotchFilter
======================
**Inherits:** :ref:`Texture<class_texture>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Inherits:** :ref:`AudioEffectFilter<class_audioeffectfilter>` **<** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core

View File

@@ -0,0 +1,43 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectPanner:
AudioEffectPanner
=================
**Inherits:** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+----------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pan<class_AudioEffectPanner_get_pan>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------+
| void | :ref:`set_pan<class_AudioEffectPanner_set_pan>` **(** :ref:`float<class_float>` cpanume **)** |
+----------------------------+-------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **pan**
Member Function Description
---------------------------
.. _class_AudioEffectPanner_get_pan:
- :ref:`float<class_float>` **get_pan** **(** **)** const
.. _class_AudioEffectPanner_set_pan:
- void **set_pan** **(** :ref:`float<class_float>` cpanume **)**

View File

@@ -0,0 +1,95 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectPhaser:
AudioEffectPhaser
=================
**Inherits:** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_depth<class_AudioEffectPhaser_get_depth>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_feedback<class_AudioEffectPhaser_get_feedback>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_range_max_hz<class_AudioEffectPhaser_get_range_max_hz>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_range_min_hz<class_AudioEffectPhaser_get_range_min_hz>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rate_hz<class_AudioEffectPhaser_get_rate_hz>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_depth<class_AudioEffectPhaser_set_depth>` **(** :ref:`float<class_float>` depth **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_feedback<class_AudioEffectPhaser_set_feedback>` **(** :ref:`float<class_float>` fbk **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_range_max_hz<class_AudioEffectPhaser_set_range_max_hz>` **(** :ref:`float<class_float>` hz **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_range_min_hz<class_AudioEffectPhaser_set_range_min_hz>` **(** :ref:`float<class_float>` hz **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rate_hz<class_AudioEffectPhaser_set_rate_hz>` **(** :ref:`float<class_float>` hz **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **depth**
- :ref:`float<class_float>` **feedback**
- :ref:`float<class_float>` **range_max_hz**
- :ref:`float<class_float>` **range_min_hz**
- :ref:`float<class_float>` **rate_hz**
Member Function Description
---------------------------
.. _class_AudioEffectPhaser_get_depth:
- :ref:`float<class_float>` **get_depth** **(** **)** const
.. _class_AudioEffectPhaser_get_feedback:
- :ref:`float<class_float>` **get_feedback** **(** **)** const
.. _class_AudioEffectPhaser_get_range_max_hz:
- :ref:`float<class_float>` **get_range_max_hz** **(** **)** const
.. _class_AudioEffectPhaser_get_range_min_hz:
- :ref:`float<class_float>` **get_range_min_hz** **(** **)** const
.. _class_AudioEffectPhaser_get_rate_hz:
- :ref:`float<class_float>` **get_rate_hz** **(** **)** const
.. _class_AudioEffectPhaser_set_depth:
- void **set_depth** **(** :ref:`float<class_float>` depth **)**
.. _class_AudioEffectPhaser_set_feedback:
- void **set_feedback** **(** :ref:`float<class_float>` fbk **)**
.. _class_AudioEffectPhaser_set_range_max_hz:
- void **set_range_max_hz** **(** :ref:`float<class_float>` hz **)**
.. _class_AudioEffectPhaser_set_range_min_hz:
- void **set_range_min_hz** **(** :ref:`float<class_float>` hz **)**
.. _class_AudioEffectPhaser_set_rate_hz:
- void **set_rate_hz** **(** :ref:`float<class_float>` hz **)**

View File

@@ -0,0 +1,43 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectPitchShift:
AudioEffectPitchShift
=====================
**Inherits:** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+----------------------------+------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pitch_scale<class_AudioEffectPitchShift_get_pitch_scale>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pitch_scale<class_AudioEffectPitchShift_set_pitch_scale>` **(** :ref:`float<class_float>` rate **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **pitch_scale**
Member Function Description
---------------------------
.. _class_AudioEffectPitchShift_get_pitch_scale:
- :ref:`float<class_float>` **get_pitch_scale** **(** **)** const
.. _class_AudioEffectPitchShift_set_pitch_scale:
- void **set_pitch_scale** **(** :ref:`float<class_float>` rate **)**

View File

@@ -0,0 +1,134 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectReverb:
AudioEffectReverb
=================
**Inherits:** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_damping<class_AudioEffectReverb_get_damping>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_dry<class_AudioEffectReverb_get_dry>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_hpf<class_AudioEffectReverb_get_hpf>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_predelay_feedback<class_AudioEffectReverb_get_predelay_feedback>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_predelay_msec<class_AudioEffectReverb_get_predelay_msec>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_room_size<class_AudioEffectReverb_get_room_size>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_spread<class_AudioEffectReverb_get_spread>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_wet<class_AudioEffectReverb_get_wet>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_damping<class_AudioEffectReverb_set_damping>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_dry<class_AudioEffectReverb_set_dry>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_hpf<class_AudioEffectReverb_set_hpf>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_predelay_feedback<class_AudioEffectReverb_set_predelay_feedback>` **(** :ref:`float<class_float>` feedback **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_predelay_msec<class_AudioEffectReverb_set_predelay_msec>` **(** :ref:`float<class_float>` msec **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_room_size<class_AudioEffectReverb_set_room_size>` **(** :ref:`float<class_float>` size **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_spread<class_AudioEffectReverb_set_spread>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_wet<class_AudioEffectReverb_set_wet>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **damping**
- :ref:`float<class_float>` **dry**
- :ref:`float<class_float>` **hipass**
- :ref:`float<class_float>` **predelay_feedback**
- :ref:`float<class_float>` **predelay_msec**
- :ref:`float<class_float>` **room_size**
- :ref:`float<class_float>` **spread**
- :ref:`float<class_float>` **wet**
Member Function Description
---------------------------
.. _class_AudioEffectReverb_get_damping:
- :ref:`float<class_float>` **get_damping** **(** **)** const
.. _class_AudioEffectReverb_get_dry:
- :ref:`float<class_float>` **get_dry** **(** **)** const
.. _class_AudioEffectReverb_get_hpf:
- :ref:`float<class_float>` **get_hpf** **(** **)** const
.. _class_AudioEffectReverb_get_predelay_feedback:
- :ref:`float<class_float>` **get_predelay_feedback** **(** **)** const
.. _class_AudioEffectReverb_get_predelay_msec:
- :ref:`float<class_float>` **get_predelay_msec** **(** **)** const
.. _class_AudioEffectReverb_get_room_size:
- :ref:`float<class_float>` **get_room_size** **(** **)** const
.. _class_AudioEffectReverb_get_spread:
- :ref:`float<class_float>` **get_spread** **(** **)** const
.. _class_AudioEffectReverb_get_wet:
- :ref:`float<class_float>` **get_wet** **(** **)** const
.. _class_AudioEffectReverb_set_damping:
- void **set_damping** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectReverb_set_dry:
- void **set_dry** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectReverb_set_hpf:
- void **set_hpf** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectReverb_set_predelay_feedback:
- void **set_predelay_feedback** **(** :ref:`float<class_float>` feedback **)**
.. _class_AudioEffectReverb_set_predelay_msec:
- void **set_predelay_msec** **(** :ref:`float<class_float>` msec **)**
.. _class_AudioEffectReverb_set_room_size:
- void **set_room_size** **(** :ref:`float<class_float>` size **)**
.. _class_AudioEffectReverb_set_spread:
- void **set_spread** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectReverb_set_wet:
- void **set_wet** **(** :ref:`float<class_float>` amount **)**

View File

@@ -0,0 +1,69 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioEffectStereoEnhance:
AudioEffectStereoEnhance
========================
**Inherits:** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pan_pullout<class_AudioEffectStereoEnhance_get_pan_pullout>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_surround<class_AudioEffectStereoEnhance_get_surround>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_time_pullout<class_AudioEffectStereoEnhance_get_time_pullout>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pan_pullout<class_AudioEffectStereoEnhance_set_pan_pullout>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_surround<class_AudioEffectStereoEnhance_set_surround>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_time_pullout<class_AudioEffectStereoEnhance_set_time_pullout>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **pan_pullout**
- :ref:`float<class_float>` **surround**
- :ref:`float<class_float>` **time_pullout_ms**
Member Function Description
---------------------------
.. _class_AudioEffectStereoEnhance_get_pan_pullout:
- :ref:`float<class_float>` **get_pan_pullout** **(** **)** const
.. _class_AudioEffectStereoEnhance_get_surround:
- :ref:`float<class_float>` **get_surround** **(** **)** const
.. _class_AudioEffectStereoEnhance_get_time_pullout:
- :ref:`float<class_float>` **get_time_pullout** **(** **)** const
.. _class_AudioEffectStereoEnhance_set_pan_pullout:
- void **set_pan_pullout** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectStereoEnhance_set_surround:
- void **set_surround** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectStereoEnhance_set_time_pullout:
- void **set_time_pullout** **(** :ref:`float<class_float>` amount **)**

View File

@@ -0,0 +1,126 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioPlayer:
AudioPlayer
===========
**Inherits:** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_bus<class_AudioPlayer_get_bus>` **(** **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mix_target<class_AudioPlayer_get_mix_target>` **(** **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pos<class_AudioPlayer_get_pos>` **(** **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_stream<class_AudioPlayer_get_stream>` **(** **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_volume_db<class_AudioPlayer_get_volume_db>` **(** **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_autoplay_enabled<class_AudioPlayer_is_autoplay_enabled>` **(** **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioPlayer_is_playing>` **(** **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`play<class_AudioPlayer_play>` **(** :ref:`float<class_float>` from_pos=0 **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`seek<class_AudioPlayer_seek>` **(** :ref:`float<class_float>` to_pos **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_autoplay<class_AudioPlayer_set_autoplay>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus<class_AudioPlayer_set_bus>` **(** :ref:`String<class_string>` bus **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mix_target<class_AudioPlayer_set_mix_target>` **(** :ref:`int<class_int>` mix_target **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_stream<class_AudioPlayer_set_stream>` **(** :ref:`AudioStream<class_audiostream>` stream **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_volume_db<class_AudioPlayer_set_volume_db>` **(** :ref:`float<class_float>` volume_db **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop<class_AudioPlayer_stop>` **(** **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`bool<class_bool>` **autoplay**
- :ref:`String<class_string>` **bus**
- :ref:`int<class_int>` **mix_target**
- :ref:`bool<class_bool>` **playing**
- :ref:`AudioStream<class_audiostream>` **stream**
- :ref:`float<class_float>` **volume_db**
Member Function Description
---------------------------
.. _class_AudioPlayer_get_bus:
- :ref:`String<class_string>` **get_bus** **(** **)** const
.. _class_AudioPlayer_get_mix_target:
- :ref:`int<class_int>` **get_mix_target** **(** **)** const
.. _class_AudioPlayer_get_pos:
- :ref:`float<class_float>` **get_pos** **(** **)**
.. _class_AudioPlayer_get_stream:
- :ref:`Object<class_object>` **get_stream** **(** **)** const
.. _class_AudioPlayer_get_volume_db:
- :ref:`float<class_float>` **get_volume_db** **(** **)** const
.. _class_AudioPlayer_is_autoplay_enabled:
- :ref:`bool<class_bool>` **is_autoplay_enabled** **(** **)**
.. _class_AudioPlayer_is_playing:
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
.. _class_AudioPlayer_play:
- void **play** **(** :ref:`float<class_float>` from_pos=0 **)**
.. _class_AudioPlayer_seek:
- void **seek** **(** :ref:`float<class_float>` to_pos **)**
.. _class_AudioPlayer_set_autoplay:
- void **set_autoplay** **(** :ref:`bool<class_bool>` enable **)**
.. _class_AudioPlayer_set_bus:
- void **set_bus** **(** :ref:`String<class_string>` bus **)**
.. _class_AudioPlayer_set_mix_target:
- void **set_mix_target** **(** :ref:`int<class_int>` mix_target **)**
.. _class_AudioPlayer_set_stream:
- void **set_stream** **(** :ref:`AudioStream<class_audiostream>` stream **)**
.. _class_AudioPlayer_set_volume_db:
- void **set_volume_db** **(** :ref:`float<class_float>` volume_db **)**
.. _class_AudioPlayer_stop:
- void **stop** **(** **)**

View File

@@ -8,8 +8,6 @@ AudioServer
**Inherits:** :ref:`Object<class_object>`
**Inherited By:** :ref:`AudioServerSW<class_audioserversw>`
**Category:** Core
Brief Description
@@ -20,119 +18,76 @@ Server interface for low level audio access.
Member Functions
----------------
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`free_rid<class_AudioServer_free_rid>` **(** :ref:`RID<class_rid>` rid **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_event_voice_global_volume_scale<class_AudioServer_get_event_voice_global_volume_scale>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_fx_global_volume_scale<class_AudioServer_get_fx_global_volume_scale>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_stream_global_volume_scale<class_AudioServer_get_stream_global_volume_scale>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`sample_create<class_AudioServer_sample_create>` **(** :ref:`int<class_int>` format, :ref:`bool<class_bool>` stereo, :ref:`int<class_int>` length **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RawArray<class_rawarray>` | :ref:`sample_get_data<class_AudioServer_sample_get_data>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`sample_get_description<class_AudioServer_sample_get_description>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`sample_get_format<class_AudioServer_sample_get_format>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`sample_get_length<class_AudioServer_sample_get_length>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`sample_get_loop_begin<class_AudioServer_sample_get_loop_begin>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`sample_get_loop_end<class_AudioServer_sample_get_loop_end>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`sample_get_loop_format<class_AudioServer_sample_get_loop_format>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`sample_get_mix_rate<class_AudioServer_sample_get_mix_rate>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`sample_is_stereo<class_AudioServer_sample_is_stereo>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sample_set_data<class_AudioServer_sample_set_data>` **(** :ref:`RID<class_rid>` sample, :ref:`RawArray<class_rawarray>` data **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sample_set_description<class_AudioServer_sample_set_description>` **(** :ref:`RID<class_rid>` sample, :ref:`String<class_string>` description **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sample_set_loop_begin<class_AudioServer_sample_set_loop_begin>` **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` pos **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sample_set_loop_end<class_AudioServer_sample_set_loop_end>` **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` pos **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sample_set_loop_format<class_AudioServer_sample_set_loop_format>` **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` loop_format **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sample_set_mix_rate<class_AudioServer_sample_set_mix_rate>` **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` mix_rate **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sample_set_signed_data<class_AudioServer_sample_set_signed_data>` **(** :ref:`RID<class_rid>` sample, :ref:`RealArray<class_realarray>` data **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_event_voice_global_volume_scale<class_AudioServer_set_event_voice_global_volume_scale>` **(** :ref:`float<class_float>` scale **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_fx_global_volume_scale<class_AudioServer_set_fx_global_volume_scale>` **(** :ref:`float<class_float>` scale **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_stream_global_volume_scale<class_AudioServer_set_stream_global_volume_scale>` **(** :ref:`float<class_float>` scale **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`voice_create<class_AudioServer_voice_create>` **(** **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_chorus<class_AudioServer_voice_get_chorus>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_filter_cutoff<class_AudioServer_voice_get_filter_cutoff>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_filter_resonance<class_AudioServer_voice_get_filter_resonance>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`voice_get_filter_type<class_AudioServer_voice_get_filter_type>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`voice_get_mix_rate<class_AudioServer_voice_get_mix_rate>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_pan<class_AudioServer_voice_get_pan>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_pan_depth<class_AudioServer_voice_get_pan_depth>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_pan_height<class_AudioServer_voice_get_pan_height>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_reverb<class_AudioServer_voice_get_reverb>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`voice_get_reverb_type<class_AudioServer_voice_get_reverb_type>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_volume<class_AudioServer_voice_get_volume>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`voice_is_positional<class_AudioServer_voice_is_positional>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_play<class_AudioServer_voice_play>` **(** :ref:`RID<class_rid>` voice, :ref:`RID<class_rid>` sample **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_chorus<class_AudioServer_voice_set_chorus>` **(** :ref:`RID<class_rid>` voice, :ref:`float<class_float>` chorus **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_filter<class_AudioServer_voice_set_filter>` **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` type, :ref:`float<class_float>` cutoff, :ref:`float<class_float>` resonance, :ref:`float<class_float>` gain=0 **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_mix_rate<class_AudioServer_voice_set_mix_rate>` **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` rate **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_pan<class_AudioServer_voice_set_pan>` **(** :ref:`RID<class_rid>` voice, :ref:`float<class_float>` pan, :ref:`float<class_float>` depth=0, :ref:`float<class_float>` height=0 **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_positional<class_AudioServer_voice_set_positional>` **(** :ref:`RID<class_rid>` voice, :ref:`bool<class_bool>` enabled **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_reverb<class_AudioServer_voice_set_reverb>` **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` room, :ref:`float<class_float>` reverb **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_volume<class_AudioServer_voice_set_volume>` **(** :ref:`RID<class_rid>` voice, :ref:`float<class_float>` volume **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_stop<class_AudioServer_voice_stop>` **(** :ref:`RID<class_rid>` voice **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_bus<class_AudioServer_add_bus>` **(** :ref:`int<class_int>` at_pos=-1 **)** |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_bus_effect<class_AudioServer_add_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`AudioEffect<class_audioeffect>` effect, :ref:`int<class_int>` arg2=-1 **)** |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AudioBusLayout<class_audiobuslayout>` | :ref:`generate_bus_layout<class_AudioServer_generate_bus_layout>` **(** **)** const |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bus_count<class_AudioServer_get_bus_count>` **(** **)** const |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AudioEffect<class_audioeffect>` | :ref:`get_bus_effect<class_AudioServer_get_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`get_bus_effect_count<class_AudioServer_get_bus_effect_count>` **(** :ref:`int<class_int>` bus_idx, :ref:`Object<class_object>` arg1, :ref:`int<class_int>` arg2 **)** |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_bus_name<class_AudioServer_get_bus_name>` **(** :ref:`int<class_int>` bus_idx **)** const |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bus_peak_volume_left_db<class_AudioServer_get_bus_peak_volume_left_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bus_peak_volume_right_db<class_AudioServer_get_bus_peak_volume_right_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_bus_send<class_AudioServer_get_bus_send>` **(** :ref:`int<class_int>` bus_idx **)** const |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bus_volume_db<class_AudioServer_get_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx **)** const |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_mix_rate<class_AudioServer_get_mix_rate>` **(** **)** const |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_speaker_mode<class_AudioServer_get_speaker_mode>` **(** **)** const |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_bus_bypassing_effects<class_AudioServer_is_bus_bypassing_effects>` **(** :ref:`int<class_int>` bus_idx **)** const |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_bus_effect_enabled<class_AudioServer_is_bus_effect_enabled>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** const |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_bus_mute<class_AudioServer_is_bus_mute>` **(** :ref:`int<class_int>` bus_idx **)** const |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_bus_solo<class_AudioServer_is_bus_solo>` **(** :ref:`int<class_int>` bus_idx **)** const |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`lock<class_AudioServer_lock>` **(** **)** |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`move_bus<class_AudioServer_move_bus>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` to_index **)** |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_bus<class_AudioServer_remove_bus>` **(** :ref:`int<class_int>` index **)** |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_bus_effect<class_AudioServer_remove_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_bypass_effects<class_AudioServer_set_bus_bypass_effects>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_count<class_AudioServer_set_bus_count>` **(** :ref:`int<class_int>` amount **)** |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_effect_enabled<class_AudioServer_set_bus_effect_enabled>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_layout<class_AudioServer_set_bus_layout>` **(** :ref:`AudioBusLayout<class_audiobuslayout>` bus_layout **)** |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_mute<class_AudioServer_set_bus_mute>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_name<class_AudioServer_set_bus_name>` **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_string>` name **)** |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_send<class_AudioServer_set_bus_send>` **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_string>` send **)** |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_solo<class_AudioServer_set_bus_solo>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_volume_db<class_AudioServer_set_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`float<class_float>` volume_db **)** |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`swap_bus_effects<class_AudioServer_swap_bus_effects>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` by_effect_idx **)** |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unlock<class_AudioServer_unlock>` **(** **)** |
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
Signals
-------
- **SAMPLE_FORMAT_PCM8** = **0** --- Sample format is 8 bits, signed.
- **SAMPLE_FORMAT_PCM16** = **1** --- Sample format is 16 bits, little-endian, signed.
- **SAMPLE_FORMAT_IMA_ADPCM** = **2** --- Sample format is IMA-ADPCM compressed.
- **SAMPLE_LOOP_NONE** = **0** --- Sample does not loop.
- **SAMPLE_LOOP_FORWARD** = **1** --- Sample loops in forward mode.
- **SAMPLE_LOOP_PING_PONG** = **2** --- Sample loops in a bidirectional way.
- **FILTER_NONE** = **0** --- Filter is disabled.
- **FILTER_LOWPASS** = **1** --- Filter is a resonant lowpass.
- **FILTER_BANDPASS** = **2** --- Filter is a resonant bandpass.
- **FILTER_HIPASS** = **3** --- Filter is a resonant highpass.
- **FILTER_NOTCH** = **4** --- Filter is a notch (band reject).
- **FILTER_BANDLIMIT** = **6** --- Filter is a bandlimit (resonance used as highpass).
- **REVERB_SMALL** = **0** --- Small reverb room (closet, bathroom, etc).
- **REVERB_MEDIUM** = **1** --- Medium reverb room (living room)
- **REVERB_LARGE** = **2** --- Large reverb room (warehouse).
- **REVERB_HALL** = **3** --- Large reverb room with long decay.
- **bus_layout_changed** **(** **)**
Description
-----------
@@ -142,294 +97,132 @@ AudioServer is a low level server interface for audio access. It is in charge of
Member Function Description
---------------------------
.. _class_AudioServer_free_rid:
.. _class_AudioServer_add_bus:
- void **free_rid** **(** :ref:`RID<class_rid>` rid **)**
- void **add_bus** **(** :ref:`int<class_int>` at_pos=-1 **)**
Free a :ref:`RID<class_rid>` resource.
.. _class_AudioServer_add_bus_effect:
.. _class_AudioServer_get_event_voice_global_volume_scale:
- void **add_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`AudioEffect<class_audioeffect>` effect, :ref:`int<class_int>` arg2=-1 **)**
- :ref:`float<class_float>` **get_event_voice_global_volume_scale** **(** **)** const
.. _class_AudioServer_generate_bus_layout:
Return the global scale for event-based stream playback.
- :ref:`AudioBusLayout<class_audiobuslayout>` **generate_bus_layout** **(** **)** const
.. _class_AudioServer_get_fx_global_volume_scale:
.. _class_AudioServer_get_bus_count:
- :ref:`float<class_float>` **get_fx_global_volume_scale** **(** **)** const
- :ref:`int<class_int>` **get_bus_count** **(** **)** const
Return the global scale for all voices.
.. _class_AudioServer_get_bus_effect:
.. _class_AudioServer_get_stream_global_volume_scale:
- :ref:`AudioEffect<class_audioeffect>` **get_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)**
- :ref:`float<class_float>` **get_stream_global_volume_scale** **(** **)** const
.. _class_AudioServer_get_bus_effect_count:
Return the global scale for stream playback.
- void **get_bus_effect_count** **(** :ref:`int<class_int>` bus_idx, :ref:`Object<class_object>` arg1, :ref:`int<class_int>` arg2 **)**
.. _class_AudioServer_sample_create:
.. _class_AudioServer_get_bus_name:
- :ref:`RID<class_rid>` **sample_create** **(** :ref:`int<class_int>` format, :ref:`bool<class_bool>` stereo, :ref:`int<class_int>` length **)**
- :ref:`String<class_string>` **get_bus_name** **(** :ref:`int<class_int>` bus_idx **)** const
Create an audio sample, return a :ref:`RID<class_rid>` referencing it. The sample will be created with a given format (from the SAMPLE_FORMAT\_\* enum), a total length (in samples, not bytes), in either stereo or mono.
.. _class_AudioServer_get_bus_peak_volume_left_db:
Even if a stereo sample consists of a left sample and a right sample, it still counts as one sample for length purposes.
- :ref:`float<class_float>` **get_bus_peak_volume_left_db** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const
.. _class_AudioServer_sample_get_data:
.. _class_AudioServer_get_bus_peak_volume_right_db:
- :ref:`RawArray<class_rawarray>` **sample_get_data** **(** :ref:`RID<class_rid>` sample **)** const
- :ref:`float<class_float>` **get_bus_peak_volume_right_db** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const
Return the sample data as an array of bytes. The length will be the expected length in bytes.
.. _class_AudioServer_get_bus_send:
.. _class_AudioServer_sample_get_description:
- :ref:`String<class_string>` **get_bus_send** **(** :ref:`int<class_int>` bus_idx **)** const
- :ref:`String<class_string>` **sample_get_description** **(** :ref:`RID<class_rid>` sample **)** const
.. _class_AudioServer_get_bus_volume_db:
Return the description of an audio sample. Mainly used for organization.
- :ref:`float<class_float>` **get_bus_volume_db** **(** :ref:`int<class_int>` bus_idx **)** const
.. _class_AudioServer_sample_get_format:
.. _class_AudioServer_get_mix_rate:
- :ref:`int<class_int>` **sample_get_format** **(** :ref:`RID<class_rid>` sample **)** const
- :ref:`float<class_float>` **get_mix_rate** **(** **)** const
Return the format of the audio sample, in the form of the SAMPLE_FORMAT\_\* enum.
.. _class_AudioServer_get_speaker_mode:
.. _class_AudioServer_sample_get_length:
- :ref:`int<class_int>` **get_speaker_mode** **(** **)** const
- :ref:`int<class_int>` **sample_get_length** **(** :ref:`RID<class_rid>` sample **)** const
.. _class_AudioServer_is_bus_bypassing_effects:
Return the length in samples (not bytes) of the audio sample. Even if a stereo sample consists of a left sample and a right sample, it still counts as one sample for length purposes.
- :ref:`bool<class_bool>` **is_bus_bypassing_effects** **(** :ref:`int<class_int>` bus_idx **)** const
.. _class_AudioServer_sample_get_loop_begin:
.. _class_AudioServer_is_bus_effect_enabled:
- :ref:`int<class_int>` **sample_get_loop_begin** **(** :ref:`RID<class_rid>` sample **)** const
- :ref:`bool<class_bool>` **is_bus_effect_enabled** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** const
Return the initial loop point of a sample. Only has effect if sample loop is enabled. See :ref:`sample_set_loop_format<class_AudioServer_sample_set_loop_format>`.
.. _class_AudioServer_is_bus_mute:
.. _class_AudioServer_sample_get_loop_end:
- :ref:`bool<class_bool>` **is_bus_mute** **(** :ref:`int<class_int>` bus_idx **)** const
- :ref:`int<class_int>` **sample_get_loop_end** **(** :ref:`RID<class_rid>` sample **)** const
.. _class_AudioServer_is_bus_solo:
Return the final loop point of a sample. Only has effect if sample loop is enabled. See :ref:`sample_set_loop_format<class_AudioServer_sample_set_loop_format>`.
- :ref:`bool<class_bool>` **is_bus_solo** **(** :ref:`int<class_int>` bus_idx **)** const
.. _class_AudioServer_sample_get_loop_format:
.. _class_AudioServer_lock:
- :ref:`int<class_int>` **sample_get_loop_format** **(** :ref:`RID<class_rid>` sample **)** const
- void **lock** **(** **)**
Return the loop format for a sample, as a value from the SAMPLE_LOOP\_\* enum.
.. _class_AudioServer_move_bus:
.. _class_AudioServer_sample_get_mix_rate:
- void **move_bus** **(** :ref:`int<class_int>` index, :ref:`int<class_int>` to_index **)**
- :ref:`int<class_int>` **sample_get_mix_rate** **(** :ref:`RID<class_rid>` sample **)** const
.. _class_AudioServer_remove_bus:
Return the mix rate of the given sample.
- void **remove_bus** **(** :ref:`int<class_int>` index **)**
.. _class_AudioServer_sample_is_stereo:
.. _class_AudioServer_remove_bus_effect:
- :ref:`bool<class_bool>` **sample_is_stereo** **(** :ref:`RID<class_rid>` sample **)** const
- void **remove_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)**
Return whether the sample is stereo (2 channels).
.. _class_AudioServer_set_bus_bypass_effects:
.. _class_AudioServer_sample_set_data:
- void **set_bus_bypass_effects** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)**
- void **sample_set_data** **(** :ref:`RID<class_rid>` sample, :ref:`RawArray<class_rawarray>` data **)**
.. _class_AudioServer_set_bus_count:
Set the sample data for a given sample as an array of bytes. The length must be equal to the sample length expected in bytes or an error will be produced. The byte length can be calculated as follows:
- void **set_bus_count** **(** :ref:`int<class_int>` amount **)**
Get the sample length (:ref:`sample_get_length<class_AudioServer_sample_get_length>`).
.. _class_AudioServer_set_bus_effect_enabled:
If the sample format is SAMPLE_FORMAT_PCM16, multiply it by 2.
- void **set_bus_effect_enabled** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`bool<class_bool>` enabled **)**
If the sample format is SAMPLE_FORMAT_IMA_ADPCM, divide it by 2 (rounding any fraction up), then add 4.
.. _class_AudioServer_set_bus_layout:
If the sample is stereo (:ref:`sample_is_stereo<class_AudioServer_sample_is_stereo>`), multiply it by 2.
- void **set_bus_layout** **(** :ref:`AudioBusLayout<class_audiobuslayout>` bus_layout **)**
.. _class_AudioServer_sample_set_description:
.. _class_AudioServer_set_bus_mute:
- void **sample_set_description** **(** :ref:`RID<class_rid>` sample, :ref:`String<class_string>` description **)**
- void **set_bus_mute** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)**
Set the description of an audio sample. Mainly used for organization.
.. _class_AudioServer_set_bus_name:
.. _class_AudioServer_sample_set_loop_begin:
- void **set_bus_name** **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_string>` name **)**
- void **sample_set_loop_begin** **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` pos **)**
.. _class_AudioServer_set_bus_send:
Set the initial loop point of a sample. Only has effect if sample loop is enabled. See :ref:`sample_set_loop_format<class_AudioServer_sample_set_loop_format>`.
- void **set_bus_send** **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_string>` send **)**
.. _class_AudioServer_sample_set_loop_end:
.. _class_AudioServer_set_bus_solo:
- void **sample_set_loop_end** **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` pos **)**
- void **set_bus_solo** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)**
Set the final loop point of a sample. Only has effect if sample loop is enabled. See :ref:`sample_set_loop_format<class_AudioServer_sample_set_loop_format>`.
.. _class_AudioServer_set_bus_volume_db:
.. _class_AudioServer_sample_set_loop_format:
- void **set_bus_volume_db** **(** :ref:`int<class_int>` bus_idx, :ref:`float<class_float>` volume_db **)**
- void **sample_set_loop_format** **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` loop_format **)**
.. _class_AudioServer_swap_bus_effects:
Set the loop format for a sample from the SAMPLE_LOOP\_\* enum. As a warning, Ping Pong loops may not be available on some hardware-mixing platforms.
- void **swap_bus_effects** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` by_effect_idx **)**
.. _class_AudioServer_sample_set_mix_rate:
.. _class_AudioServer_unlock:
- void **sample_set_mix_rate** **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` mix_rate **)**
Change the default mix rate of a given sample.
.. _class_AudioServer_sample_set_signed_data:
- void **sample_set_signed_data** **(** :ref:`RID<class_rid>` sample, :ref:`RealArray<class_realarray>` data **)**
Set the sample data for a given sample as an array of floats. The length must be equal to the sample length or an error will be produced.
For this method, a stereo sample is made from two samples. Thus, in case of a stereo sample, the array length must be twice the length returned by :ref:`sample_get_length<class_AudioServer_sample_get_length>`.
Trying to alter a SAMPLE_FORMAT_IMA_ADPCM sample is not supported. It will throw an error to the console, but will not alter the sample data.
.. _class_AudioServer_set_event_voice_global_volume_scale:
- void **set_event_voice_global_volume_scale** **(** :ref:`float<class_float>` scale **)**
Set global scale for event-based stream (:ref:`EventStream<class_eventstream>`) playback. Default is 1.0.
.. _class_AudioServer_set_fx_global_volume_scale:
- void **set_fx_global_volume_scale** **(** :ref:`float<class_float>` scale **)**
Set global scale for all voices (not including streams). Default is 1.0.
.. _class_AudioServer_set_stream_global_volume_scale:
- void **set_stream_global_volume_scale** **(** :ref:`float<class_float>` scale **)**
Set global scale for stream playback. Default is 1.0.
.. _class_AudioServer_voice_create:
- :ref:`RID<class_rid>` **voice_create** **(** **)**
Allocate a voice for playback. Voices are persistent. A voice can play a single sample at the same time. See :ref:`sample_create<class_AudioServer_sample_create>`.
.. _class_AudioServer_voice_get_chorus:
- :ref:`float<class_float>` **voice_get_chorus** **(** :ref:`RID<class_rid>` voice **)** const
Return the current chorus send for a given voice (0 to 1).
.. _class_AudioServer_voice_get_filter_cutoff:
- :ref:`float<class_float>` **voice_get_filter_cutoff** **(** :ref:`RID<class_rid>` voice **)** const
Return the current filter cutoff (in hz) for a given voice.
.. _class_AudioServer_voice_get_filter_resonance:
- :ref:`float<class_float>` **voice_get_filter_resonance** **(** :ref:`RID<class_rid>` voice **)** const
Return the current filter resonance for a given voice.
.. _class_AudioServer_voice_get_filter_type:
- :ref:`int<class_int>` **voice_get_filter_type** **(** :ref:`RID<class_rid>` voice **)** const
Return the current selected filter type for a given voice, from the FILTER\_\* enum.
.. _class_AudioServer_voice_get_mix_rate:
- :ref:`int<class_int>` **voice_get_mix_rate** **(** :ref:`RID<class_rid>` voice **)** const
Return the current mix rate for a given voice.
.. _class_AudioServer_voice_get_pan:
- :ref:`float<class_float>` **voice_get_pan** **(** :ref:`RID<class_rid>` voice **)** const
Return the current pan for a given voice (-1 to +1 range).
.. _class_AudioServer_voice_get_pan_depth:
- :ref:`float<class_float>` **voice_get_pan_depth** **(** :ref:`RID<class_rid>` voice **)** const
Return the current pan depth for a given voice (-1 to +1 range).
.. _class_AudioServer_voice_get_pan_height:
- :ref:`float<class_float>` **voice_get_pan_height** **(** :ref:`RID<class_rid>` voice **)** const
Return the current pan height for a given voice (-1 to +1 range).
.. _class_AudioServer_voice_get_reverb:
- :ref:`float<class_float>` **voice_get_reverb** **(** :ref:`RID<class_rid>` voice **)** const
Return the current reverb send for a given voice (0 to 1).
.. _class_AudioServer_voice_get_reverb_type:
- :ref:`int<class_int>` **voice_get_reverb_type** **(** :ref:`RID<class_rid>` voice **)** const
Return the current reverb type for a given voice from the REVERB\_\* enum.
.. _class_AudioServer_voice_get_volume:
- :ref:`float<class_float>` **voice_get_volume** **(** :ref:`RID<class_rid>` voice **)** const
Return the current volume for a given voice.
.. _class_AudioServer_voice_is_positional:
- :ref:`bool<class_bool>` **voice_is_positional** **(** :ref:`RID<class_rid>` voice **)** const
Return whether the current voice is positional. See :ref:`voice_set_positional<class_AudioServer_voice_set_positional>`.
.. _class_AudioServer_voice_play:
- void **voice_play** **(** :ref:`RID<class_rid>` voice, :ref:`RID<class_rid>` sample **)**
Start playback of a given voice using a given sample. If the voice was already playing it will be restarted.
.. _class_AudioServer_voice_set_chorus:
- void **voice_set_chorus** **(** :ref:`RID<class_rid>` voice, :ref:`float<class_float>` chorus **)**
Set chorus send post processing for the voice (from 0 to 1).
.. _class_AudioServer_voice_set_filter:
- void **voice_set_filter** **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` type, :ref:`float<class_float>` cutoff, :ref:`float<class_float>` resonance, :ref:`float<class_float>` gain=0 **)**
Set a resonant filter post processing for the voice. Filter type is a value from the FILTER\_\* enum.
.. _class_AudioServer_voice_set_mix_rate:
- void **voice_set_mix_rate** **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` rate **)**
Set a different playback mix rate for the given voice.
.. _class_AudioServer_voice_set_pan:
- void **voice_set_pan** **(** :ref:`RID<class_rid>` voice, :ref:`float<class_float>` pan, :ref:`float<class_float>` depth=0, :ref:`float<class_float>` height=0 **)**
Change the pan of a currently playing voice and, optionally, the depth and height for a positional/3D sound. Panning values are expressed within the -1 to +1 range.
.. _class_AudioServer_voice_set_positional:
- void **voice_set_positional** **(** :ref:`RID<class_rid>` voice, :ref:`bool<class_bool>` enabled **)**
Set whether a given voice is positional. This is only interpreted as a hint and used for backends that may support binaural encoding.
.. _class_AudioServer_voice_set_reverb:
- void **voice_set_reverb** **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` room, :ref:`float<class_float>` reverb **)**
Set the reverb send post processing for the voice (from 0 to 1) and the reverb type, from the REVERB\_\* enum.
.. _class_AudioServer_voice_set_volume:
- void **voice_set_volume** **(** :ref:`RID<class_rid>` voice, :ref:`float<class_float>` volume **)**
Change the volume of a currently playing voice. Volume is expressed as linear gain where 0.0 is mute and 1.0 is default.
.. _class_AudioServer_voice_stop:
- void **voice_stop** **(** :ref:`RID<class_rid>` voice **)**
Stop a given voice.
- void **unlock** **(** **)**

View File

@@ -1,24 +0,0 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioServerSW:
AudioServerSW
=============
**Inherits:** :ref:`AudioServer<class_audioserver>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Software implementation of :ref:`AudioServer<class_audioserver>`.
Description
-----------
This is a software audio server. It does not use any kind of hardware acceleration.
This class does not expose any new method.

View File

@@ -8,7 +8,7 @@ AudioStream
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Inherited By:** :ref:`AudioStreamMPC<class_audiostreammpc>`, :ref:`AudioStreamOGGVorbis<class_audiostreamoggvorbis>`, :ref:`AudioStreamOpus<class_audiostreamopus>`
**Inherited By:** :ref:`AudioStreamSample<class_audiostreamsample>`, :ref:`AudioStreamOGGVorbis<class_audiostreamoggvorbis>`
**Category:** Core

View File

@@ -1,22 +0,0 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioStreamMPC:
AudioStreamMPC
==============
**Inherits:** :ref:`AudioStream<class_audiostream>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
MusePack audio stream driver.
Description
-----------
MusePack audio stream driver.

View File

@@ -15,8 +15,47 @@ Brief Description
OGG Vorbis audio stream driver.
Member Functions
----------------
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`get_data<class_AudioStreamOGGVorbis_get_data>` **(** **)** const |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_loop<class_AudioStreamOGGVorbis_has_loop>` **(** **)** const |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_data<class_AudioStreamOGGVorbis_set_data>` **(** :ref:`PoolByteArray<class_poolbytearray>` data **)** |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop<class_AudioStreamOGGVorbis_set_loop>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`PoolByteArray<class_poolbytearray>` **data**
- :ref:`bool<class_bool>` **loop**
Description
-----------
OGG Vorbis audio stream driver.
Member Function Description
---------------------------
.. _class_AudioStreamOGGVorbis_get_data:
- :ref:`PoolByteArray<class_poolbytearray>` **get_data** **(** **)** const
.. _class_AudioStreamOGGVorbis_has_loop:
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
.. _class_AudioStreamOGGVorbis_set_data:
- void **set_data** **(** :ref:`PoolByteArray<class_poolbytearray>` data **)**
.. _class_AudioStreamOGGVorbis_set_loop:
- void **set_loop** **(** :ref:`bool<class_bool>` enable **)**

View File

@@ -1,22 +0,0 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioStreamOpus:
AudioStreamOpus
===============
**Inherits:** :ref:`AudioStream<class_audiostream>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Opus Codec audio stream driver.
Description
-----------
Opus Codec audio stream driver.

View File

@@ -15,84 +15,3 @@ Brief Description
Member Functions
----------------
+----------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_channels<class_AudioStreamPlayback_get_channels>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_length<class_AudioStreamPlayback_get_length>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_loop_count<class_AudioStreamPlayback_get_loop_count>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_minimum_buffer_size<class_AudioStreamPlayback_get_minimum_buffer_size>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mix_rate<class_AudioStreamPlayback_get_mix_rate>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pos<class_AudioStreamPlayback_get_pos>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_loop<class_AudioStreamPlayback_has_loop>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayback_is_playing>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------+
| void | :ref:`play<class_AudioStreamPlayback_play>` **(** :ref:`float<class_float>` from_pos_sec=0 **)** |
+----------------------------+------------------------------------------------------------------------------------------------------+
| void | :ref:`seek_pos<class_AudioStreamPlayback_seek_pos>` **(** :ref:`float<class_float>` pos **)** |
+----------------------------+------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop<class_AudioStreamPlayback_set_loop>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------+------------------------------------------------------------------------------------------------------+
| void | :ref:`stop<class_AudioStreamPlayback_stop>` **(** **)** |
+----------------------------+------------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_AudioStreamPlayback_get_channels:
- :ref:`int<class_int>` **get_channels** **(** **)** const
.. _class_AudioStreamPlayback_get_length:
- :ref:`float<class_float>` **get_length** **(** **)** const
.. _class_AudioStreamPlayback_get_loop_count:
- :ref:`int<class_int>` **get_loop_count** **(** **)** const
.. _class_AudioStreamPlayback_get_minimum_buffer_size:
- :ref:`int<class_int>` **get_minimum_buffer_size** **(** **)** const
.. _class_AudioStreamPlayback_get_mix_rate:
- :ref:`int<class_int>` **get_mix_rate** **(** **)** const
.. _class_AudioStreamPlayback_get_pos:
- :ref:`float<class_float>` **get_pos** **(** **)** const
.. _class_AudioStreamPlayback_has_loop:
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
.. _class_AudioStreamPlayback_is_playing:
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
.. _class_AudioStreamPlayback_play:
- void **play** **(** :ref:`float<class_float>` from_pos_sec=0 **)**
.. _class_AudioStreamPlayback_seek_pos:
- void **seek_pos** **(** :ref:`float<class_float>` pos **)**
.. _class_AudioStreamPlayback_set_loop:
- void **set_loop** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_AudioStreamPlayback_stop:
- void **stop** **(** **)**

View File

@@ -0,0 +1,121 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AudioStreamSample:
AudioStreamSample
=================
**Inherits:** :ref:`AudioStream<class_audiostream>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`get_data<class_AudioStreamSample_get_data>` **(** **)** const |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_format<class_AudioStreamSample_get_format>` **(** **)** const |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_loop_begin<class_AudioStreamSample_get_loop_begin>` **(** **)** const |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_loop_end<class_AudioStreamSample_get_loop_end>` **(** **)** const |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_loop_mode<class_AudioStreamSample_get_loop_mode>` **(** **)** const |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mix_rate<class_AudioStreamSample_get_mix_rate>` **(** **)** const |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_stereo<class_AudioStreamSample_is_stereo>` **(** **)** const |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_data<class_AudioStreamSample_set_data>` **(** :ref:`PoolByteArray<class_poolbytearray>` data **)** |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_format<class_AudioStreamSample_set_format>` **(** :ref:`int<class_int>` format **)** |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop_begin<class_AudioStreamSample_set_loop_begin>` **(** :ref:`int<class_int>` loop_begin **)** |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop_end<class_AudioStreamSample_set_loop_end>` **(** :ref:`int<class_int>` loop_end **)** |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop_mode<class_AudioStreamSample_set_loop_mode>` **(** :ref:`int<class_int>` loop_mode **)** |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mix_rate<class_AudioStreamSample_set_mix_rate>` **(** :ref:`int<class_int>` mix_rate **)** |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_stereo<class_AudioStreamSample_set_stereo>` **(** :ref:`bool<class_bool>` stereo **)** |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`PoolByteArray<class_poolbytearray>` **data**
- :ref:`int<class_int>` **format**
- :ref:`int<class_int>` **loop_begin**
- :ref:`int<class_int>` **loop_end**
- :ref:`int<class_int>` **loop_mode**
- :ref:`int<class_int>` **mix_rate**
- :ref:`bool<class_bool>` **stereo**
Member Function Description
---------------------------
.. _class_AudioStreamSample_get_data:
- :ref:`PoolByteArray<class_poolbytearray>` **get_data** **(** **)** const
.. _class_AudioStreamSample_get_format:
- :ref:`int<class_int>` **get_format** **(** **)** const
.. _class_AudioStreamSample_get_loop_begin:
- :ref:`int<class_int>` **get_loop_begin** **(** **)** const
.. _class_AudioStreamSample_get_loop_end:
- :ref:`int<class_int>` **get_loop_end** **(** **)** const
.. _class_AudioStreamSample_get_loop_mode:
- :ref:`int<class_int>` **get_loop_mode** **(** **)** const
.. _class_AudioStreamSample_get_mix_rate:
- :ref:`int<class_int>` **get_mix_rate** **(** **)** const
.. _class_AudioStreamSample_is_stereo:
- :ref:`bool<class_bool>` **is_stereo** **(** **)** const
.. _class_AudioStreamSample_set_data:
- void **set_data** **(** :ref:`PoolByteArray<class_poolbytearray>` data **)**
.. _class_AudioStreamSample_set_format:
- void **set_format** **(** :ref:`int<class_int>` format **)**
.. _class_AudioStreamSample_set_loop_begin:
- void **set_loop_begin** **(** :ref:`int<class_int>` loop_begin **)**
.. _class_AudioStreamSample_set_loop_end:
- void **set_loop_end** **(** :ref:`int<class_int>` loop_end **)**
.. _class_AudioStreamSample_set_loop_mode:
- void **set_loop_mode** **(** :ref:`int<class_int>` loop_mode **)**
.. _class_AudioStreamSample_set_mix_rate:
- void **set_mix_rate** **(** :ref:`int<class_int>` mix_rate **)**
.. _class_AudioStreamSample_set_stereo:
- void **set_stereo** **(** :ref:`bool<class_bool>` stereo **)**

View File

@@ -28,6 +28,12 @@ Member Functions
| void | :ref:`set_rect<class_BackBufferCopy_set_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`int<class_int>` **copy_mode**
- :ref:`Rect2<class_rect2>` **rect**
Numeric Constants
-----------------

View File

@@ -6,7 +6,7 @@
BakedLight
==========
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Inherits:** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
@@ -18,314 +18,61 @@ Brief Description
Member Functions
----------------
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_lightmap<class_BakedLight_add_lightmap>` **(** :ref:`Texture<class_texture>` texture, :ref:`Vector2<class_vector2>` gen_size **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_lightmaps<class_BakedLight_clear_lightmaps>` **(** **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_lightmap<class_BakedLight_erase_lightmap>` **(** :ref:`int<class_int>` id **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_ao_radius<class_BakedLight_get_ao_radius>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_ao_strength<class_BakedLight_get_ao_strength>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_bake_flag<class_BakedLight_get_bake_flag>` **(** :ref:`int<class_int>` flag **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bounces<class_BakedLight_get_bounces>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_cell_extra_margin<class_BakedLight_get_cell_extra_margin>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cell_subdivision<class_BakedLight_get_cell_subdivision>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_edge_damp<class_BakedLight_get_edge_damp>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_energy_multiplier<class_BakedLight_get_energy_multiplier>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_format<class_BakedLight_get_format>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_gamma_adjust<class_BakedLight_get_gamma_adjust>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_initial_lattice_subdiv<class_BakedLight_get_initial_lattice_subdiv>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RawArray<class_rawarray>` | :ref:`get_light<class_BakedLight_get_light>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mode<class_BakedLight_get_mode>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_normal_damp<class_BakedLight_get_normal_damp>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RawArray<class_rawarray>` | :ref:`get_octree<class_BakedLight_get_octree>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_plot_size<class_BakedLight_get_plot_size>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_realtime_color<class_BakedLight_get_realtime_color>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_realtime_color_enabled<class_BakedLight_get_realtime_color_enabled>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_realtime_energy<class_BakedLight_get_realtime_energy>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`IntArray<class_intarray>` | :ref:`get_sampler_octree<class_BakedLight_get_sampler_octree>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_saturation<class_BakedLight_get_saturation>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tint<class_BakedLight_get_tint>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_transfer_lightmaps_only_to_uv2<class_BakedLight_get_transfer_lightmaps_only_to_uv2>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ao_radius<class_BakedLight_set_ao_radius>` **(** :ref:`float<class_float>` ao_radius **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ao_strength<class_BakedLight_set_ao_strength>` **(** :ref:`float<class_float>` ao_strength **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bake_flag<class_BakedLight_set_bake_flag>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enabled **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bounces<class_BakedLight_set_bounces>` **(** :ref:`int<class_int>` bounces **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_extra_margin<class_BakedLight_set_cell_extra_margin>` **(** :ref:`float<class_float>` cell_extra_margin **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_subdivision<class_BakedLight_set_cell_subdivision>` **(** :ref:`int<class_int>` cell_subdivision **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_edge_damp<class_BakedLight_set_edge_damp>` **(** :ref:`float<class_float>` edge_damp **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_energy_multiplier<class_BakedLight_set_energy_multiplier>` **(** :ref:`float<class_float>` energy_multiplier **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_format<class_BakedLight_set_format>` **(** :ref:`int<class_int>` format **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gamma_adjust<class_BakedLight_set_gamma_adjust>` **(** :ref:`float<class_float>` gamma_adjust **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_initial_lattice_subdiv<class_BakedLight_set_initial_lattice_subdiv>` **(** :ref:`int<class_int>` cell_subdivision **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_light<class_BakedLight_set_light>` **(** :ref:`RawArray<class_rawarray>` light **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mode<class_BakedLight_set_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_normal_damp<class_BakedLight_set_normal_damp>` **(** :ref:`float<class_float>` normal_damp **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_octree<class_BakedLight_set_octree>` **(** :ref:`RawArray<class_rawarray>` octree **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_plot_size<class_BakedLight_set_plot_size>` **(** :ref:`float<class_float>` plot_size **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_realtime_color<class_BakedLight_set_realtime_color>` **(** :ref:`Color<class_color>` tint **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_realtime_color_enabled<class_BakedLight_set_realtime_color_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_realtime_energy<class_BakedLight_set_realtime_energy>` **(** :ref:`float<class_float>` energy **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_sampler_octree<class_BakedLight_set_sampler_octree>` **(** :ref:`IntArray<class_intarray>` sampler_octree **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_saturation<class_BakedLight_set_saturation>` **(** :ref:`float<class_float>` saturation **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tint<class_BakedLight_set_tint>` **(** :ref:`float<class_float>` tint **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_transfer_lightmaps_only_to_uv2<class_BakedLight_set_transfer_lightmaps_only_to_uv2>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`bake<class_BakedLight_bake>` **(** **)** |
+------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`bake_lights<class_BakedLight_bake_lights>` **(** **)** |
+------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`bake_radiance<class_BakedLight_bake_radiance>` **(** **)** |
+------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`debug_mesh_albedo<class_BakedLight_debug_mesh_albedo>` **(** **)** |
+------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`debug_mesh_light<class_BakedLight_debug_mesh_light>` **(** **)** |
+------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cell_subdiv<class_BakedLight_get_cell_subdiv>` **(** **)** const |
+------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_subdiv<class_BakedLight_set_cell_subdiv>` **(** :ref:`int<class_int>` steps **)** |
+------------------------+----------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
Signals
-------
- **MODE_OCTREE** = **0**
- **MODE_LIGHTMAPS** = **1**
- **BAKE_DIFFUSE** = **0**
- **BAKE_SPECULAR** = **1**
- **BAKE_TRANSLUCENT** = **2**
- **BAKE_CONSERVE_ENERGY** = **3**
- **BAKE_MAX** = **5**
- **baked_light_changed** **(** **)**
Member Variables
----------------
- :ref:`int<class_int>` **cell_subdiv**
Member Function Description
---------------------------
.. _class_BakedLight_add_lightmap:
.. _class_BakedLight_bake:
- void **add_lightmap** **(** :ref:`Texture<class_texture>` texture, :ref:`Vector2<class_vector2>` gen_size **)**
- void **bake** **(** **)**
.. _class_BakedLight_clear_lightmaps:
.. _class_BakedLight_bake_lights:
- void **clear_lightmaps** **(** **)**
- void **bake_lights** **(** **)**
.. _class_BakedLight_erase_lightmap:
.. _class_BakedLight_bake_radiance:
- void **erase_lightmap** **(** :ref:`int<class_int>` id **)**
- void **bake_radiance** **(** **)**
.. _class_BakedLight_get_ao_radius:
.. _class_BakedLight_debug_mesh_albedo:
- :ref:`float<class_float>` **get_ao_radius** **(** **)** const
- void **debug_mesh_albedo** **(** **)**
.. _class_BakedLight_get_ao_strength:
.. _class_BakedLight_debug_mesh_light:
- :ref:`float<class_float>` **get_ao_strength** **(** **)** const
- void **debug_mesh_light** **(** **)**
.. _class_BakedLight_get_bake_flag:
.. _class_BakedLight_get_cell_subdiv:
- :ref:`bool<class_bool>` **get_bake_flag** **(** :ref:`int<class_int>` flag **)** const
- :ref:`int<class_int>` **get_cell_subdiv** **(** **)** const
.. _class_BakedLight_get_bounces:
.. _class_BakedLight_set_cell_subdiv:
- :ref:`int<class_int>` **get_bounces** **(** **)** const
.. _class_BakedLight_get_cell_extra_margin:
- :ref:`float<class_float>` **get_cell_extra_margin** **(** **)** const
.. _class_BakedLight_get_cell_subdivision:
- :ref:`int<class_int>` **get_cell_subdivision** **(** **)** const
.. _class_BakedLight_get_edge_damp:
- :ref:`float<class_float>` **get_edge_damp** **(** **)** const
.. _class_BakedLight_get_energy_multiplier:
- :ref:`float<class_float>` **get_energy_multiplier** **(** **)** const
.. _class_BakedLight_get_format:
- :ref:`int<class_int>` **get_format** **(** **)** const
.. _class_BakedLight_get_gamma_adjust:
- :ref:`float<class_float>` **get_gamma_adjust** **(** **)** const
.. _class_BakedLight_get_initial_lattice_subdiv:
- :ref:`int<class_int>` **get_initial_lattice_subdiv** **(** **)** const
.. _class_BakedLight_get_light:
- :ref:`RawArray<class_rawarray>` **get_light** **(** **)** const
.. _class_BakedLight_get_mode:
- :ref:`int<class_int>` **get_mode** **(** **)** const
.. _class_BakedLight_get_normal_damp:
- :ref:`float<class_float>` **get_normal_damp** **(** **)** const
.. _class_BakedLight_get_octree:
- :ref:`RawArray<class_rawarray>` **get_octree** **(** **)** const
.. _class_BakedLight_get_plot_size:
- :ref:`float<class_float>` **get_plot_size** **(** **)** const
.. _class_BakedLight_get_realtime_color:
- :ref:`Color<class_color>` **get_realtime_color** **(** **)** const
.. _class_BakedLight_get_realtime_color_enabled:
- :ref:`bool<class_bool>` **get_realtime_color_enabled** **(** **)** const
.. _class_BakedLight_get_realtime_energy:
- :ref:`float<class_float>` **get_realtime_energy** **(** **)** const
.. _class_BakedLight_get_sampler_octree:
- :ref:`IntArray<class_intarray>` **get_sampler_octree** **(** **)** const
.. _class_BakedLight_get_saturation:
- :ref:`float<class_float>` **get_saturation** **(** **)** const
.. _class_BakedLight_get_tint:
- :ref:`float<class_float>` **get_tint** **(** **)** const
.. _class_BakedLight_get_transfer_lightmaps_only_to_uv2:
- :ref:`bool<class_bool>` **get_transfer_lightmaps_only_to_uv2** **(** **)** const
.. _class_BakedLight_set_ao_radius:
- void **set_ao_radius** **(** :ref:`float<class_float>` ao_radius **)**
.. _class_BakedLight_set_ao_strength:
- void **set_ao_strength** **(** :ref:`float<class_float>` ao_strength **)**
.. _class_BakedLight_set_bake_flag:
- void **set_bake_flag** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enabled **)**
.. _class_BakedLight_set_bounces:
- void **set_bounces** **(** :ref:`int<class_int>` bounces **)**
.. _class_BakedLight_set_cell_extra_margin:
- void **set_cell_extra_margin** **(** :ref:`float<class_float>` cell_extra_margin **)**
.. _class_BakedLight_set_cell_subdivision:
- void **set_cell_subdivision** **(** :ref:`int<class_int>` cell_subdivision **)**
.. _class_BakedLight_set_edge_damp:
- void **set_edge_damp** **(** :ref:`float<class_float>` edge_damp **)**
.. _class_BakedLight_set_energy_multiplier:
- void **set_energy_multiplier** **(** :ref:`float<class_float>` energy_multiplier **)**
.. _class_BakedLight_set_format:
- void **set_format** **(** :ref:`int<class_int>` format **)**
.. _class_BakedLight_set_gamma_adjust:
- void **set_gamma_adjust** **(** :ref:`float<class_float>` gamma_adjust **)**
.. _class_BakedLight_set_initial_lattice_subdiv:
- void **set_initial_lattice_subdiv** **(** :ref:`int<class_int>` cell_subdivision **)**
.. _class_BakedLight_set_light:
- void **set_light** **(** :ref:`RawArray<class_rawarray>` light **)**
.. _class_BakedLight_set_mode:
- void **set_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_BakedLight_set_normal_damp:
- void **set_normal_damp** **(** :ref:`float<class_float>` normal_damp **)**
.. _class_BakedLight_set_octree:
- void **set_octree** **(** :ref:`RawArray<class_rawarray>` octree **)**
.. _class_BakedLight_set_plot_size:
- void **set_plot_size** **(** :ref:`float<class_float>` plot_size **)**
.. _class_BakedLight_set_realtime_color:
- void **set_realtime_color** **(** :ref:`Color<class_color>` tint **)**
.. _class_BakedLight_set_realtime_color_enabled:
- void **set_realtime_color_enabled** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_BakedLight_set_realtime_energy:
- void **set_realtime_energy** **(** :ref:`float<class_float>` energy **)**
.. _class_BakedLight_set_sampler_octree:
- void **set_sampler_octree** **(** :ref:`IntArray<class_intarray>` sampler_octree **)**
.. _class_BakedLight_set_saturation:
- void **set_saturation** **(** :ref:`float<class_float>` saturation **)**
.. _class_BakedLight_set_tint:
- void **set_tint** **(** :ref:`float<class_float>` tint **)**
.. _class_BakedLight_set_transfer_lightmaps_only_to_uv2:
- void **set_transfer_lightmaps_only_to_uv2** **(** :ref:`bool<class_bool>` enable **)**
- void **set_cell_subdiv** **(** :ref:`int<class_int>` steps **)**

View File

@@ -1,49 +0,0 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_BakedLightInstance:
BakedLightInstance
==================
**Inherits:** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_baked_light<class_BakedLightInstance_get_baked_light>` **(** **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_baked_light_instance<class_BakedLightInstance_get_baked_light_instance>` **(** **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_baked_light<class_BakedLightInstance_set_baked_light>` **(** :ref:`Object<class_object>` baked_light **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------+
Signals
-------
- **baked_light_changed** **(** **)**
Member Function Description
---------------------------
.. _class_BakedLightInstance_get_baked_light:
- :ref:`Object<class_object>` **get_baked_light** **(** **)** const
.. _class_BakedLightInstance_get_baked_light_instance:
- :ref:`RID<class_rid>` **get_baked_light_instance** **(** **)** const
.. _class_BakedLightInstance_set_baked_light:
- void **set_baked_light** **(** :ref:`Object<class_object>` baked_light **)**

View File

@@ -1,59 +0,0 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_BakedLightSampler:
BakedLightSampler
=================
**Inherits:** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param<class_BakedLightSampler_get_param>` **(** :ref:`int<class_int>` param **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_resolution<class_BakedLightSampler_get_resolution>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param<class_BakedLightSampler_set_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_resolution<class_BakedLightSampler_set_resolution>` **(** :ref:`int<class_int>` resolution **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **PARAM_RADIUS** = **0**
- **PARAM_STRENGTH** = **1**
- **PARAM_ATTENUATION** = **2**
- **PARAM_DETAIL_RATIO** = **3**
- **PARAM_MAX** = **4**
Member Function Description
---------------------------
.. _class_BakedLightSampler_get_param:
- :ref:`float<class_float>` **get_param** **(** :ref:`int<class_int>` param **)** const
.. _class_BakedLightSampler_get_resolution:
- :ref:`int<class_int>` **get_resolution** **(** **)** const
.. _class_BakedLightSampler_set_param:
- void **set_param** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
.. _class_BakedLightSampler_set_resolution:
- void **set_resolution** **(** :ref:`int<class_int>` resolution **)**

View File

@@ -20,39 +20,43 @@ Provides a base class for different kinds of buttons.
Member Functions
----------------
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`_pressed<class_BaseButton__pressed>` **(** **)** virtual |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`_toggled<class_BaseButton__toggled>` **(** :ref:`bool<class_bool>` pressed **)** virtual |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_click_on_press<class_BaseButton_get_click_on_press>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_draw_mode<class_BaseButton_get_draw_mode>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_enabled_focus_mode<class_BaseButton_get_enabled_focus_mode>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_shortcut<class_BaseButton_get_shortcut>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_disabled<class_BaseButton_is_disabled>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_hovered<class_BaseButton_is_hovered>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_BaseButton_is_pressed>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_toggle_mode<class_BaseButton_is_toggle_mode>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_click_on_press<class_BaseButton_set_click_on_press>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_disabled<class_BaseButton_set_disabled>` **(** :ref:`bool<class_bool>` disabled **)** |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_enabled_focus_mode<class_BaseButton_set_enabled_focus_mode>` **(** :ref:`int<class_int>` mode **)** |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pressed<class_BaseButton_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shortcut<class_BaseButton_set_shortcut>` **(** :ref:`Object<class_object>` shortcut **)** |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_toggle_mode<class_BaseButton_set_toggle_mode>` **(** :ref:`bool<class_bool>` enabled **)** |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_pressed<class_BaseButton__pressed>` **(** **)** virtual |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_toggled<class_BaseButton__toggled>` **(** :ref:`bool<class_bool>` pressed **)** virtual |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_action_mode<class_BaseButton_get_action_mode>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_button_group<class_BaseButton_get_button_group>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_draw_mode<class_BaseButton_get_draw_mode>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_enabled_focus_mode<class_BaseButton_get_enabled_focus_mode>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_shortcut<class_BaseButton_get_shortcut>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_disabled<class_BaseButton_is_disabled>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_hovered<class_BaseButton_is_hovered>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_BaseButton_is_pressed>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_toggle_mode<class_BaseButton_is_toggle_mode>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_action_mode<class_BaseButton_set_action_mode>` **(** :ref:`int<class_int>` mode **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_group<class_BaseButton_set_button_group>` **(** :ref:`Object<class_object>` button_group **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_disabled<class_BaseButton_set_disabled>` **(** :ref:`bool<class_bool>` disabled **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_enabled_focus_mode<class_BaseButton_set_enabled_focus_mode>` **(** :ref:`int<class_int>` mode **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pressed<class_BaseButton_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shortcut<class_BaseButton_set_shortcut>` **(** :ref:`Object<class_object>` shortcut **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_toggle_mode<class_BaseButton_set_toggle_mode>` **(** :ref:`bool<class_bool>` enabled **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -60,9 +64,19 @@ Signals
- **button_down** **(** **)**
- **button_up** **(** **)**
- **pressed** **(** **)**
- **released** **(** **)**
- **toggled** **(** :ref:`bool<class_bool>` pressed **)**
Member Variables
----------------
- :ref:`int<class_int>` **action_mode**
- :ref:`bool<class_bool>` **disabled**
- :ref:`int<class_int>` **enabled_focus_mode**
- :ref:`ButtonGroup<class_buttongroup>` **group**
- :ref:`bool<class_bool>` **is_pressed**
- :ref:`ShortCut<class_shortcut>` **shortcut**
- :ref:`bool<class_bool>` **toggle_mode**
Numeric Constants
-----------------
@@ -70,6 +84,8 @@ Numeric Constants
- **DRAW_PRESSED** = **1** --- The state of buttons are pressed.
- **DRAW_HOVER** = **2** --- The state of buttons are hovered.
- **DRAW_DISABLED** = **3** --- The state of buttons are disabled.
- **ACTION_MODE_BUTTON_PRESS** = **0** --- Require just a press to consider the button clicked.
- **ACTION_MODE_BUTTON_RELEASE** = **1** --- Require a press and a subsequent release before considering the button clicked.
Description
-----------
@@ -91,11 +107,15 @@ Called when button is pressed.
Called when button is toggled (only if toggle_mode is active).
.. _class_BaseButton_get_click_on_press:
.. _class_BaseButton_get_action_mode:
- :ref:`bool<class_bool>` **get_click_on_press** **(** **)** const
- :ref:`int<class_int>` **get_action_mode** **(** **)** const
Return the state of the click_on_press property (see :ref:`set_click_on_press<class_BaseButton_set_click_on_press>`).
Return the current mode of action (see :ref:`set_action_mode<class_BaseButton_set_action_mode>`) (one of the ACTION_MODE\_\* constants).
.. _class_BaseButton_get_button_group:
- :ref:`Object<class_object>` **get_button_group** **(** **)** const
.. _class_BaseButton_get_draw_mode:
@@ -137,11 +157,15 @@ If toggle_mode is active, return whether the button is toggled. If toggle_mode i
Return the toggle_mode property (see :ref:`set_toggle_mode<class_BaseButton_set_toggle_mode>`).
.. _class_BaseButton_set_click_on_press:
.. _class_BaseButton_set_action_mode:
- void **set_click_on_press** **(** :ref:`bool<class_bool>` enable **)**
- void **set_action_mode** **(** :ref:`int<class_int>` mode **)**
Set the button click_on_press mode. This mode generates click events when a mouse button or key is just pressed (by default events are generated when the button/keys are released and both press and release occur in the visual area of the Button).
Set the current mode of action, determining when the button is considered clicked (see the ACTION_MODE\_\* constants).
.. _class_BaseButton_set_button_group:
- void **set_button_group** **(** :ref:`Object<class_object>` button_group **)**
.. _class_BaseButton_set_disabled:

View File

@@ -1,10 +1,10 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_Matrix3:
.. _class_Basis:
Matrix3
=======
Basis
=====
**Category:** Built-In Types
@@ -16,41 +16,41 @@ Brief Description
Member Functions
----------------
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix3<class_matrix3>` | :ref:`Matrix3<class_Matrix3_Matrix3>` **(** :ref:`Quat<class_quat>` from **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix3<class_matrix3>` | :ref:`Matrix3<class_Matrix3_Matrix3>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix3<class_matrix3>` | :ref:`Matrix3<class_Matrix3_Matrix3>` **(** :ref:`Vector3<class_vector3>` x_axis, :ref:`Vector3<class_vector3>` y_axis, :ref:`Vector3<class_vector3>` z_axis **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`determinant<class_Matrix3_determinant>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_euler<class_Matrix3_get_euler>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_orthogonal_index<class_Matrix3_get_orthogonal_index>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_scale<class_Matrix3_get_scale>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix3<class_matrix3>` | :ref:`inverse<class_Matrix3_inverse>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix3<class_matrix3>` | :ref:`orthonormalized<class_Matrix3_orthonormalized>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix3<class_matrix3>` | :ref:`rotated<class_Matrix3_rotated>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix3<class_matrix3>` | :ref:`scaled<class_Matrix3_scaled>` **(** :ref:`Vector3<class_vector3>` scale **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tdotx<class_Matrix3_tdotx>` **(** :ref:`Vector3<class_vector3>` with **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tdoty<class_Matrix3_tdoty>` **(** :ref:`Vector3<class_vector3>` with **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tdotz<class_Matrix3_tdotz>` **(** :ref:`Vector3<class_vector3>` with **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix3<class_matrix3>` | :ref:`transposed<class_Matrix3_transposed>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`xform<class_Matrix3_xform>` **(** :ref:`Vector3<class_vector3>` v **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`xform_inv<class_Matrix3_xform_inv>` **(** :ref:`Vector3<class_vector3>` v **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_basis>` | :ref:`Basis<class_Basis_Basis>` **(** :ref:`Quat<class_quat>` from **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_basis>` | :ref:`Basis<class_Basis_Basis>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_basis>` | :ref:`Basis<class_Basis_Basis>` **(** :ref:`Vector3<class_vector3>` x_axis, :ref:`Vector3<class_vector3>` y_axis, :ref:`Vector3<class_vector3>` z_axis **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`determinant<class_Basis_determinant>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_euler<class_Basis_get_euler>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_orthogonal_index<class_Basis_get_orthogonal_index>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_scale<class_Basis_get_scale>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_basis>` | :ref:`inverse<class_Basis_inverse>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_basis>` | :ref:`orthonormalized<class_Basis_orthonormalized>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_basis>` | :ref:`rotated<class_Basis_rotated>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_basis>` | :ref:`scaled<class_Basis_scaled>` **(** :ref:`Vector3<class_vector3>` scale **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tdotx<class_Basis_tdotx>` **(** :ref:`Vector3<class_vector3>` with **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tdoty<class_Basis_tdoty>` **(** :ref:`Vector3<class_vector3>` with **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tdotz<class_Basis_tdotz>` **(** :ref:`Vector3<class_vector3>` with **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_basis>` | :ref:`transposed<class_Basis_transposed>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`xform<class_Basis_xform>` **(** :ref:`Vector3<class_vector3>` v **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`xform_inv<class_Basis_xform_inv>` **(** :ref:`Vector3<class_vector3>` v **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -62,105 +62,115 @@ Member Variables
Description
-----------
3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z. Can also be accessed as array of 3D vectors. Almost always used as orthogonal basis for a :ref:`Transform<class_transform>`.
3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z as its columns, which can be interpreted as the local basis vectors of a transformation. Can also be accessed as array of 3D vectors. These vectors are orthogonal to each other, but are not necessarily normalized. Almost always used as orthogonal basis for a :ref:`Transform<class_transform>`.
For such use, it is composed of a scaling and a rotation matrix, in that order (M = R.S).
Member Function Description
---------------------------
.. _class_Matrix3_Matrix3:
.. _class_Basis_Basis:
- :ref:`Matrix3<class_matrix3>` **Matrix3** **(** :ref:`Quat<class_quat>` from **)**
- :ref:`Basis<class_basis>` **Basis** **(** :ref:`Quat<class_quat>` from **)**
Create a matrix from a quaternion.
Create a rotation matrix from the given quaternion.
.. _class_Matrix3_Matrix3:
.. _class_Basis_Basis:
- :ref:`Matrix3<class_matrix3>` **Matrix3** **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)**
- :ref:`Basis<class_basis>` **Basis** **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)**
Create a matrix which rotates around the given axis by the specified angle.
Create a rotation matrix which rotates around the given axis by the specified angle. The axis must be a normalized vector.
.. _class_Matrix3_Matrix3:
.. _class_Basis_Basis:
- :ref:`Matrix3<class_matrix3>` **Matrix3** **(** :ref:`Vector3<class_vector3>` x_axis, :ref:`Vector3<class_vector3>` y_axis, :ref:`Vector3<class_vector3>` z_axis **)**
- :ref:`Basis<class_basis>` **Basis** **(** :ref:`Vector3<class_vector3>` x_axis, :ref:`Vector3<class_vector3>` y_axis, :ref:`Vector3<class_vector3>` z_axis **)**
Create a matrix from 3 axis vectors.
.. _class_Matrix3_determinant:
.. _class_Basis_determinant:
- :ref:`float<class_float>` **determinant** **(** **)**
Return the determinant of the matrix.
.. _class_Matrix3_get_euler:
.. _class_Basis_get_euler:
- :ref:`Vector3<class_vector3>` **get_euler** **(** **)**
Return euler angles (in the XYZ convention: first Z, then Y, and X last) from the matrix. Returned vector contains the rotation angles in the format (third,second,first).
Return Euler angles (in the XYZ convention: first Z, then Y, and X last) from the matrix. Returned vector contains the rotation angles in the format (third,second,first).
.. _class_Matrix3_get_orthogonal_index:
This function only works if the matrix represents a proper rotation.
.. _class_Basis_get_orthogonal_index:
- :ref:`int<class_int>` **get_orthogonal_index** **(** **)**
.. _class_Matrix3_get_scale:
This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1,0 or 1, and returns the index of the point best representing the orientation of the object. It is mainly used by the grid map editor. For further details, refer to Godot source code.
.. _class_Basis_get_scale:
- :ref:`Vector3<class_vector3>` **get_scale** **(** **)**
.. _class_Matrix3_inverse:
Assuming that the matrix is the combination of a rotation and scaling, return the absolute value of scaling factors along each axis.
- :ref:`Matrix3<class_matrix3>` **inverse** **(** **)**
.. _class_Basis_inverse:
Return the affine inverse of the matrix.
- :ref:`Basis<class_basis>` **inverse** **(** **)**
.. _class_Matrix3_orthonormalized:
Return the inverse of the matrix.
- :ref:`Matrix3<class_matrix3>` **orthonormalized** **(** **)**
.. _class_Basis_orthonormalized:
- :ref:`Basis<class_basis>` **orthonormalized** **(** **)**
Return the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix.
.. _class_Matrix3_rotated:
.. _class_Basis_rotated:
- :ref:`Matrix3<class_matrix3>` **rotated** **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)**
- :ref:`Basis<class_basis>` **rotated** **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)**
.. _class_Matrix3_scaled:
Introduce an additional rotation around the given axis by phi. Only relevant when the matrix is being used as a part of :ref:`Transform<class_transform>`. The axis must be a normalized vector.
- :ref:`Matrix3<class_matrix3>` **scaled** **(** :ref:`Vector3<class_vector3>` scale **)**
.. _class_Basis_scaled:
Return the scaled version of the matrix, by a 3D scale.
- :ref:`Basis<class_basis>` **scaled** **(** :ref:`Vector3<class_vector3>` scale **)**
.. _class_Matrix3_tdotx:
Introduce an additional scaling specified by the given 3D scaling factor. Only relevant when the matrix is being used as a part of :ref:`Transform<class_transform>`.
.. _class_Basis_tdotx:
- :ref:`float<class_float>` **tdotx** **(** :ref:`Vector3<class_vector3>` with **)**
Transposed dot product with the x axis of the matrix.
.. _class_Matrix3_tdoty:
.. _class_Basis_tdoty:
- :ref:`float<class_float>` **tdoty** **(** :ref:`Vector3<class_vector3>` with **)**
Transposed dot product with the y axis of the matrix.
.. _class_Matrix3_tdotz:
.. _class_Basis_tdotz:
- :ref:`float<class_float>` **tdotz** **(** :ref:`Vector3<class_vector3>` with **)**
Transposed dot product with the z axis of the matrix.
.. _class_Matrix3_transposed:
.. _class_Basis_transposed:
- :ref:`Matrix3<class_matrix3>` **transposed** **(** **)**
- :ref:`Basis<class_basis>` **transposed** **(** **)**
Return the transposed version of the matrix.
.. _class_Matrix3_xform:
.. _class_Basis_xform:
- :ref:`Vector3<class_vector3>` **xform** **(** :ref:`Vector3<class_vector3>` v **)**
Return a vector transformed by the matrix and return it.
Return a vector transformed (multiplied) by the matrix and return it.
.. _class_Matrix3_xform_inv:
.. _class_Basis_xform_inv:
- :ref:`Vector3<class_vector3>` **xform_inv** **(** :ref:`Vector3<class_vector3>` v **)**
Return a vector transformed by the transposed matrix and return it.
Return a vector transformed (multiplied) by the transposed matrix and return it. Note that this is a multiplication by inverse only when the matrix represents a rotation-reflection.

View File

@@ -34,6 +34,11 @@ Member Functions
| void | :ref:`set_bit_rect<class_BitMap_set_bit_rect>` **(** :ref:`Rect2<class_rect2>` p_rect, :ref:`bool<class_bool>` bit **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`Dictionary<class_dictionary>` **data**
Member Function Description
---------------------------

View File

@@ -48,6 +48,17 @@ Member Functions
| void | :ref:`set_height<class_BitmapFont_set_height>` **(** :ref:`float<class_float>` px **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **ascent**
- :ref:`PoolIntArray<class_poolintarray>` **chars**
- :ref:`bool<class_bool>` **distance_field**
- :ref:`BitmapFont<class_bitmapfont>` **fallback**
- :ref:`float<class_float>` **height**
- :ref:`PoolIntArray<class_poolintarray>` **kernings**
- :ref:`Array<class_array>` **textures**
Member Function Description
---------------------------

View File

@@ -15,8 +15,29 @@ Brief Description
A node that will attach to a bone.
Member Functions
----------------
+------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_bone_name<class_BoneAttachment_get_bone_name>` **(** **)** const |
+------------------------------+--------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bone_name<class_BoneAttachment_set_bone_name>` **(** :ref:`String<class_string>` bone_name **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------+
Description
-----------
This node must be the child of a :ref:`Skeleton<class_skeleton>` node. You can then select a bone for this node to attach to. The BoneAttachment node will copy the transform of the selected bone.
Member Function Description
---------------------------
.. _class_BoneAttachment_get_bone_name:
- :ref:`String<class_string>` **get_bone_name** **(** **)** const
.. _class_BoneAttachment_set_bone_name:
- void **set_bone_name** **(** :ref:`String<class_string>` bone_name **)**

View File

@@ -8,7 +8,7 @@ BoxContainer
**Inherits:** :ref:`Container<class_container>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Inherited By:** :ref:`VBoxContainer<class_vboxcontainer>`, :ref:`ButtonGroup<class_buttongroup>`, :ref:`HBoxContainer<class_hboxcontainer>`, :ref:`ColorPicker<class_colorpicker>`
**Inherited By:** :ref:`VBoxContainer<class_vboxcontainer>`, :ref:`HBoxContainer<class_hboxcontainer>`, :ref:`ColorPicker<class_colorpicker>`
**Category:** Core
@@ -28,6 +28,11 @@ Member Functions
| void | :ref:`set_alignment<class_BoxContainer_set_alignment>` **(** :ref:`int<class_int>` alignment **)** |
+------------------------+------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`int<class_int>` **alignment**
Numeric Constants
-----------------

View File

@@ -24,6 +24,11 @@ Member Functions
| void | :ref:`set_extents<class_BoxShape_set_extents>` **(** :ref:`Vector3<class_vector3>` extents **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`Vector3<class_vector3>` **extents**
Description
-----------

View File

@@ -42,6 +42,15 @@ Member Functions
| void | :ref:`set_text_align<class_Button_set_text_align>` **(** :ref:`int<class_int>` align **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`int<class_int>` **align**
- :ref:`bool<class_bool>` **clip_text**
- :ref:`bool<class_bool>` **flat**
- :ref:`Texture<class_texture>` **icon**
- :ref:`String<class_string>` **text**
Numeric Constants
-----------------

View File

@@ -20,37 +20,50 @@ Array of Buttons.
Member Functions
----------------
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_button<class_ButtonArray_add_button>` **(** :ref:`String<class_string>` text **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_icon_button<class_ButtonArray_add_icon_button>` **(** :ref:`Texture<class_texture>` icon, :ref:`String<class_string>` text="" **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_ButtonArray_clear>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_button<class_ButtonArray_erase_button>` **(** :ref:`int<class_int>` button_idx **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_button_count<class_ButtonArray_get_button_count>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_button_icon<class_ButtonArray_get_button_icon>` **(** :ref:`int<class_int>` button_idx **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_button_text<class_ButtonArray_get_button_text>` **(** :ref:`int<class_int>` button_idx **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_hovered<class_ButtonArray_get_hovered>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_selected<class_ButtonArray_get_selected>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_icon<class_ButtonArray_set_button_icon>` **(** :ref:`int<class_int>` button_idx, :ref:`Texture<class_texture>` icon **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_text<class_ButtonArray_set_button_text>` **(** :ref:`int<class_int>` button_idx, :ref:`String<class_string>` text **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_selected<class_ButtonArray_set_selected>` **(** :ref:`int<class_int>` button_idx **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_button<class_ButtonArray_add_button>` **(** :ref:`String<class_string>` text, :ref:`String<class_string>` tooltip="" **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_icon_button<class_ButtonArray_add_icon_button>` **(** :ref:`Texture<class_texture>` icon, :ref:`String<class_string>` text="", :ref:`String<class_string>` tooltip="" **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_ButtonArray_clear>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_button<class_ButtonArray_erase_button>` **(** :ref:`int<class_int>` button_idx **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_button_count<class_ButtonArray_get_button_count>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_button_icon<class_ButtonArray_get_button_icon>` **(** :ref:`int<class_int>` button_idx **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_button_text<class_ButtonArray_get_button_text>` **(** :ref:`int<class_int>` button_idx **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_button_tooltip<class_ButtonArray_get_button_tooltip>` **(** :ref:`int<class_int>` button_idx **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_hovered<class_ButtonArray_get_hovered>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_selected<class_ButtonArray_get_selected>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_flat<class_ButtonArray_is_flat>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_icon<class_ButtonArray_set_button_icon>` **(** :ref:`int<class_int>` button_idx, :ref:`Texture<class_texture>` icon **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_text<class_ButtonArray_set_button_text>` **(** :ref:`int<class_int>` button_idx, :ref:`String<class_string>` text **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_tooltip<class_ButtonArray_set_button_tooltip>` **(** :ref:`int<class_int>` button_idx, :ref:`String<class_string>` text **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flat<class_ButtonArray_set_flat>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_selected<class_ButtonArray_set_selected>` **(** :ref:`int<class_int>` button_idx **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
- **button_selected** **(** :ref:`int<class_int>` button_idx **)**
Member Variables
----------------
- :ref:`bool<class_bool>` **flat**
Numeric Constants
-----------------
@@ -72,15 +85,15 @@ Member Function Description
.. _class_ButtonArray_add_button:
- void **add_button** **(** :ref:`String<class_string>` text **)**
- void **add_button** **(** :ref:`String<class_string>` text, :ref:`String<class_string>` tooltip="" **)**
Append a new button to the array, with the specified text.
Append a new button to the array, with the specified text and tooltip.
.. _class_ButtonArray_add_icon_button:
- void **add_icon_button** **(** :ref:`Texture<class_texture>` icon, :ref:`String<class_string>` text="" **)**
- void **add_icon_button** **(** :ref:`Texture<class_texture>` icon, :ref:`String<class_string>` text="", :ref:`String<class_string>` tooltip="" **)**
Append a new button to the array, with the specified icon and text.
Append a new button to the array, with the specified icon, text and tooltip.
.. _class_ButtonArray_clear:
@@ -112,6 +125,12 @@ Return the icon of the specified button.
Return the text of the specified button.
.. _class_ButtonArray_get_button_tooltip:
- :ref:`String<class_string>` **get_button_tooltip** **(** :ref:`int<class_int>` button_idx **)** const
Return the tooltip of the specified button.
.. _class_ButtonArray_get_hovered:
- :ref:`int<class_int>` **get_hovered** **(** **)** const
@@ -124,6 +143,10 @@ Return the index of the currently hovered button in the array.
Return the index of the currently selected button in the array.
.. _class_ButtonArray_is_flat:
- :ref:`bool<class_bool>` **is_flat** **(** **)** const
.. _class_ButtonArray_set_button_icon:
- void **set_button_icon** **(** :ref:`int<class_int>` button_idx, :ref:`Texture<class_texture>` icon **)**
@@ -136,6 +159,16 @@ Set the icon of the specified button.
Define the text of the specified button.
.. _class_ButtonArray_set_button_tooltip:
- void **set_button_tooltip** **(** :ref:`int<class_int>` button_idx, :ref:`String<class_string>` text **)**
Define the tooltip of the specified button.
.. _class_ButtonArray_set_flat:
- void **set_flat** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_ButtonArray_set_selected:
- void **set_selected** **(** :ref:`int<class_int>` button_idx **)**

View File

@@ -6,7 +6,7 @@
ButtonGroup
===========
**Inherits:** :ref:`BoxContainer<class_boxcontainer>` **<** :ref:`Container<class_container>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
@@ -18,17 +18,9 @@ Group of Buttons.
Member Functions
----------------
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_button_list<class_ButtonGroup_get_button_list>` **(** **)** const |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`BaseButton<class_basebutton>` | :ref:`get_focused_button<class_ButtonGroup_get_focused_button>` **(** **)** const |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`BaseButton<class_basebutton>` | :ref:`get_pressed_button<class_ButtonGroup_get_pressed_button>` **(** **)** const |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_pressed_button_index<class_ButtonGroup_get_pressed_button_index>` **(** **)** const |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pressed_button<class_ButtonGroup_set_pressed_button>` **(** :ref:`BaseButton<class_basebutton>` button **)** |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+------------------------------------------------------------------------------+
| :ref:`BaseButton<class_basebutton>` | :ref:`get_pressed_button<class_ButtonGroup_get_pressed_button>` **(** **)** |
+--------------------------------------+------------------------------------------------------------------------------+
Description
-----------
@@ -38,34 +30,10 @@ Group of :ref:`Button<class_button>`. All direct and indirect children buttons b
Member Function Description
---------------------------
.. _class_ButtonGroup_get_button_list:
- :ref:`Array<class_array>` **get_button_list** **(** **)** const
Return the list of all the buttons in the group.
.. _class_ButtonGroup_get_focused_button:
- :ref:`BaseButton<class_basebutton>` **get_focused_button** **(** **)** const
Return the focused button.
.. _class_ButtonGroup_get_pressed_button:
- :ref:`BaseButton<class_basebutton>` **get_pressed_button** **(** **)** const
- :ref:`BaseButton<class_basebutton>` **get_pressed_button** **(** **)**
Return the pressed button.
.. _class_ButtonGroup_get_pressed_button_index:
- :ref:`int<class_int>` **get_pressed_button_index** **(** **)** const
Return the index of the pressed button (by tree order).
.. _class_ButtonGroup_set_pressed_button:
- void **set_pressed_button** **(** :ref:`BaseButton<class_basebutton>` button **)**
Set the button to be pressed.

View File

@@ -25,17 +25,21 @@ Member Functions
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_camera_transform<class_Camera_get_camera_transform>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cull_mask<class_Camera_get_cull_mask>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Environment<class_environment>` | :ref:`get_environment<class_Camera_get_environment>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_fov<class_Camera_get_fov>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_h_offset<class_Camera_get_h_offset>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_keep_aspect_mode<class_Camera_get_keep_aspect_mode>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_projection<class_Camera_get_projection>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_size<class_Camera_get_size>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_visible_layers<class_Camera_get_visible_layers>` **(** **)** const |
| :ref:`float<class_float>` | :ref:`get_v_offset<class_Camera_get_v_offset>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_zfar<class_Camera_get_zfar>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -55,15 +59,19 @@ Member Functions
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`project_ray_origin<class_Camera_project_ray_origin>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cull_mask<class_Camera_set_cull_mask>` **(** :ref:`int<class_int>` mask **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_environment<class_Camera_set_environment>` **(** :ref:`Environment<class_environment>` env **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_h_offset<class_Camera_set_h_offset>` **(** :ref:`float<class_float>` ofs **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_keep_aspect_mode<class_Camera_set_keep_aspect_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_orthogonal<class_Camera_set_orthogonal>` **(** :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_perspective<class_Camera_set_perspective>` **(** :ref:`float<class_float>` fov, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_visible_layers<class_Camera_set_visible_layers>` **(** :ref:`int<class_int>` mask **)** |
| void | :ref:`set_v_offset<class_Camera_set_v_offset>` **(** :ref:`float<class_float>` ofs **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`unproject_position<class_Camera_unproject_position>` **(** :ref:`Vector3<class_vector3>` world_point **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -94,6 +102,10 @@ Member Function Description
Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the :ref:`Node<class_node>` transform.
.. _class_Camera_get_cull_mask:
- :ref:`int<class_int>` **get_cull_mask** **(** **)** const
.. _class_Camera_get_environment:
- :ref:`Environment<class_environment>` **get_environment** **(** **)** const
@@ -102,6 +114,10 @@ Get the camera transform. Subclassed cameras (such as CharacterCamera) may provi
- :ref:`float<class_float>` **get_fov** **(** **)** const
.. _class_Camera_get_h_offset:
- :ref:`float<class_float>` **get_h_offset** **(** **)** const
.. _class_Camera_get_keep_aspect_mode:
- :ref:`int<class_int>` **get_keep_aspect_mode** **(** **)** const
@@ -114,9 +130,9 @@ Get the camera transform. Subclassed cameras (such as CharacterCamera) may provi
- :ref:`float<class_float>` **get_size** **(** **)** const
.. _class_Camera_get_visible_layers:
.. _class_Camera_get_v_offset:
- :ref:`int<class_int>` **get_visible_layers** **(** **)** const
- :ref:`float<class_float>` **get_v_offset** **(** **)** const
.. _class_Camera_get_zfar:
@@ -162,10 +178,18 @@ Return a normal vector in worldspace, that is the result of projecting a point o
Return a 3D position in worldspace, that is the result of projecting a point on the :ref:`Viewport<class_viewport>` rectangle by the camera projection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking.
.. _class_Camera_set_cull_mask:
- void **set_cull_mask** **(** :ref:`int<class_int>` mask **)**
.. _class_Camera_set_environment:
- void **set_environment** **(** :ref:`Environment<class_environment>` env **)**
.. _class_Camera_set_h_offset:
- void **set_h_offset** **(** :ref:`float<class_float>` ofs **)**
.. _class_Camera_set_keep_aspect_mode:
- void **set_keep_aspect_mode** **(** :ref:`int<class_int>` mode **)**
@@ -182,9 +206,9 @@ Set the camera projection to orthogonal mode, by specifying a width and the *nea
Set the camera projection to perspective mode, by specifying a *FOV* Y angle in degrees (FOV means Field of View), and the *near* and *far* clip planes in worldspace units.
.. _class_Camera_set_visible_layers:
.. _class_Camera_set_v_offset:
- void **set_visible_layers** **(** :ref:`int<class_int>` mask **)**
- void **set_v_offset** **(** :ref:`float<class_float>` ofs **)**
.. _class_Camera_unproject_position:

View File

@@ -92,6 +92,28 @@ Member Functions
| void | :ref:`set_zoom<class_Camera2D_set_zoom>` **(** :ref:`Vector2<class_vector2>` zoom **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`int<class_int>` **anchor_mode**
- :ref:`bool<class_bool>` **current**
- :ref:`float<class_float>` **drag_margin_bottom**
- :ref:`bool<class_bool>` **drag_margin_h_enabled**
- :ref:`float<class_float>` **drag_margin_left**
- :ref:`float<class_float>` **drag_margin_right**
- :ref:`float<class_float>` **drag_margin_top**
- :ref:`bool<class_bool>` **drag_margin_v_enabled**
- :ref:`int<class_int>` **limit_bottom**
- :ref:`int<class_int>` **limit_left**
- :ref:`int<class_int>` **limit_right**
- :ref:`bool<class_bool>` **limit_smoothed**
- :ref:`int<class_int>` **limit_top**
- :ref:`Vector2<class_vector2>` **offset**
- :ref:`bool<class_bool>` **rotating**
- :ref:`bool<class_bool>` **smoothing_enabled**
- :ref:`float<class_float>` **smoothing_speed**
- :ref:`Vector2<class_vector2>` **zoom**
Numeric Constants
-----------------

View File

@@ -20,119 +20,123 @@ Base class of anything 2D.
Member Functions
----------------
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_draw<class_CanvasItem__draw>` **(** **)** virtual |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`draw_char<class_CanvasItem_draw_char>` **(** :ref:`Font<class_font>` font, :ref:`Vector2<class_vector2>` pos, :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_draw_circle>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`float<class_float>` radius, :ref:`Color<class_color>` color **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_colored_polygon<class_CanvasItem_draw_colored_polygon>` **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`Color<class_color>` color, :ref:`Vector2Array<class_vector2array>` uvs=Vector2Array([]), :ref:`Texture<class_texture>` texture=NULL **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_line<class_CanvasItem_draw_line>` **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to, :ref:`Color<class_color>` color, :ref:`float<class_float>` width=1, :ref:`bool<class_bool>` antialiased=false **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_polygon<class_CanvasItem_draw_polygon>` **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`ColorArray<class_colorarray>` colors, :ref:`Vector2Array<class_vector2array>` uvs=Vector2Array([]), :ref:`Texture<class_texture>` texture=NULL **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_primitive<class_CanvasItem_draw_primitive>` **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`ColorArray<class_colorarray>` colors, :ref:`Vector2Array<class_vector2array>` uvs, :ref:`Texture<class_texture>` texture=NULL, :ref:`float<class_float>` width=1 **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_rect<class_CanvasItem_draw_rect>` **(** :ref:`Rect2<class_rect2>` rect, :ref:`Color<class_color>` color **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_set_transform<class_CanvasItem_draw_set_transform>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`float<class_float>` rot, :ref:`Vector2<class_vector2>` scale **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_set_transform_matrix<class_CanvasItem_draw_set_transform_matrix>` **(** :ref:`Matrix32<class_matrix32>` xform **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_string<class_CanvasItem_draw_string>` **(** :ref:`Font<class_font>` font, :ref:`Vector2<class_vector2>` pos, :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_draw_style_box>` **(** :ref:`StyleBox<class_stylebox>` style_box, :ref:`Rect2<class_rect2>` rect **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_texture<class_CanvasItem_draw_texture>` **(** :ref:`Texture<class_texture>` texture, :ref:`Vector2<class_vector2>` pos, :ref:`Color<class_color>` modulate=Color(1,1,1,1) **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_texture_rect<class_CanvasItem_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 **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_texture_rect_region<class_CanvasItem_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:`Variant<class_variant>` | :ref:`edit_get_state<class_CanvasItem_edit_get_state>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`edit_rotate<class_CanvasItem_edit_rotate>` **(** :ref:`float<class_float>` degrees **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`edit_set_rect<class_CanvasItem_edit_set_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`edit_set_state<class_CanvasItem_edit_set_state>` **(** :ref:`Variant<class_variant>` state **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_blend_mode<class_CanvasItem_get_blend_mode>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_canvas<class_CanvasItem_get_canvas>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_canvas_item<class_CanvasItem_get_canvas_item>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_canvas_transform<class_CanvasItem_get_canvas_transform>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_global_mouse_pos<class_CanvasItem_get_global_mouse_pos>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_global_transform<class_CanvasItem_get_global_transform>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_global_transform_with_canvas<class_CanvasItem_get_global_transform_with_canvas>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_item_and_children_rect<class_CanvasItem_get_item_and_children_rect>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_item_rect<class_CanvasItem_get_item_rect>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_light_mask<class_CanvasItem_get_light_mask>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_local_mouse_pos<class_CanvasItem_get_local_mouse_pos>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`CanvasItemMaterial<class_canvasitemmaterial>` | :ref:`get_material<class_CanvasItem_get_material>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_opacity<class_CanvasItem_get_opacity>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_self_opacity<class_CanvasItem_get_self_opacity>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_transform<class_CanvasItem_get_transform>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_use_parent_material<class_CanvasItem_get_use_parent_material>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_viewport_rect<class_CanvasItem_get_viewport_rect>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_viewport_transform<class_CanvasItem_get_viewport_transform>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_world_2d<class_CanvasItem_get_world_2d>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`hide<class_CanvasItem_hide>` **(** **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_draw_behind_parent_enabled<class_CanvasItem_is_draw_behind_parent_enabled>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_hidden<class_CanvasItem_is_hidden>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_set_as_toplevel<class_CanvasItem_is_set_as_toplevel>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_visible<class_CanvasItem_is_visible>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`make_canvas_pos_local<class_CanvasItem_make_canvas_pos_local>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`InputEvent<class_inputevent>` | :ref:`make_input_local<class_CanvasItem_make_input_local>` **(** :ref:`InputEvent<class_inputevent>` event **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_as_toplevel<class_CanvasItem_set_as_toplevel>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_blend_mode<class_CanvasItem_set_blend_mode>` **(** :ref:`int<class_int>` blend_mode **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_draw_behind_parent<class_CanvasItem_set_draw_behind_parent>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_hidden<class_CanvasItem_set_hidden>` **(** :ref:`bool<class_bool>` hidden **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_light_mask<class_CanvasItem_set_light_mask>` **(** :ref:`int<class_int>` light_mask **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_material<class_CanvasItem_set_material>` **(** :ref:`CanvasItemMaterial<class_canvasitemmaterial>` material **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_opacity<class_CanvasItem_set_opacity>` **(** :ref:`float<class_float>` opacity **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_self_opacity<class_CanvasItem_set_self_opacity>` **(** :ref:`float<class_float>` self_opacity **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_parent_material<class_CanvasItem_set_use_parent_material>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`show<class_CanvasItem_show>` **(** **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update<class_CanvasItem_update>` **(** **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_draw<class_CanvasItem__draw>` **(** **)** virtual |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`draw_char<class_CanvasItem_draw_char>` **(** :ref:`Font<class_font>` font, :ref:`Vector2<class_vector2>` pos, :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_draw_circle>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`float<class_float>` radius, :ref:`Color<class_color>` color **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_colored_polygon<class_CanvasItem_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 **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_line<class_CanvasItem_draw_line>` **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to, :ref:`Color<class_color>` color, :ref:`float<class_float>` width=1, :ref:`bool<class_bool>` antialiased=false **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_polygon<class_CanvasItem_draw_polygon>` **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`PoolVector2Array<class_poolvector2array>` uvs=PoolVector2Array([]), :ref:`Texture<class_texture>` texture=NULL **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_primitive<class_CanvasItem_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 **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_rect<class_CanvasItem_draw_rect>` **(** :ref:`Rect2<class_rect2>` rect, :ref:`Color<class_color>` color **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_set_transform<class_CanvasItem_draw_set_transform>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`float<class_float>` rot, :ref:`Vector2<class_vector2>` scale **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_set_transform_matrix<class_CanvasItem_draw_set_transform_matrix>` **(** :ref:`Transform2D<class_transform2d>` xform **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_string<class_CanvasItem_draw_string>` **(** :ref:`Font<class_font>` font, :ref:`Vector2<class_vector2>` pos, :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_draw_style_box>` **(** :ref:`StyleBox<class_stylebox>` style_box, :ref:`Rect2<class_rect2>` rect **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_texture<class_CanvasItem_draw_texture>` **(** :ref:`Texture<class_texture>` texture, :ref:`Vector2<class_vector2>` pos, :ref:`Color<class_color>` modulate=Color(1,1,1,1) **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_texture_rect<class_CanvasItem_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 **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_texture_rect_region<class_CanvasItem_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:`Variant<class_variant>` | :ref:`edit_get_state<class_CanvasItem_edit_get_state>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`edit_rotate<class_CanvasItem_edit_rotate>` **(** :ref:`float<class_float>` degrees **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`edit_set_rect<class_CanvasItem_edit_set_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`edit_set_state<class_CanvasItem_edit_set_state>` **(** :ref:`Variant<class_variant>` state **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_canvas<class_CanvasItem_get_canvas>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_canvas_item<class_CanvasItem_get_canvas_item>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`get_canvas_transform<class_CanvasItem_get_canvas_transform>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_global_mouse_pos<class_CanvasItem_get_global_mouse_pos>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`get_global_transform<class_CanvasItem_get_global_transform>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`get_global_transform_with_canvas<class_CanvasItem_get_global_transform_with_canvas>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_item_and_children_rect<class_CanvasItem_get_item_and_children_rect>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_item_rect<class_CanvasItem_get_item_rect>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_light_mask<class_CanvasItem_get_light_mask>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_local_mouse_pos<class_CanvasItem_get_local_mouse_pos>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ShaderMaterial<class_shadermaterial>` | :ref:`get_material<class_CanvasItem_get_material>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_modulate<class_CanvasItem_get_modulate>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_self_modulate<class_CanvasItem_get_self_modulate>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`get_transform<class_CanvasItem_get_transform>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_use_parent_material<class_CanvasItem_get_use_parent_material>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_viewport_rect<class_CanvasItem_get_viewport_rect>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`get_viewport_transform<class_CanvasItem_get_viewport_transform>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_world_2d<class_CanvasItem_get_world_2d>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`hide<class_CanvasItem_hide>` **(** **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_draw_behind_parent_enabled<class_CanvasItem_is_draw_behind_parent_enabled>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_local_transform_notification_enabled<class_CanvasItem_is_local_transform_notification_enabled>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_set_as_toplevel<class_CanvasItem_is_set_as_toplevel>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_transform_notification_enabled<class_CanvasItem_is_transform_notification_enabled>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_visible<class_CanvasItem_is_visible>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_visible_in_tree<class_CanvasItem_is_visible_in_tree>` **(** **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`make_canvas_pos_local<class_CanvasItem_make_canvas_pos_local>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`InputEvent<class_inputevent>` | :ref:`make_input_local<class_CanvasItem_make_input_local>` **(** :ref:`InputEvent<class_inputevent>` event **)** const |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_as_toplevel<class_CanvasItem_set_as_toplevel>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_draw_behind_parent<class_CanvasItem_set_draw_behind_parent>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_light_mask<class_CanvasItem_set_light_mask>` **(** :ref:`int<class_int>` light_mask **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_material<class_CanvasItem_set_material>` **(** :ref:`ShaderMaterial<class_shadermaterial>` material **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_modulate<class_CanvasItem_set_modulate>` **(** :ref:`Color<class_color>` modulate **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_notify_local_transform<class_CanvasItem_set_notify_local_transform>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_notify_transform<class_CanvasItem_set_notify_transform>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_self_modulate<class_CanvasItem_set_self_modulate>` **(** :ref:`Color<class_color>` self_modulate **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_parent_material<class_CanvasItem_set_use_parent_material>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_visible<class_CanvasItem_set_visible>` **(** :ref:`bool<class_bool>` arg0 **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`show<class_CanvasItem_show>` **(** **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update<class_CanvasItem_update>` **(** **)** |
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -142,6 +146,18 @@ Signals
- **item_rect_changed** **(** **)**
- **visibility_changed** **(** **)**
Member Variables
----------------
- :ref:`int<class_int>` **light_mask**
- :ref:`ShaderMaterial<class_shadermaterial>` **material**
- :ref:`Color<class_color>` **modulate**
- :ref:`Color<class_color>` **self_modulate**
- :ref:`bool<class_bool>` **show_behind_parent**
- :ref:`bool<class_bool>` **show_on_top**
- :ref:`bool<class_bool>` **use_parent_material**
- :ref:`bool<class_bool>` **visible**
Numeric Constants
-----------------
@@ -192,7 +208,7 @@ Draw a colored circle.
.. _class_CanvasItem_draw_colored_polygon:
- void **draw_colored_polygon** **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`Color<class_color>` color, :ref:`Vector2Array<class_vector2array>` uvs=Vector2Array([]), :ref:`Texture<class_texture>` texture=NULL **)**
- 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 **)**
Draw a colored polygon of any amount of points, convex or concave.
@@ -204,13 +220,13 @@ Draw a line from a 2D point to another, with a given color and width. It can be
.. _class_CanvasItem_draw_polygon:
- void **draw_polygon** **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`ColorArray<class_colorarray>` colors, :ref:`Vector2Array<class_vector2array>` uvs=Vector2Array([]), :ref:`Texture<class_texture>` texture=NULL **)**
- 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 **)**
Draw a polygon of any amount of points, convex or concave.
.. _class_CanvasItem_draw_primitive:
- void **draw_primitive** **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`ColorArray<class_colorarray>` colors, :ref:`Vector2Array<class_vector2array>` uvs, :ref:`Texture<class_texture>` texture=NULL, :ref:`float<class_float>` width=1 **)**
- 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 **)**
Draw a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.
@@ -228,7 +244,7 @@ Set a custom transform for drawing. Anything drawn afterwards will be transforme
.. _class_CanvasItem_draw_set_transform_matrix:
- void **draw_set_transform_matrix** **(** :ref:`Matrix32<class_matrix32>` xform **)**
- void **draw_set_transform_matrix** **(** :ref:`Transform2D<class_transform2d>` xform **)**
.. _class_CanvasItem_draw_string:
@@ -282,12 +298,6 @@ Used for editing, handle rotation.
Set the transform state of this CanvasItem. For :ref:`Node2D<class_node2d>`, this is an :ref:`Array<class_array>` with (in order) a :ref:`Vector2<class_vector2>` for position, a float for rotation and another :ref:`Vector2<class_vector2>` for scale. For :ref:`Control<class_control>` this is a :ref:`Rect2<class_rect2>` with the position and size.
.. _class_CanvasItem_get_blend_mode:
- :ref:`int<class_int>` **get_blend_mode** **(** **)** const
Return the current blending mode from enum BLEND_MODE\_\*.
.. _class_CanvasItem_get_canvas:
- :ref:`RID<class_rid>` **get_canvas** **(** **)** const
@@ -302,7 +312,7 @@ Return the canvas item RID used by :ref:`VisualServer<class_visualserver>` for t
.. _class_CanvasItem_get_canvas_transform:
- :ref:`Matrix32<class_matrix32>` **get_canvas_transform** **(** **)** const
- :ref:`Transform2D<class_transform2d>` **get_canvas_transform** **(** **)** const
Get the transform matrix of this item's canvas.
@@ -314,13 +324,13 @@ Get the global position of the mouse.
.. _class_CanvasItem_get_global_transform:
- :ref:`Matrix32<class_matrix32>` **get_global_transform** **(** **)** const
- :ref:`Transform2D<class_transform2d>` **get_global_transform** **(** **)** const
Get the global transform matrix of this item.
.. _class_CanvasItem_get_global_transform_with_canvas:
- :ref:`Matrix32<class_matrix32>` **get_global_transform_with_canvas** **(** **)** const
- :ref:`Transform2D<class_transform2d>` **get_global_transform_with_canvas** **(** **)** const
Get the global transform matrix of this item in relation to the canvas.
@@ -350,25 +360,25 @@ Get the mouse position relative to this item's position.
.. _class_CanvasItem_get_material:
- :ref:`CanvasItemMaterial<class_canvasitemmaterial>` **get_material** **(** **)** const
- :ref:`ShaderMaterial<class_shadermaterial>` **get_material** **(** **)** const
Get the material of this item.
.. _class_CanvasItem_get_opacity:
.. _class_CanvasItem_get_modulate:
- :ref:`float<class_float>` **get_opacity** **(** **)** const
- :ref:`Color<class_color>` **get_modulate** **(** **)** const
Return the canvas item opacity. This affects the canvas item and all the children.
Get the modulate of the CanvasItem, which affects children items too.
.. _class_CanvasItem_get_self_opacity:
.. _class_CanvasItem_get_self_modulate:
- :ref:`float<class_float>` **get_self_opacity** **(** **)** const
- :ref:`Color<class_color>` **get_self_modulate** **(** **)** const
Return the canvas item self-opacity.
Get the self-modulate of the CanvasItem.
.. _class_CanvasItem_get_transform:
- :ref:`Matrix32<class_matrix32>` **get_transform** **(** **)** const
- :ref:`Transform2D<class_transform2d>` **get_transform** **(** **)** const
Get the transform matrix of this item.
@@ -386,7 +396,7 @@ Get the viewport's boundaries as a :ref:`Rect2<class_rect2>`.
.. _class_CanvasItem_get_viewport_transform:
- :ref:`Matrix32<class_matrix32>` **get_viewport_transform** **(** **)** const
- :ref:`Transform2D<class_transform2d>` **get_viewport_transform** **(** **)** const
Get this item's transform in relation to the viewport.
@@ -408,11 +418,9 @@ Hide the CanvasItem currently visible.
Return whether the item is drawn behind its parent.
.. _class_CanvasItem_is_hidden:
.. _class_CanvasItem_is_local_transform_notification_enabled:
- :ref:`bool<class_bool>` **is_hidden** **(** **)** const
Return true if this CanvasItem is hidden. Note that the CanvasItem may not be visible, but as long as it's not hidden (:ref:`hide<class_CanvasItem_hide>` called) the function will return false.
- :ref:`bool<class_bool>` **is_local_transform_notification_enabled** **(** **)** const
.. _class_CanvasItem_is_set_as_toplevel:
@@ -420,12 +428,20 @@ Return true if this CanvasItem is hidden. Note that the CanvasItem may not be vi
Return if set as toplevel. See :ref:`set_as_toplevel<class_CanvasItem_set_as_toplevel>`.
.. _class_CanvasItem_is_transform_notification_enabled:
- :ref:`bool<class_bool>` **is_transform_notification_enabled** **(** **)** const
.. _class_CanvasItem_is_visible:
- :ref:`bool<class_bool>` **is_visible** **(** **)** const
Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden.
.. _class_CanvasItem_is_visible_in_tree:
- :ref:`bool<class_bool>` **is_visible_in_tree** **(** **)** const
.. _class_CanvasItem_make_canvas_pos_local:
- :ref:`Vector2<class_vector2>` **make_canvas_pos_local** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
@@ -442,24 +458,12 @@ Takes a global input event and convert to this item's coordinate system.
Set as top level. This means that it will not inherit transform from parent canvas items.
.. _class_CanvasItem_set_blend_mode:
- void **set_blend_mode** **(** :ref:`int<class_int>` blend_mode **)**
Set the blending mode from enum BLEND_MODE\_\*.
.. _class_CanvasItem_set_draw_behind_parent:
- void **set_draw_behind_parent** **(** :ref:`bool<class_bool>` enable **)**
Set whether the canvas item is drawn behind its parent.
.. _class_CanvasItem_set_hidden:
- void **set_hidden** **(** :ref:`bool<class_bool>` hidden **)**
Set whether this item should be hidden or not. Note that no matter what is set here this item won't be shown if its parent or grandparents nodes are also hidden. A hidden CanvasItem make all children hidden too.
.. _class_CanvasItem_set_light_mask:
- void **set_light_mask** **(** :ref:`int<class_int>` light_mask **)**
@@ -468,21 +472,29 @@ Set the ligtht mask number of this item.
.. _class_CanvasItem_set_material:
- void **set_material** **(** :ref:`CanvasItemMaterial<class_canvasitemmaterial>` material **)**
- void **set_material** **(** :ref:`ShaderMaterial<class_shadermaterial>` material **)**
Set the material of this item.
.. _class_CanvasItem_set_opacity:
.. _class_CanvasItem_set_modulate:
- void **set_opacity** **(** :ref:`float<class_float>` opacity **)**
- void **set_modulate** **(** :ref:`Color<class_color>` modulate **)**
Set canvas item opacity. This will affect the canvas item and all the children.
Set the modulate of the CanvasItem. This *affects* the modulation of children items.
.. _class_CanvasItem_set_self_opacity:
.. _class_CanvasItem_set_notify_local_transform:
- void **set_self_opacity** **(** :ref:`float<class_float>` self_opacity **)**
- void **set_notify_local_transform** **(** :ref:`bool<class_bool>` enable **)**
Set canvas item self-opacity. This does not affect the opacity of children items.
.. _class_CanvasItem_set_notify_transform:
- void **set_notify_transform** **(** :ref:`bool<class_bool>` enable **)**
.. _class_CanvasItem_set_self_modulate:
- void **set_self_modulate** **(** :ref:`Color<class_color>` self_modulate **)**
Set the self-modulate of the CanvasItem. This does not affect the modulation of children items.
.. _class_CanvasItem_set_use_parent_material:
@@ -490,6 +502,14 @@ Set canvas item self-opacity. This does not affect the opacity of children items
Set whether or not this item should use its parent's material.
.. _class_CanvasItem_set_visible:
- void **set_visible** **(** :ref:`bool<class_bool>` arg0 **)**
Set whether this item should be visible or not.
Note that a hidden CanvasItem will make all children hidden too, so no matter what is set here this item won't be shown if its parent or grandparents nodes are hidden.
.. _class_CanvasItem_show:
- void **show** **(** **)**

View File

@@ -1,69 +0,0 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_CanvasItemMaterial:
CanvasItemMaterial
==================
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Shader<class_shader>` | :ref:`get_shader<class_CanvasItemMaterial_get_shader>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`get_shader_param<class_CanvasItemMaterial_get_shader_param>` **(** :ref:`String<class_string>` param **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_shading_mode<class_CanvasItemMaterial_get_shading_mode>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shader<class_CanvasItemMaterial_set_shader>` **(** :ref:`Shader<class_shader>` shader **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shader_param<class_CanvasItemMaterial_set_shader_param>` **(** :ref:`String<class_string>` param, :ref:`Variant<class_variant>` value **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shading_mode<class_CanvasItemMaterial_set_shading_mode>` **(** :ref:`int<class_int>` mode **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **SHADING_NORMAL** = **0**
- **SHADING_UNSHADED** = **1**
- **SHADING_ONLY_LIGHT** = **2**
Member Function Description
---------------------------
.. _class_CanvasItemMaterial_get_shader:
- :ref:`Shader<class_shader>` **get_shader** **(** **)** const
.. _class_CanvasItemMaterial_get_shader_param:
- void **get_shader_param** **(** :ref:`String<class_string>` param **)** const
.. _class_CanvasItemMaterial_get_shading_mode:
- :ref:`int<class_int>` **get_shading_mode** **(** **)** const
.. _class_CanvasItemMaterial_set_shader:
- void **set_shader** **(** :ref:`Shader<class_shader>` shader **)**
.. _class_CanvasItemMaterial_set_shader_param:
- void **set_shader_param** **(** :ref:`String<class_string>` param, :ref:`Variant<class_variant>` value **)**
.. _class_CanvasItemMaterial_set_shading_mode:
- void **set_shading_mode** **(** :ref:`int<class_int>` mode **)**

View File

@@ -1,17 +0,0 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_CanvasItemShaderGraph:
CanvasItemShaderGraph
=====================
**Inherits:** :ref:`ShaderGraph<class_shadergraph>` **<** :ref:`Shader<class_shader>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------

View File

@@ -20,37 +20,45 @@ Canvas Item layer.
Member Functions
----------------
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`Viewport<class_viewport>` | :ref:`get_custom_viewport<class_CanvasLayer_get_custom_viewport>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_layer<class_CanvasLayer_get_layer>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_CanvasLayer_get_offset>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rotation<class_CanvasLayer_get_rotation>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rotationd<class_CanvasLayer_get_rotationd>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_scale<class_CanvasLayer_get_scale>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_transform<class_CanvasLayer_get_transform>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`World2D<class_world2d>` | :ref:`get_world_2d<class_CanvasLayer_get_world_2d>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_viewport<class_CanvasLayer_set_custom_viewport>` **(** :ref:`Viewport<class_viewport>` viewport **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_layer<class_CanvasLayer_set_layer>` **(** :ref:`int<class_int>` layer **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offset<class_CanvasLayer_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotation<class_CanvasLayer_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotationd<class_CanvasLayer_set_rotationd>` **(** :ref:`float<class_float>` degrees **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_scale<class_CanvasLayer_set_scale>` **(** :ref:`Vector2<class_vector2>` scale **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_transform<class_CanvasLayer_set_transform>` **(** :ref:`Matrix32<class_matrix32>` transform **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`Viewport<class_viewport>` | :ref:`get_custom_viewport<class_CanvasLayer_get_custom_viewport>` **(** **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_layer<class_CanvasLayer_get_layer>` **(** **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_CanvasLayer_get_offset>` **(** **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rotation<class_CanvasLayer_get_rotation>` **(** **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rotationd<class_CanvasLayer_get_rotationd>` **(** **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_scale<class_CanvasLayer_get_scale>` **(** **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`get_transform<class_CanvasLayer_get_transform>` **(** **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`World2D<class_world2d>` | :ref:`get_world_2d<class_CanvasLayer_get_world_2d>` **(** **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_viewport<class_CanvasLayer_set_custom_viewport>` **(** :ref:`Viewport<class_viewport>` viewport **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_layer<class_CanvasLayer_set_layer>` **(** :ref:`int<class_int>` layer **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offset<class_CanvasLayer_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotation<class_CanvasLayer_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotationd<class_CanvasLayer_set_rotationd>` **(** :ref:`float<class_float>` degrees **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_scale<class_CanvasLayer_set_scale>` **(** :ref:`Vector2<class_vector2>` scale **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_transform<class_CanvasLayer_set_transform>` **(** :ref:`Transform2D<class_transform2d>` transform **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`int<class_int>` **layer**
- :ref:`Vector2<class_vector2>` **offset**
- :ref:`float<class_float>` **rotation**
- :ref:`Vector2<class_vector2>` **scale**
Description
-----------
@@ -96,7 +104,7 @@ Return the base scale for this layer (helper).
.. _class_CanvasLayer_get_transform:
- :ref:`Matrix32<class_matrix32>` **get_transform** **(** **)** const
- :ref:`Transform2D<class_transform2d>` **get_transform** **(** **)** const
Return the base transform for this layer.
@@ -142,7 +150,7 @@ Set the base scale for this layer (helper).
.. _class_CanvasLayer_set_transform:
- void **set_transform** **(** :ref:`Matrix32<class_matrix32>` transform **)**
- void **set_transform** **(** :ref:`Transform2D<class_transform2d>` transform **)**
Set the base transform for this layer.

View File

@@ -24,10 +24,15 @@ Member Functions
| void | :ref:`set_color<class_CanvasModulate_set_color>` **(** :ref:`Color<class_color>` color **)** |
+----------------------------+------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`Color<class_color>` **color**
Description
-----------
CanvasModulate tints the canvas elements using its asigned color
CanvasModulate tints the canvas elements using its assigned color
Member Function Description
---------------------------

View File

@@ -28,6 +28,12 @@ Member Functions
| void | :ref:`set_radius<class_CapsuleShape_set_radius>` **(** :ref:`float<class_float>` radius **)** |
+----------------------------+-------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **height**
- :ref:`float<class_float>` **radius**
Description
-----------

View File

@@ -28,6 +28,12 @@ Member Functions
| void | :ref:`set_radius<class_CapsuleShape2D_set_radius>` **(** :ref:`float<class_float>` radius **)** |
+----------------------------+---------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **height**
- :ref:`float<class_float>` **radius**
Description
-----------

View File

@@ -24,6 +24,11 @@ Member Functions
| void | :ref:`set_use_top_left<class_CenterContainer_set_use_top_left>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------+--------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`bool<class_bool>` **use_top_left**
Description
-----------

View File

@@ -24,6 +24,11 @@ Member Functions
| void | :ref:`set_radius<class_CircleShape2D_set_radius>` **(** :ref:`float<class_float>` radius **)** |
+----------------------------+--------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **radius**
Description
-----------

134
classes/class_classdb.rst Normal file
View File

@@ -0,0 +1,134 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_ClassDB:
ClassDB
=======
**Inherits:** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`can_instance<class_ClassDB_can_instance>` **(** :ref:`String<class_string>` class **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`class_exists<class_ClassDB_class_exists>` **(** :ref:`String<class_string>` class **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`class_get_category<class_ClassDB_class_get_category>` **(** :ref:`String<class_string>` class **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`class_get_integer_constant<class_ClassDB_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_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_class_get_method_list>` **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`class_get_property_list<class_ClassDB_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_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_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_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_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_class_has_signal>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_class_list<class_ClassDB_get_class_list>` **(** **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_inheriters_from_class<class_ClassDB_get_inheriters_from_class>` **(** :ref:`String<class_string>` class **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_parent_class<class_ClassDB_get_parent_class>` **(** :ref:`String<class_string>` class **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`instance<class_ClassDB_instance>` **(** :ref:`String<class_string>` class **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_class_enabled<class_ClassDB_is_class_enabled>` **(** :ref:`String<class_string>` class **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_parent_class<class_ClassDB_is_parent_class>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` inherits **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_ClassDB_can_instance:
- :ref:`bool<class_bool>` **can_instance** **(** :ref:`String<class_string>` class **)** const
.. _class_ClassDB_class_exists:
- :ref:`bool<class_bool>` **class_exists** **(** :ref:`String<class_string>` class **)** const
.. _class_ClassDB_class_get_category:
- :ref:`String<class_string>` **class_get_category** **(** :ref:`String<class_string>` class **)** const
.. _class_ClassDB_class_get_integer_constant:
- :ref:`int<class_int>` **class_get_integer_constant** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` name **)** const
.. _class_ClassDB_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
.. _class_ClassDB_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
.. _class_ClassDB_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
.. _class_ClassDB_class_get_signal:
- :ref:`Dictionary<class_dictionary>` **class_get_signal** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** const
.. _class_ClassDB_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
.. _class_ClassDB_class_has_integer_constant:
- :ref:`bool<class_bool>` **class_has_integer_constant** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` name **)** const
.. _class_ClassDB_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
.. _class_ClassDB_class_has_signal:
- :ref:`bool<class_bool>` **class_has_signal** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** const
.. _class_ClassDB_get_class_list:
- :ref:`PoolStringArray<class_poolstringarray>` **get_class_list** **(** **)** const
.. _class_ClassDB_get_inheriters_from_class:
- :ref:`PoolStringArray<class_poolstringarray>` **get_inheriters_from_class** **(** :ref:`String<class_string>` class **)** const
.. _class_ClassDB_get_parent_class:
- :ref:`String<class_string>` **get_parent_class** **(** :ref:`String<class_string>` class **)** const
.. _class_ClassDB_instance:
- :ref:`Variant<class_variant>` **instance** **(** :ref:`String<class_string>` class **)** const
.. _class_ClassDB_is_class_enabled:
- :ref:`bool<class_bool>` **is_class_enabled** **(** :ref:`String<class_string>` class **)** const
.. _class_ClassDB_is_parent_class:
- :ref:`bool<class_bool>` **is_parent_class** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` inherits **)** const

View File

@@ -58,8 +58,14 @@ Signals
-------
- **input_event** **(** :ref:`Object<class_object>` camera, :ref:`InputEvent<class_inputevent>` event, :ref:`Vector3<class_vector3>` click_pos, :ref:`Vector3<class_vector3>` click_normal, :ref:`int<class_int>` shape_idx **)**
- **mouse_enter** **(** **)**
- **mouse_exit** **(** **)**
- **mouse_entered** **(** **)**
- **mouse_exited** **(** **)**
Member Variables
----------------
- :ref:`bool<class_bool>` **input_capture_on_drag**
- :ref:`bool<class_bool>` **input_ray_pickable**
Member Function Description
---------------------------

View File

@@ -20,42 +20,47 @@ Base node for 2D collisionables.
Member Functions
----------------
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_input_event<class_CollisionObject2D__input_event>` **(** :ref:`Object<class_object>` viewport, :ref:`InputEvent<class_inputevent>` event, :ref:`int<class_int>` shape_idx **)** virtual |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_shape<class_CollisionObject2D_add_shape>` **(** :ref:`Shape2D<class_shape2d>` shape, :ref:`Matrix32<class_matrix32>` transform=((1, 0), (0, 1), (0, 0)) **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_shapes<class_CollisionObject2D_clear_shapes>` **(** **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_rid<class_CollisionObject2D_get_rid>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Shape2D<class_shape2d>` | :ref:`get_shape<class_CollisionObject2D_get_shape>` **(** :ref:`int<class_int>` shape_idx **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_shape_count<class_CollisionObject2D_get_shape_count>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_shape_transform<class_CollisionObject2D_get_shape_transform>` **(** :ref:`int<class_int>` shape_idx **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_pickable<class_CollisionObject2D_is_pickable>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_shape_set_as_trigger<class_CollisionObject2D_is_shape_set_as_trigger>` **(** :ref:`int<class_int>` shape_idx **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_shape<class_CollisionObject2D_remove_shape>` **(** :ref:`int<class_int>` shape_idx **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pickable<class_CollisionObject2D_set_pickable>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape<class_CollisionObject2D_set_shape>` **(** :ref:`int<class_int>` shape_idx, :ref:`Shape<class_shape>` shape **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape_as_trigger<class_CollisionObject2D_set_shape_as_trigger>` **(** :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` enable **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape_transform<class_CollisionObject2D_set_shape_transform>` **(** :ref:`int<class_int>` shape_idx, :ref:`Matrix32<class_matrix32>` transform **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_input_event<class_CollisionObject2D__input_event>` **(** :ref:`Object<class_object>` viewport, :ref:`InputEvent<class_inputevent>` event, :ref:`int<class_int>` shape_idx **)** virtual |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_shape<class_CollisionObject2D_add_shape>` **(** :ref:`Shape2D<class_shape2d>` shape, :ref:`Transform2D<class_transform2d>` transform=((1, 0), (0, 1), (0, 0)) **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_shapes<class_CollisionObject2D_clear_shapes>` **(** **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_rid<class_CollisionObject2D_get_rid>` **(** **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Shape2D<class_shape2d>` | :ref:`get_shape<class_CollisionObject2D_get_shape>` **(** :ref:`int<class_int>` shape_idx **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_shape_count<class_CollisionObject2D_get_shape_count>` **(** **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`get_shape_transform<class_CollisionObject2D_get_shape_transform>` **(** :ref:`int<class_int>` shape_idx **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_pickable<class_CollisionObject2D_is_pickable>` **(** **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_shape_set_as_trigger<class_CollisionObject2D_is_shape_set_as_trigger>` **(** :ref:`int<class_int>` shape_idx **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_shape<class_CollisionObject2D_remove_shape>` **(** :ref:`int<class_int>` shape_idx **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pickable<class_CollisionObject2D_set_pickable>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape<class_CollisionObject2D_set_shape>` **(** :ref:`int<class_int>` shape_idx, :ref:`Shape<class_shape>` shape **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape_as_trigger<class_CollisionObject2D_set_shape_as_trigger>` **(** :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape_transform<class_CollisionObject2D_set_shape_transform>` **(** :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_transform2d>` transform **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
- **input_event** **(** :ref:`Object<class_object>` viewport, :ref:`InputEvent<class_inputevent>` event, :ref:`int<class_int>` shape_idx **)**
- **mouse_enter** **(** **)**
- **mouse_exit** **(** **)**
- **mouse_entered** **(** **)**
- **mouse_exited** **(** **)**
Member Variables
----------------
- :ref:`bool<class_bool>` **input_pickable**
Description
-----------
@@ -73,7 +78,7 @@ This method can be used to override normal input processing. The first parameter
.. _class_CollisionObject2D_add_shape:
- void **add_shape** **(** :ref:`Shape2D<class_shape2d>` shape, :ref:`Matrix32<class_matrix32>` transform=((1, 0), (0, 1), (0, 0)) **)**
- void **add_shape** **(** :ref:`Shape2D<class_shape2d>` shape, :ref:`Transform2D<class_transform2d>` transform=((1, 0), (0, 1), (0, 0)) **)**
Add a :ref:`Shape2D<class_shape2d>` to the collision body, with a given custom transform.
@@ -103,7 +108,7 @@ Return the amount of shapes in the collision body. Because a :ref:`CollisionPoly
.. _class_CollisionObject2D_get_shape_transform:
- :ref:`Matrix32<class_matrix32>` **get_shape_transform** **(** :ref:`int<class_int>` shape_idx **)** const
- :ref:`Transform2D<class_transform2d>` **get_shape_transform** **(** :ref:`int<class_int>` shape_idx **)** const
Return the shape transform in the given index.
@@ -145,7 +150,7 @@ Set whether a shape is a trigger. A trigger shape detects collisions, but is oth
.. _class_CollisionObject2D_set_shape_transform:
- void **set_shape_transform** **(** :ref:`int<class_int>` shape_idx, :ref:`Matrix32<class_matrix32>` transform **)**
- void **set_shape_transform** **(** :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_transform2d>` transform **)**
Change the shape transform in the collision body.

View File

@@ -18,23 +18,31 @@ Brief Description
Member Functions
----------------
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_build_mode<class_CollisionPolygon_get_build_mode>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collision_object_first_shape<class_CollisionPolygon_get_collision_object_first_shape>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collision_object_last_shape<class_CollisionPolygon_get_collision_object_last_shape>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_depth<class_CollisionPolygon_get_depth>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`get_polygon<class_CollisionPolygon_get_polygon>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_build_mode<class_CollisionPolygon_set_build_mode>` **(** :ref:`int<class_int>` build_mode **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_depth<class_CollisionPolygon_set_depth>` **(** :ref:`float<class_float>` depth **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_polygon<class_CollisionPolygon_set_polygon>` **(** :ref:`Vector2Array<class_vector2array>` polygon **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_build_mode<class_CollisionPolygon_get_build_mode>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collision_object_first_shape<class_CollisionPolygon_get_collision_object_first_shape>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collision_object_last_shape<class_CollisionPolygon_get_collision_object_last_shape>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_depth<class_CollisionPolygon_get_depth>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_polygon<class_CollisionPolygon_get_polygon>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_build_mode<class_CollisionPolygon_set_build_mode>` **(** :ref:`int<class_int>` build_mode **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_depth<class_CollisionPolygon_set_depth>` **(** :ref:`float<class_float>` depth **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_polygon<class_CollisionPolygon_set_polygon>` **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`int<class_int>` **build_mode**
- :ref:`float<class_float>` **depth**
- :ref:`PoolVector2Array<class_poolvector2array>` **polygon**
- :ref:`Vector2<class_vector2>` **shape_range**
Member Function Description
---------------------------
@@ -57,7 +65,7 @@ Member Function Description
.. _class_CollisionPolygon_get_polygon:
- :ref:`Vector2Array<class_vector2array>` **get_polygon** **(** **)** const
- :ref:`PoolVector2Array<class_poolvector2array>` **get_polygon** **(** **)** const
.. _class_CollisionPolygon_set_build_mode:
@@ -69,6 +77,6 @@ Member Function Description
.. _class_CollisionPolygon_set_polygon:
- void **set_polygon** **(** :ref:`Vector2Array<class_vector2array>` polygon **)**
- void **set_polygon** **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)**

View File

@@ -18,23 +18,31 @@ Editor-only class for easy editing of collision polygons.
Member Functions
----------------
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_build_mode<class_CollisionPolygon2D_get_build_mode>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collision_object_first_shape<class_CollisionPolygon2D_get_collision_object_first_shape>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collision_object_last_shape<class_CollisionPolygon2D_get_collision_object_last_shape>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`get_polygon<class_CollisionPolygon2D_get_polygon>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_trigger<class_CollisionPolygon2D_is_trigger>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_build_mode<class_CollisionPolygon2D_set_build_mode>` **(** :ref:`int<class_int>` build_mode **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_polygon<class_CollisionPolygon2D_set_polygon>` **(** :ref:`Vector2Array<class_vector2array>` polygon **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_trigger<class_CollisionPolygon2D_set_trigger>` **(** :ref:`bool<class_bool>` trigger **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_build_mode<class_CollisionPolygon2D_get_build_mode>` **(** **)** const |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collision_object_first_shape<class_CollisionPolygon2D_get_collision_object_first_shape>` **(** **)** const |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collision_object_last_shape<class_CollisionPolygon2D_get_collision_object_last_shape>` **(** **)** const |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_polygon<class_CollisionPolygon2D_get_polygon>` **(** **)** const |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_trigger<class_CollisionPolygon2D_is_trigger>` **(** **)** const |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_build_mode<class_CollisionPolygon2D_set_build_mode>` **(** :ref:`int<class_int>` build_mode **)** |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_polygon<class_CollisionPolygon2D_set_polygon>` **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)** |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_trigger<class_CollisionPolygon2D_set_trigger>` **(** :ref:`bool<class_bool>` trigger **)** |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`int<class_int>` **build_mode**
- :ref:`PoolVector2Array<class_poolvector2array>` **polygon**
- :ref:`Vector2<class_vector2>` **shape_range**
- :ref:`bool<class_bool>` **trigger**
Description
-----------
@@ -68,7 +76,7 @@ Return the index of the last shape generated by the editor.
.. _class_CollisionPolygon2D_get_polygon:
- :ref:`Vector2Array<class_vector2array>` **get_polygon** **(** **)** const
- :ref:`PoolVector2Array<class_poolvector2array>` **get_polygon** **(** **)** const
Return the list of points that define the polygon.
@@ -86,7 +94,7 @@ Set whether the polygon is to be a :ref:`ConvexPolygonShape2D<class_convexpolygo
.. _class_CollisionPolygon2D_set_polygon:
- void **set_polygon** **(** :ref:`Vector2Array<class_vector2array>` polygon **)**
- void **set_polygon** **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)**
Set the array of points forming the polygon.

View File

@@ -34,6 +34,13 @@ Member Functions
| void | :ref:`set_trigger<class_CollisionShape_set_trigger>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`int<class_int>` **_update_shape_index**
- :ref:`Shape<class_shape>` **shape**
- :ref:`bool<class_bool>` **trigger**
Member Function Description
---------------------------

View File

@@ -30,6 +30,13 @@ Member Functions
| void | :ref:`set_trigger<class_CollisionShape2D_set_trigger>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`int<class_int>` **_update_shape_index**
- :ref:`Shape2D<class_shape2d>` **shape**
- :ref:`bool<class_bool>` **trigger**
Description
-----------

View File

@@ -1,109 +0,0 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_ColorArray:
ColorArray
==========
**Category:** Built-In Types
Brief Description
-----------------
Array of Colors
Member Functions
----------------
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`ColorArray<class_colorarray>` | :ref:`ColorArray<class_ColorArray_ColorArray>` **(** :ref:`Array<class_array>` from **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`append<class_ColorArray_append>` **(** :ref:`Color<class_color>` color **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`append_array<class_ColorArray_append_array>` **(** :ref:`ColorArray<class_colorarray>` array **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`insert<class_ColorArray_insert>` **(** :ref:`int<class_int>` idx, :ref:`Color<class_color>` color **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`invert<class_ColorArray_invert>` **(** **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_back<class_ColorArray_push_back>` **(** :ref:`Color<class_color>` color **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove<class_ColorArray_remove>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`resize<class_ColorArray_resize>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set<class_ColorArray_set>` **(** :ref:`int<class_int>` idx, :ref:`Color<class_color>` color **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size<class_ColorArray_size>` **(** **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+
Description
-----------
Array of Color, can only contains colors. Optimized for memory usage, can't fragment the memory.
Member Function Description
---------------------------
.. _class_ColorArray_ColorArray:
- :ref:`ColorArray<class_colorarray>` **ColorArray** **(** :ref:`Array<class_array>` from **)**
Create from a generic array.
.. _class_ColorArray_append:
- void **append** **(** :ref:`Color<class_color>` color **)**
Append an element at the end of the array (alias of :ref:`push_back<class_ColorArray_push_back>`).
.. _class_ColorArray_append_array:
- void **append_array** **(** :ref:`ColorArray<class_colorarray>` array **)**
Append an :ref:`ColorArray<class_colorarray>` at the end of this array.
.. _class_ColorArray_insert:
- :ref:`int<class_int>` **insert** **(** :ref:`int<class_int>` idx, :ref:`Color<class_color>` color **)**
Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()).
.. _class_ColorArray_invert:
- void **invert** **(** **)**
Reverse the order of the elements in the array (so first element will now be the last).
.. _class_ColorArray_push_back:
- void **push_back** **(** :ref:`Color<class_color>` color **)**
Append a value to the array.
.. _class_ColorArray_remove:
- void **remove** **(** :ref:`int<class_int>` idx **)**
Remove an element from the array by index.
.. _class_ColorArray_resize:
- void **resize** **(** :ref:`int<class_int>` idx **)**
Set the size of the :ref:`ColorArray<class_colorarray>`. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
.. _class_ColorArray_set:
- void **set** **(** :ref:`int<class_int>` idx, :ref:`Color<class_color>` color **)**
Change the :ref:`Color<class_color>` at the given index.
.. _class_ColorArray_size:
- :ref:`int<class_int>` **size** **(** **)**
Return the array size.

View File

@@ -18,21 +18,21 @@ Color picker control.
Member Functions
----------------
+----------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`add_preset<class_ColorPicker_add_preset>` **(** :ref:`Color<class_color>` arg0 **)** |
+----------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_color<class_ColorPicker_get_color>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_editing_alpha<class_ColorPicker_is_editing_alpha>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_raw_mode<class_ColorPicker_is_raw_mode>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_ColorPicker_set_color>` **(** :ref:`Color<class_color>` color **)** |
+----------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`set_edit_alpha<class_ColorPicker_set_edit_alpha>` **(** :ref:`bool<class_bool>` show **)** |
+----------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`set_raw_mode<class_ColorPicker_set_raw_mode>` **(** :ref:`bool<class_bool>` mode **)** |
+----------------------------+----------------------------------------------------------------------------------------------------+
+----------------------------+-------------------------------------------------------------------------------------------------------+
| void | :ref:`add_preset<class_ColorPicker_add_preset>` **(** :ref:`Color<class_color>` arg0 **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_pick_color<class_ColorPicker_get_pick_color>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_editing_alpha<class_ColorPicker_is_editing_alpha>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_raw_mode<class_ColorPicker_is_raw_mode>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------+
| void | :ref:`set_edit_alpha<class_ColorPicker_set_edit_alpha>` **(** :ref:`bool<class_bool>` show **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pick_color<class_ColorPicker_set_pick_color>` **(** :ref:`Color<class_color>` color **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------+
| void | :ref:`set_raw_mode<class_ColorPicker_set_raw_mode>` **(** :ref:`bool<class_bool>` mode **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -53,11 +53,11 @@ Member Function Description
Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker.
.. _class_ColorPicker_get_color:
.. _class_ColorPicker_get_pick_color:
- :ref:`Color<class_color>` **get_color** **(** **)** const
- :ref:`Color<class_color>` **get_pick_color** **(** **)** const
Return the current (edited) color.
Gets the current color.
.. _class_ColorPicker_is_editing_alpha:
@@ -71,18 +71,18 @@ Returns whether the color has transparency or not.
Returns whether this color picker is in raw mode or not, raw mode will allow the color R, G, B component values to go beyond 1, you have to consider that the max value for color components is 1, going beyond that value will not have effect in the color, but can be used for special operations that require it (like tinting without darkening or rendering sprites in HDR).
.. _class_ColorPicker_set_color:
- void **set_color** **(** :ref:`Color<class_color>` color **)**
Select the current color.
.. _class_ColorPicker_set_edit_alpha:
- void **set_edit_alpha** **(** :ref:`bool<class_bool>` show **)**
Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color.
.. _class_ColorPicker_set_pick_color:
- void **set_pick_color** **(** :ref:`Color<class_color>` color **)**
Select the current color.
.. _class_ColorPicker_set_raw_mode:
- void **set_raw_mode** **(** :ref:`bool<class_bool>` mode **)**

View File

@@ -18,23 +18,29 @@ Button that pops out a :ref:`ColorPicker<class_colorpicker>`
Member Functions
----------------
+----------------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_color<class_ColorPickerButton_get_color>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`ColorPicker<class_colorpicker>` | :ref:`get_picker<class_ColorPickerButton_get_picker>` **(** **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_editing_alpha<class_ColorPickerButton_is_editing_alpha>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_ColorPickerButton_set_color>` **(** :ref:`Color<class_color>` color **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------+
| void | :ref:`set_edit_alpha<class_ColorPickerButton_set_edit_alpha>` **(** :ref:`bool<class_bool>` show **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------+
+----------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_pick_color<class_ColorPickerButton_get_pick_color>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`ColorPicker<class_colorpicker>` | :ref:`get_picker<class_ColorPickerButton_get_picker>` **(** **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_editing_alpha<class_ColorPickerButton_is_editing_alpha>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_edit_alpha<class_ColorPickerButton_set_edit_alpha>` **(** :ref:`bool<class_bool>` show **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pick_color<class_ColorPickerButton_set_pick_color>` **(** :ref:`Color<class_color>` color **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------+
Signals
-------
- **color_changed** **(** :ref:`Color<class_color>` color **)**
Member Variables
----------------
- :ref:`Color<class_color>` **color**
- :ref:`bool<class_bool>` **edit_alpha**
Description
-----------
@@ -43,11 +49,9 @@ Encapsulates a :ref:`ColorPicker<class_colorpicker>` making it accesible by pres
Member Function Description
---------------------------
.. _class_ColorPickerButton_get_color:
.. _class_ColorPickerButton_get_pick_color:
- :ref:`Color<class_color>` **get_color** **(** **)** const
Gets the current color
- :ref:`Color<class_color>` **get_pick_color** **(** **)** const
.. _class_ColorPickerButton_get_picker:
@@ -59,16 +63,14 @@ Gets the current color
See :ref:`ColorPicker.is_edit_alpha<class_ColorPicker_is_edit_alpha>`
.. _class_ColorPickerButton_set_color:
- void **set_color** **(** :ref:`Color<class_color>` color **)**
Sets the current color
.. _class_ColorPickerButton_set_edit_alpha:
- void **set_edit_alpha** **(** :ref:`bool<class_bool>` show **)**
See :ref:`ColorPicker.set_edit_alpha<class_ColorPicker_set_edit_alpha>`
.. _class_ColorPickerButton_set_pick_color:
- void **set_pick_color** **(** :ref:`Color<class_color>` color **)**

View File

@@ -18,31 +18,37 @@ Color interpolator node
Member Functions
----------------
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_ColorRamp_add_point>` **(** :ref:`float<class_float>` offset, :ref:`Color<class_color>` color **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_color<class_ColorRamp_get_color>` **(** :ref:`int<class_int>` point **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`ColorArray<class_colorarray>` | :ref:`get_colors<class_ColorRamp_get_colors>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_offset<class_ColorRamp_get_offset>` **(** :ref:`int<class_int>` point **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`RealArray<class_realarray>` | :ref:`get_offsets<class_ColorRamp_get_offsets>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_count<class_ColorRamp_get_point_count>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`interpolate<class_ColorRamp_interpolate>` **(** :ref:`float<class_float>` offset **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_ColorRamp_remove_point>` **(** :ref:`int<class_int>` offset **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_ColorRamp_set_color>` **(** :ref:`int<class_int>` point, :ref:`Color<class_color>` color **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_colors<class_ColorRamp_set_colors>` **(** :ref:`ColorArray<class_colorarray>` colors **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offset<class_ColorRamp_set_offset>` **(** :ref:`int<class_int>` point, :ref:`float<class_float>` offset **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offsets<class_ColorRamp_set_offsets>` **(** :ref:`RealArray<class_realarray>` offsets **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_ColorRamp_add_point>` **(** :ref:`float<class_float>` offset, :ref:`Color<class_color>` color **)** |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_color<class_ColorRamp_get_color>` **(** :ref:`int<class_int>` point **)** const |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolColorArray<class_poolcolorarray>` | :ref:`get_colors<class_ColorRamp_get_colors>` **(** **)** const |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_offset<class_ColorRamp_get_offset>` **(** :ref:`int<class_int>` point **)** const |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolRealArray<class_poolrealarray>` | :ref:`get_offsets<class_ColorRamp_get_offsets>` **(** **)** const |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_count<class_ColorRamp_get_point_count>` **(** **)** const |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`interpolate<class_ColorRamp_interpolate>` **(** :ref:`float<class_float>` offset **)** |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_ColorRamp_remove_point>` **(** :ref:`int<class_int>` offset **)** |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_ColorRamp_set_color>` **(** :ref:`int<class_int>` point, :ref:`Color<class_color>` color **)** |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_colors<class_ColorRamp_set_colors>` **(** :ref:`PoolColorArray<class_poolcolorarray>` colors **)** |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offset<class_ColorRamp_set_offset>` **(** :ref:`int<class_int>` point, :ref:`float<class_float>` offset **)** |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offsets<class_ColorRamp_set_offsets>` **(** :ref:`PoolRealArray<class_poolrealarray>` offsets **)** |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **colors**
- :ref:`float<class_float>` **offsets**
Description
-----------
@@ -66,7 +72,7 @@ Returns the color of the ramp color at index *point*
.. _class_ColorRamp_get_colors:
- :ref:`ColorArray<class_colorarray>` **get_colors** **(** **)** const
- :ref:`PoolColorArray<class_poolcolorarray>` **get_colors** **(** **)** const
Returns the colors in the ramp
@@ -78,7 +84,7 @@ Returns the offset of the ramp color at index *point*
.. _class_ColorRamp_get_offsets:
- :ref:`RealArray<class_realarray>` **get_offsets** **(** **)** const
- :ref:`PoolRealArray<class_poolrealarray>` **get_offsets** **(** **)** const
Returns the offsets for the colors in this ramp
@@ -108,9 +114,9 @@ Sets the color of the ramp color at index *point*
.. _class_ColorRamp_set_colors:
- void **set_colors** **(** :ref:`ColorArray<class_colorarray>` colors **)**
- void **set_colors** **(** :ref:`PoolColorArray<class_poolcolorarray>` colors **)**
Sets the colors for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accomodate the new elements.
Sets the colors for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements.
.. _class_ColorRamp_set_offset:
@@ -120,8 +126,8 @@ Sets the offset for the ramp color at index *point*
.. _class_ColorRamp_set_offsets:
- void **set_offsets** **(** :ref:`RealArray<class_realarray>` offsets **)**
- void **set_offsets** **(** :ref:`PoolRealArray<class_poolrealarray>` offsets **)**
Sets the offset for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accomodate the new elements, all new colors will be black by default.
Sets the offset for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements, all new colors will be black by default.

View File

@@ -1,10 +1,10 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_ColorFrame:
.. _class_ColorRect:
ColorFrame
==========
ColorRect
=========
**Inherits:** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
@@ -18,20 +18,25 @@ Brief Description
Member Functions
----------------
+----------------------------+--------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_frame_color<class_ColorFrame_get_frame_color>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------+
| void | :ref:`set_frame_color<class_ColorFrame_set_frame_color>` **(** :ref:`Color<class_color>` color **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------+
+----------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_frame_color<class_ColorRect_get_frame_color>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------+
| void | :ref:`set_frame_color<class_ColorRect_set_frame_color>` **(** :ref:`Color<class_color>` color **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`Color<class_color>` **color**
Member Function Description
---------------------------
.. _class_ColorFrame_get_frame_color:
.. _class_ColorRect_get_frame_color:
- :ref:`Color<class_color>` **get_frame_color** **(** **)** const
.. _class_ColorFrame_set_frame_color:
.. _class_ColorRect_set_frame_color:
- void **set_frame_color** **(** :ref:`Color<class_color>` color **)**

View File

@@ -18,11 +18,11 @@ Concave polygon shape.
Member Functions
----------------
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`get_faces<class_ConcavePolygonShape_get_faces>` **(** **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_faces<class_ConcavePolygonShape_set_faces>` **(** :ref:`Vector3Array<class_vector3array>` faces **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_faces<class_ConcavePolygonShape_get_faces>` **(** **)** const |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_faces<class_ConcavePolygonShape_set_faces>` **(** :ref:`PoolVector3Array<class_poolvector3array>` faces **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -34,13 +34,13 @@ Member Function Description
.. _class_ConcavePolygonShape_get_faces:
- :ref:`Vector3Array<class_vector3array>` **get_faces** **(** **)** const
- :ref:`PoolVector3Array<class_poolvector3array>` **get_faces** **(** **)** const
Return the faces (an array of triangles).
.. _class_ConcavePolygonShape_set_faces:
- void **set_faces** **(** :ref:`Vector3Array<class_vector3array>` faces **)**
- void **set_faces** **(** :ref:`PoolVector3Array<class_poolvector3array>` faces **)**
Set the faces (an array of triangles).

View File

@@ -18,11 +18,16 @@ Concave polygon 2D shape resource for physics.
Member Functions
----------------
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`get_segments<class_ConcavePolygonShape2D_get_segments>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_segments<class_ConcavePolygonShape2D_set_segments>` **(** :ref:`Vector2Array<class_vector2array>` segments **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_segments<class_ConcavePolygonShape2D_get_segments>` **(** **)** const |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_segments<class_ConcavePolygonShape2D_set_segments>` **(** :ref:`PoolVector2Array<class_poolvector2array>` segments **)** |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`PoolVector2Array<class_poolvector2array>` **segments**
Description
-----------
@@ -36,13 +41,13 @@ Member Function Description
.. _class_ConcavePolygonShape2D_get_segments:
- :ref:`Vector2Array<class_vector2array>` **get_segments** **(** **)** const
- :ref:`PoolVector2Array<class_poolvector2array>` **get_segments** **(** **)** const
Return the array of segments.
.. _class_ConcavePolygonShape2D_set_segments:
- void **set_segments** **(** :ref:`Vector2Array<class_vector2array>` segments **)**
- void **set_segments** **(** :ref:`PoolVector2Array<class_poolvector2array>` segments **)**
Set the array of segments.

View File

@@ -24,6 +24,15 @@ Member Functions
| void | :ref:`set_param<class_ConeTwistJoint_set_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **bias**
- :ref:`float<class_float>` **relaxation**
- :ref:`float<class_float>` **softness**
- :ref:`float<class_float>` **swing_span**
- :ref:`float<class_float>` **twist_span**
Numeric Constants
-----------------

View File

@@ -18,23 +18,25 @@ Helper class to handle INI-style files.
Member Functions
----------------
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_section_keys<class_ConfigFile_get_section_keys>` **(** :ref:`String<class_string>` section **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_sections<class_ConfigFile_get_sections>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_value<class_ConfigFile_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_has_section>` **(** :ref:`String<class_string>` section **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_section_key<class_ConfigFile_has_section_key>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`load<class_ConfigFile_load>` **(** :ref:`String<class_string>` path **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`save<class_ConfigFile_save>` **(** :ref:`String<class_string>` path **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_value<class_ConfigFile_set_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, :ref:`Variant<class_variant>` value **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_section<class_ConfigFile_erase_section>` **(** :ref:`String<class_string>` section **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_section_keys<class_ConfigFile_get_section_keys>` **(** :ref:`String<class_string>` section **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_sections<class_ConfigFile_get_sections>` **(** **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_value<class_ConfigFile_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_has_section>` **(** :ref:`String<class_string>` section **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_section_key<class_ConfigFile_has_section_key>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`load<class_ConfigFile_load>` **(** :ref:`String<class_string>` path **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`save<class_ConfigFile_save>` **(** :ref:`String<class_string>` path **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_value<class_ConfigFile_set_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, :ref:`Variant<class_variant>` value **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -59,15 +61,19 @@ The following example shows how to parse a INI-style file from the system, read
Member Function Description
---------------------------
.. _class_ConfigFile_erase_section:
- void **erase_section** **(** :ref:`String<class_string>` section **)**
.. _class_ConfigFile_get_section_keys:
- :ref:`StringArray<class_stringarray>` **get_section_keys** **(** :ref:`String<class_string>` section **)** const
- :ref:`PoolStringArray<class_poolstringarray>` **get_section_keys** **(** :ref:`String<class_string>` section **)** const
Return an array of all defined key identifiers in the specified section.
.. _class_ConfigFile_get_sections:
- :ref:`StringArray<class_stringarray>` **get_sections** **(** **)** const
- :ref:`PoolStringArray<class_poolstringarray>` **get_sections** **(** **)** const
Return an array of all defined section identifiers.

View File

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

View File

@@ -8,7 +8,7 @@ Control
**Inherits:** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Inherited By:** :ref:`Label<class_label>`, :ref:`Tabs<class_tabs>`, :ref:`TextureFrame<class_textureframe>`, :ref:`ButtonArray<class_buttonarray>`, :ref:`VideoPlayer<class_videoplayer>`, :ref:`LineEdit<class_lineedit>`, :ref:`ColorFrame<class_colorframe>`, :ref:`Container<class_container>`, :ref:`ReferenceFrame<class_referenceframe>`, :ref:`Patch9Frame<class_patch9frame>`, :ref:`TextEdit<class_textedit>`, :ref:`BaseButton<class_basebutton>`, :ref:`Popup<class_popup>`, :ref:`Tree<class_tree>`, :ref:`Separator<class_separator>`, :ref:`Panel<class_panel>`, :ref:`TabContainer<class_tabcontainer>`, :ref:`Range<class_range>`, :ref:`RichTextLabel<class_richtextlabel>`, :ref:`GraphEdit<class_graphedit>`, :ref:`ItemList<class_itemlist>`
**Inherited By:** :ref:`TextureRect<class_texturerect>`, :ref:`ColorRect<class_colorrect>`, :ref:`Label<class_label>`, :ref:`Tabs<class_tabs>`, :ref:`ButtonArray<class_buttonarray>`, :ref:`GraphEdit<class_graphedit>`, :ref:`VideoPlayer<class_videoplayer>`, :ref:`NinePatchRect<class_ninepatchrect>`, :ref:`LineEdit<class_lineedit>`, :ref:`Container<class_container>`, :ref:`TextEdit<class_textedit>`, :ref:`BaseButton<class_basebutton>`, :ref:`Popup<class_popup>`, :ref:`Tree<class_tree>`, :ref:`Separator<class_separator>`, :ref:`ReferenceRect<class_referencerect>`, :ref:`Panel<class_panel>`, :ref:`TabContainer<class_tabcontainer>`, :ref:`Range<class_range>`, :ref:`RichTextLabel<class_richtextlabel>`, :ref:`ItemList<class_itemlist>`
**Category:** Core
@@ -21,7 +21,9 @@ Member Functions
----------------
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_input_event<class_Control__input_event>` **(** :ref:`InputEvent<class_inputevent>` event **)** virtual |
| :ref:`Vector2<class_vector2>` | :ref:`_get_minimum_size<class_Control__get_minimum_size>` **(** **)** virtual |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_gui_input<class_Control__gui_input>` **(** :ref:`InputEvent<class_inputevent>` event **)** virtual |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`accept_event<class_Control_accept_event>` **(** **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -83,7 +85,7 @@ Member Functions
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_minimum_size<class_Control_get_minimum_size>` **(** **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_minimum_size<class_Control_get_minimum_size>` **(** **)** virtual |
| :ref:`int<class_int>` | :ref:`get_mouse_filter<class_Control_get_mouse_filter>` **(** **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_parent_area_size<class_Control_get_parent_area_size>` **(** **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -133,13 +135,13 @@ Member Functions
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_icon_override<class_Control_has_icon_override>` **(** :ref:`String<class_string>` name **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`has_point<class_Control_has_point>` **(** :ref:`Vector2<class_vector2>` point **)** virtual |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_stylebox<class_Control_has_stylebox>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_stylebox_override<class_Control_has_stylebox_override>` **(** :ref:`String<class_string>` name **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_ignoring_mouse<class_Control_is_ignoring_mouse>` **(** **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_stopping_mouse<class_Control_is_stopping_mouse>` **(** **)** const |
| :ref:`bool<class_bool>` | :ref:`is_clipping_contents<class_Control_is_clipping_contents>` **(** **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`minimum_size_changed<class_Control_minimum_size_changed>` **(** **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -153,6 +155,8 @@ Member Functions
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_begin<class_Control_set_begin>` **(** :ref:`Vector2<class_vector2>` pos **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_clip_contents<class_Control_set_clip_contents>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_minimum_size<class_Control_set_custom_minimum_size>` **(** :ref:`Vector2<class_vector2>` size **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_default_cursor_shape<class_Control_set_default_cursor_shape>` **(** :ref:`int<class_int>` shape **)** |
@@ -171,10 +175,10 @@ Member Functions
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_h_size_flags<class_Control_set_h_size_flags>` **(** :ref:`int<class_int>` flags **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ignore_mouse<class_Control_set_ignore_mouse>` **(** :ref:`bool<class_bool>` ignore **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_margin<class_Control_set_margin>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` offset **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mouse_filter<class_Control_set_mouse_filter>` **(** :ref:`int<class_int>` filter **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pos<class_Control_set_pos>` **(** :ref:`Vector2<class_vector2>` pos **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotation<class_Control_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
@@ -185,8 +189,6 @@ Member Functions
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_size<class_Control_set_size>` **(** :ref:`Vector2<class_vector2>` size **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_stop_mouse<class_Control_set_stop_mouse>` **(** :ref:`bool<class_bool>` stop **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_stretch_ratio<class_Control_set_stretch_ratio>` **(** :ref:`float<class_float>` ratio **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_theme<class_Control_set_theme>` **(** :ref:`Theme<class_theme>` theme **)** |
@@ -203,23 +205,50 @@ Member Functions
Signals
-------
- **focus_enter** **(** **)**
- **focus_exit** **(** **)**
- **input_event** **(** :ref:`InputEvent<class_inputevent>` ev **)**
- **focus_entered** **(** **)**
- **focus_exited** **(** **)**
- **gui_input** **(** :ref:`InputEvent<class_inputevent>` ev **)**
- **minimum_size_changed** **(** **)**
- **modal_close** **(** **)**
- **mouse_enter** **(** **)**
- **mouse_exit** **(** **)**
- **modal_closed** **(** **)**
- **mouse_entered** **(** **)**
- **mouse_exited** **(** **)**
- **resized** **(** **)**
- **size_flags_changed** **(** **)**
Member Variables
----------------
- :ref:`int<class_int>` **anchor_bottom**
- :ref:`int<class_int>` **anchor_left**
- :ref:`int<class_int>` **anchor_right**
- :ref:`int<class_int>` **anchor_top**
- :ref:`NodePath<class_nodepath>` **focus_neighbour_bottom**
- :ref:`NodePath<class_nodepath>` **focus_neighbour_left**
- :ref:`NodePath<class_nodepath>` **focus_neighbour_right**
- :ref:`NodePath<class_nodepath>` **focus_neighbour_top**
- :ref:`String<class_string>` **hint_tooltip**
- :ref:`int<class_int>` **margin_bottom**
- :ref:`int<class_int>` **margin_left**
- :ref:`int<class_int>` **margin_right**
- :ref:`int<class_int>` **margin_top**
- :ref:`int<class_int>` **mouse_filter**
- :ref:`bool<class_bool>` **rect_clip_content**
- :ref:`Vector2<class_vector2>` **rect_min_size**
- :ref:`Vector2<class_vector2>` **rect_pos**
- :ref:`float<class_float>` **rect_rotation**
- :ref:`Vector2<class_vector2>` **rect_scale**
- :ref:`Vector2<class_vector2>` **rect_size**
- :ref:`int<class_int>` **size_flags_horizontal**
- :ref:`int<class_int>` **size_flags_stretch_ratio**
- :ref:`int<class_int>` **size_flags_vertical**
- :ref:`Theme<class_theme>` **theme**
Numeric Constants
-----------------
- **ANCHOR_BEGIN** = **0** --- X is relative to MARGIN_LEFT, Y is relative to MARGIN_TOP.
- **ANCHOR_END** = **1** --- X is relative to -MARGIN_RIGHT, Y is relative to -MARGIN_BOTTOM.
- **ANCHOR_RATIO** = **2** --- X and Y are a ratio (0 to 1) relative to the parent size 0 is left/top, 1 is right/bottom.
- **ANCHOR_CENTER** = **3**
- **ANCHOR_CENTER** = **2**
- **FOCUS_NONE** = **0** --- Control can't acquire focus.
- **FOCUS_CLICK** = **1** --- Control can acquire focus only if clicked.
- **FOCUS_ALL** = **2** --- Control can acquire focus if clicked, or by pressing TAB/Directionals in the keyboard from another Control.
@@ -247,9 +276,12 @@ Numeric Constants
- **CURSOR_VSPLIT** = **14**
- **CURSOR_HSPLIT** = **15**
- **CURSOR_HELP** = **16**
- **SIZE_EXPAND** = **1**
- **SIZE_FILL** = **2**
- **SIZE_EXPAND** = **2**
- **SIZE_FILL** = **1**
- **SIZE_EXPAND_FILL** = **3**
- **MOUSE_FILTER_STOP** = **0**
- **MOUSE_FILTER_PASS** = **1**
- **MOUSE_FILTER_IGNORE** = **2**
Description
-----------
@@ -271,9 +303,15 @@ Finally, controls are skinned according to a :ref:`Theme<class_theme>`. Setting
Member Function Description
---------------------------
.. _class_Control__input_event:
.. _class_Control__get_minimum_size:
- void **_input_event** **(** :ref:`InputEvent<class_inputevent>` event **)** virtual
- :ref:`Vector2<class_vector2>` **_get_minimum_size** **(** **)** virtual
Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size.
.. _class_Control__gui_input:
- void **_gui_input** **(** :ref:`InputEvent<class_inputevent>` event **)** virtual
Called when an input event reaches the control.
@@ -431,11 +469,11 @@ Return a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RI
Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size.
.. _class_Control_get_minimum_size:
.. _class_Control_get_mouse_filter:
- :ref:`Vector2<class_vector2>` **get_minimum_size** **(** **)** virtual
- :ref:`int<class_int>` **get_mouse_filter** **(** **)** const
Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size.
Return when the control is ignoring mouse events (even touchpad events send mouse events).
.. _class_Control_get_parent_area_size:
@@ -551,6 +589,10 @@ Return whether the Control is the current focused control (see :ref:`set_focus_m
- :ref:`bool<class_bool>` **has_icon_override** **(** :ref:`String<class_string>` name **)** const
.. _class_Control_has_point:
- void **has_point** **(** :ref:`Vector2<class_vector2>` point **)** virtual
.. _class_Control_has_stylebox:
- :ref:`bool<class_bool>` **has_stylebox** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const
@@ -559,15 +601,9 @@ Return whether the Control is the current focused control (see :ref:`set_focus_m
- :ref:`bool<class_bool>` **has_stylebox_override** **(** :ref:`String<class_string>` name **)** const
.. _class_Control_is_ignoring_mouse:
.. _class_Control_is_clipping_contents:
- :ref:`bool<class_bool>` **is_ignoring_mouse** **(** **)** const
Return if the control is ignoring mouse events (even touchpad events send mouse events).
.. _class_Control_is_stopping_mouse:
- :ref:`bool<class_bool>` **is_stopping_mouse** **(** **)** const
- :ref:`bool<class_bool>` **is_clipping_contents** **(** **)**
.. _class_Control_minimum_size_changed:
@@ -605,6 +641,10 @@ Change all margins and anchors, so this Control always takes up the same area as
Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see :ref:`set_margin<class_Control_set_margin>`).
.. _class_Control_set_clip_contents:
- void **set_clip_contents** **(** :ref:`bool<class_bool>` enable **)**
.. _class_Control_set_custom_minimum_size:
- void **set_custom_minimum_size** **(** :ref:`Vector2<class_vector2>` size **)**
@@ -653,18 +693,18 @@ Move the Control to a new position, relative to the top-left corner of the *wind
Hint for containers, set horizontal positioning flags.
.. _class_Control_set_ignore_mouse:
- void **set_ignore_mouse** **(** :ref:`bool<class_bool>` ignore **)**
Ignore mouse events on this control (even touchpad events send mouse events).
.. _class_Control_set_margin:
- void **set_margin** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` offset **)**
Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being set depends on the anchor mode.
.. _class_Control_set_mouse_filter:
- void **set_mouse_filter** **(** :ref:`int<class_int>` filter **)**
Set when the control is ignoring mouse events (even touchpad events send mouse events). (see the MOUSE_FILTER\_\* constants)
.. _class_Control_set_pos:
- void **set_pos** **(** :ref:`Vector2<class_vector2>` pos **)**
@@ -689,10 +729,6 @@ Move the Control to a new position, relative to the top-left corner of the paren
Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see :ref:`set_margin<class_Control_set_margin>`).
.. _class_Control_set_stop_mouse:
- void **set_stop_mouse** **(** :ref:`bool<class_bool>` stop **)**
.. _class_Control_set_stretch_ratio:
- void **set_stretch_ratio** **(** :ref:`float<class_float>` ratio **)**

View File

@@ -18,11 +18,16 @@ Convex Polygon Shape.
Member Functions
----------------
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`get_points<class_ConvexPolygonShape_get_points>` **(** **)** const |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_points<class_ConvexPolygonShape_set_points>` **(** :ref:`Vector3Array<class_vector3array>` points **)** |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_points<class_ConvexPolygonShape_get_points>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_points<class_ConvexPolygonShape_set_points>` **(** :ref:`PoolVector3Array<class_poolvector3array>` points **)** |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`Array<class_array>` **points**
Description
-----------
@@ -34,10 +39,10 @@ Member Function Description
.. _class_ConvexPolygonShape_get_points:
- :ref:`Vector3Array<class_vector3array>` **get_points** **(** **)** const
- :ref:`PoolVector3Array<class_poolvector3array>` **get_points** **(** **)** const
.. _class_ConvexPolygonShape_set_points:
- void **set_points** **(** :ref:`Vector3Array<class_vector3array>` points **)**
- void **set_points** **(** :ref:`PoolVector3Array<class_poolvector3array>` points **)**

View File

@@ -18,13 +18,18 @@ Convex Polygon Shape for 2D physics.
Member Functions
----------------
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`get_points<class_ConvexPolygonShape2D_get_points>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_cloud<class_ConvexPolygonShape2D_set_point_cloud>` **(** :ref:`Vector2Array<class_vector2array>` point_cloud **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_points<class_ConvexPolygonShape2D_set_points>` **(** :ref:`Vector2Array<class_vector2array>` points **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_points<class_ConvexPolygonShape2D_get_points>` **(** **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_cloud<class_ConvexPolygonShape2D_set_point_cloud>` **(** :ref:`PoolVector2Array<class_poolvector2array>` point_cloud **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_points<class_ConvexPolygonShape2D_set_points>` **(** :ref:`PoolVector2Array<class_poolvector2array>` points **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`PoolVector2Array<class_poolvector2array>` **points**
Description
-----------
@@ -38,19 +43,19 @@ Member Function Description
.. _class_ConvexPolygonShape2D_get_points:
- :ref:`Vector2Array<class_vector2array>` **get_points** **(** **)** const
- :ref:`PoolVector2Array<class_poolvector2array>` **get_points** **(** **)** const
Return a list of points in either clockwise or counter clockwise order, forming a convex polygon.
.. _class_ConvexPolygonShape2D_set_point_cloud:
- void **set_point_cloud** **(** :ref:`Vector2Array<class_vector2array>` point_cloud **)**
- void **set_point_cloud** **(** :ref:`PoolVector2Array<class_poolvector2array>` point_cloud **)**
Currently, this method does nothing.
.. _class_ConvexPolygonShape2D_set_points:
- void **set_points** **(** :ref:`Vector2Array<class_vector2array>` points **)**
- void **set_points** **(** :ref:`PoolVector2Array<class_poolvector2array>` points **)**
Set a list of points in either clockwise or counter clockwise order, forming a convex polygon.

View File

@@ -25,8 +25,6 @@ Member Functions
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_lossy_storage_quality<class_CubeMap_get_lossy_storage_quality>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_rid<class_CubeMap_get_rid>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_image>` | :ref:`get_side<class_CubeMap_get_side>` **(** :ref:`int<class_int>` side **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_storage<class_CubeMap_get_storage>` **(** **)** const |
@@ -74,10 +72,6 @@ Member Function Description
- :ref:`float<class_float>` **get_lossy_storage_quality** **(** **)** const
.. _class_CubeMap_get_rid:
- :ref:`RID<class_rid>` **get_rid** **(** **)** const
.. _class_CubeMap_get_side:
- :ref:`Image<class_image>` **get_side** **(** :ref:`int<class_int>` side **)** const

View File

@@ -18,41 +18,49 @@ Describes a Bezier curve in 2D space.
Member Functions
----------------
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_Curve2D_add_point>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`Vector2<class_vector2>` in=Vector2(0, 0), :ref:`Vector2<class_vector2>` out=Vector2(0, 0), :ref:`int<class_int>` atpos=-1 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bake_interval<class_Curve2D_get_bake_interval>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_baked_length<class_Curve2D_get_baked_length>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`get_baked_points<class_Curve2D_get_baked_points>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_count<class_Curve2D_get_point_count>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_in<class_Curve2D_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_out<class_Curve2D_get_point_out>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_pos<class_Curve2D_get_point_pos>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`interpolate<class_Curve2D_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`interpolate_baked<class_Curve2D_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`interpolatef<class_Curve2D_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_Curve2D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bake_interval<class_Curve2D_set_bake_interval>` **(** :ref:`float<class_float>` distance **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_in<class_Curve2D_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_out<class_Curve2D_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_pos<class_Curve2D_set_point_pos>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`tesselate<class_Curve2D_tesselate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_Curve2D_add_point>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`Vector2<class_vector2>` in=Vector2(0, 0), :ref:`Vector2<class_vector2>` out=Vector2(0, 0), :ref:`int<class_int>` atpos=-1 **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_points<class_Curve2D_clear_points>` **(** **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bake_interval<class_Curve2D_get_bake_interval>` **(** **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_baked_length<class_Curve2D_get_baked_length>` **(** **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_baked_points<class_Curve2D_get_baked_points>` **(** **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_count<class_Curve2D_get_point_count>` **(** **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_in<class_Curve2D_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_out<class_Curve2D_get_point_out>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_pos<class_Curve2D_get_point_pos>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`interpolate<class_Curve2D_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`interpolate_baked<class_Curve2D_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`interpolatef<class_Curve2D_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_Curve2D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bake_interval<class_Curve2D_set_bake_interval>` **(** :ref:`float<class_float>` distance **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_in<class_Curve2D_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_out<class_Curve2D_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_pos<class_Curve2D_set_point_pos>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`tesselate<class_Curve2D_tesselate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`int<class_int>` **_data**
- :ref:`float<class_float>` **bake_interval**
Description
-----------
@@ -72,6 +80,10 @@ Adds a point to a curve, at position "pos", with control points "in" and "out".
If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= :ref:`get_point_count<class_Curve2D_get_point_count>`), the point will be appended at the end of the point list.
.. _class_Curve2D_clear_points:
- void **clear_points** **(** **)**
.. _class_Curve2D_get_bake_interval:
- :ref:`float<class_float>` **get_bake_interval** **(** **)** const
@@ -86,9 +98,9 @@ Returns the total length of the curve, based on the cached points. Given enough
.. _class_Curve2D_get_baked_points:
- :ref:`Vector2Array<class_vector2array>` **get_baked_points** **(** **)** const
- :ref:`PoolVector2Array<class_poolvector2array>` **get_baked_points** **(** **)** const
Returns the cache of points as a :ref:`Vector2Array<class_vector2array>`.
Returns the cache of points as a :ref:`PoolVector2Array<class_poolvector2array>`.
.. _class_Curve2D_get_point_count:
@@ -170,7 +182,7 @@ Sets the position for the vertex "idx". If the index is out of bounds, the funct
.. _class_Curve2D_tesselate:
- :ref:`Vector2Array<class_vector2array>` **tesselate** **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const
- :ref:`PoolVector2Array<class_poolvector2array>` **tesselate** **(** :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.

View File

@@ -18,47 +18,55 @@ Describes a Bezier curve in 3D space.
Member Functions
----------------
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_Curve3D_add_point>` **(** :ref:`Vector3<class_vector3>` pos, :ref:`Vector3<class_vector3>` in=Vector3(0, 0, 0), :ref:`Vector3<class_vector3>` out=Vector3(0, 0, 0), :ref:`int<class_int>` atpos=-1 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bake_interval<class_Curve3D_get_bake_interval>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_baked_length<class_Curve3D_get_baked_length>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`get_baked_points<class_Curve3D_get_baked_points>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RealArray<class_realarray>` | :ref:`get_baked_tilts<class_Curve3D_get_baked_tilts>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_count<class_Curve3D_get_point_count>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_in<class_Curve3D_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_out<class_Curve3D_get_point_out>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_pos<class_Curve3D_get_point_pos>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_point_tilt<class_Curve3D_get_point_tilt>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolate<class_Curve3D_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolate_baked<class_Curve3D_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolatef<class_Curve3D_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_Curve3D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bake_interval<class_Curve3D_set_bake_interval>` **(** :ref:`float<class_float>` distance **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_in<class_Curve3D_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_out<class_Curve3D_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_pos<class_Curve3D_set_point_pos>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_tilt<class_Curve3D_set_point_tilt>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` tilt **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`tesselate<class_Curve3D_tesselate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_Curve3D_add_point>` **(** :ref:`Vector3<class_vector3>` pos, :ref:`Vector3<class_vector3>` in=Vector3(0, 0, 0), :ref:`Vector3<class_vector3>` out=Vector3(0, 0, 0), :ref:`int<class_int>` atpos=-1 **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_points<class_Curve3D_clear_points>` **(** **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bake_interval<class_Curve3D_get_bake_interval>` **(** **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_baked_length<class_Curve3D_get_baked_length>` **(** **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_baked_points<class_Curve3D_get_baked_points>` **(** **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolRealArray<class_poolrealarray>` | :ref:`get_baked_tilts<class_Curve3D_get_baked_tilts>` **(** **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_count<class_Curve3D_get_point_count>` **(** **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_in<class_Curve3D_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_out<class_Curve3D_get_point_out>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_pos<class_Curve3D_get_point_pos>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_point_tilt<class_Curve3D_get_point_tilt>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolate<class_Curve3D_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolate_baked<class_Curve3D_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolatef<class_Curve3D_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_Curve3D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bake_interval<class_Curve3D_set_bake_interval>` **(** :ref:`float<class_float>` distance **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_in<class_Curve3D_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_out<class_Curve3D_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_pos<class_Curve3D_set_point_pos>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_tilt<class_Curve3D_set_point_tilt>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` tilt **)** |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`tesselate<class_Curve3D_tesselate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`int<class_int>` **_data**
- :ref:`float<class_float>` **bake_interval**
Description
-----------
@@ -78,6 +86,10 @@ Adds a point to a curve, at position "pos", with control points "in" and "out".
If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= :ref:`get_point_count<class_Curve3D_get_point_count>`), the point will be appended at the end of the point list.
.. _class_Curve3D_clear_points:
- void **clear_points** **(** **)**
.. _class_Curve3D_get_bake_interval:
- :ref:`float<class_float>` **get_bake_interval** **(** **)** const
@@ -92,13 +104,13 @@ Returns the total length of the curve, based on the cached points. Given enough
.. _class_Curve3D_get_baked_points:
- :ref:`Vector3Array<class_vector3array>` **get_baked_points** **(** **)** const
- :ref:`PoolVector3Array<class_poolvector3array>` **get_baked_points** **(** **)** const
Returns the cache of points as a :ref:`Vector3Array<class_vector3array>`.
Returns the cache of points as a :ref:`PoolVector3Array<class_poolvector3array>`.
.. _class_Curve3D_get_baked_tilts:
- :ref:`RealArray<class_realarray>` **get_baked_tilts** **(** **)** const
- :ref:`PoolRealArray<class_poolrealarray>` **get_baked_tilts** **(** **)** const
Returns the cache of tilts as a :ref:`RealArray<class_realarray>`.
@@ -196,7 +208,7 @@ The tilt controls the rotation along the look-at axis an object traveling the pa
.. _class_Curve3D_tesselate:
- :ref:`Vector3Array<class_vector3array>` **tesselate** **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const
- :ref:`PoolVector3Array<class_poolvector3array>` **tesselate** **(** :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.

View File

@@ -0,0 +1,76 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_CurveTexture:
CurveTexture
============
**Inherits:** :ref:`Texture<class_texture>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_max<class_CurveTexture_get_max>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_min<class_CurveTexture_get_min>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_points<class_CurveTexture_get_points>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_max<class_CurveTexture_set_max>` **(** :ref:`float<class_float>` max **)** |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_min<class_CurveTexture_set_min>` **(** :ref:`float<class_float>` min **)** |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_points<class_CurveTexture_set_points>` **(** :ref:`PoolVector2Array<class_poolvector2array>` points **)** |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_width<class_CurveTexture_set_width>` **(** :ref:`int<class_int>` width **)** |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **max**
- :ref:`float<class_float>` **min**
- :ref:`PoolVector2Array<class_poolvector2array>` **points**
- :ref:`int<class_int>` **width**
Member Function Description
---------------------------
.. _class_CurveTexture_get_max:
- :ref:`float<class_float>` **get_max** **(** **)** const
.. _class_CurveTexture_get_min:
- :ref:`float<class_float>` **get_min** **(** **)** const
.. _class_CurveTexture_get_points:
- :ref:`PoolVector2Array<class_poolvector2array>` **get_points** **(** **)** const
.. _class_CurveTexture_set_max:
- void **set_max** **(** :ref:`float<class_float>` max **)**
.. _class_CurveTexture_set_min:
- void **set_min** **(** :ref:`float<class_float>` min **)**
.. _class_CurveTexture_set_points:
- void **set_points** **(** :ref:`PoolVector2Array<class_poolvector2array>` points **)**
.. _class_CurveTexture_set_width:
- void **set_width** **(** :ref:`int<class_int>` width **)**

View File

@@ -36,6 +36,14 @@ Member Functions
| void | :ref:`set_stiffness<class_DampedSpringJoint2D_set_stiffness>` **(** :ref:`float<class_float>` stiffness **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **damping**
- :ref:`float<class_float>` **length**
- :ref:`float<class_float>` **rest_length**
- :ref:`float<class_float>` **stiffness**
Description
-----------

View File

@@ -16,29 +16,25 @@ Dictionary type.
Member Functions
----------------
+------------------------------+-----------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_Dictionary_clear>` **(** **)** |
+------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`empty<class_Dictionary_empty>` **(** **)** |
+------------------------------+-----------------------------------------------------------------------------------------------+
| void | :ref:`erase<class_Dictionary_erase>` **(** var key **)** |
+------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has<class_Dictionary_has>` **(** var key **)** |
+------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_all<class_Dictionary_has_all>` **(** :ref:`Array<class_array>` keys **)** |
+------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`hash<class_Dictionary_hash>` **(** **)** |
+------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`keys<class_Dictionary_keys>` **(** **)** |
+------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`parse_json<class_Dictionary_parse_json>` **(** :ref:`String<class_string>` json **)** |
+------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size<class_Dictionary_size>` **(** **)** |
+------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`to_json<class_Dictionary_to_json>` **(** **)** |
+------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`values<class_Dictionary_values>` **(** **)** |
+------------------------------+-----------------------------------------------------------------------------------------------+
+----------------------------+---------------------------------------------------------------------------------------+
| void | :ref:`clear<class_Dictionary_clear>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`empty<class_Dictionary_empty>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------+
| void | :ref:`erase<class_Dictionary_erase>` **(** var key **)** |
+----------------------------+---------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has<class_Dictionary_has>` **(** var key **)** |
+----------------------------+---------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_all<class_Dictionary_has_all>` **(** :ref:`Array<class_array>` keys **)** |
+----------------------------+---------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`hash<class_Dictionary_hash>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`keys<class_Dictionary_keys>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size<class_Dictionary_size>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`values<class_Dictionary_values>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------+
Description
-----------
@@ -90,24 +86,12 @@ Return a hashed integer value representing the dictionary contents.
Return the list of keys in the :ref:`Dictionary<class_dictionary>`.
.. _class_Dictionary_parse_json:
- :ref:`int<class_int>` **parse_json** **(** :ref:`String<class_string>` json **)**
Parse json text to the dictionary. Return OK when successed or the error code when failed.
.. _class_Dictionary_size:
- :ref:`int<class_int>` **size** **(** **)**
Return the size of the dictionary (in pairs).
.. _class_Dictionary_to_json:
- :ref:`String<class_string>` **to_json** **(** **)**
Return the dictionary as json text.
.. _class_Dictionary_values:
- :ref:`Array<class_array>` **values** **(** **)**

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