diff --git a/classes/class_spatialsound2dserversw.rst b/classes/class_@dlscript.rst similarity index 52% rename from classes/class_spatialsound2dserversw.rst rename to classes/class_@dlscript.rst index c7eae8a51..deea81995 100644 --- a/classes/class_spatialsound2dserversw.rst +++ b/classes/class_@dlscript.rst @@ -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` **<** :ref:`Object` +@DLScript +========= **Category:** Core diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 9e0b9452b..275a5c091 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -19,6 +19,8 @@ Member Functions +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`Color8` **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8 **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`ColorN` **(** :ref:`String` name, :ref:`float` alpha **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`abs` **(** :ref:`float` s **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`acos` **(** :ref:`float` s **)** | @@ -31,10 +33,12 @@ Member Functions +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`atan2` **(** :ref:`float` x, :ref:`float` y **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`bytes2var` **(** :ref:`RawArray` bytes **)** | +| :ref:`Variant` | :ref:`bytes2var` **(** :ref:`PoolByteArray` bytes **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`ceil` **(** :ref:`float` s **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`char` **(** :ref:`int` ascii **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`clamp` **(** :ref:`float` val, :ref:`float` min, :ref:`float` max **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`convert` **(** :ref:`Variant` what, :ref:`int` type **)** | @@ -89,6 +93,8 @@ Member Functions +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`nearest_po2` **(** :ref:`int` val **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`parse_json` **(** :ref:`String` json **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`pow` **(** :ref:`float` x, :ref:`float` y **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Resource` | :ref:`preload` **(** :ref:`String` path **)** | @@ -141,11 +147,15 @@ Member Functions +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`tanh` **(** :ref:`float` s **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`to_json` **(** :ref:`Variant` var:Variant **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`type_exists` **(** :ref:`String` type **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`typeof` **(** :ref:`Variant` what **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`var2bytes` **(** :ref:`Variant` var **)** | +| :ref:`Variant` | :ref:`validate_json` **(** :ref:`String` json **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`var2bytes` **(** :ref:`Variant` var **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`var2str` **(** :ref:`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` **ColorN** **(** :ref:`String` name, :ref:`float` alpha **)** + .. _class_@GDScript_abs: - :ref:`float` **abs** **(** :ref:`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` **bytes2var** **(** :ref:`RawArray` bytes **)** +- :ref:`Variant` **bytes2var** **(** :ref:`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` **char** **(** :ref:`int` ascii **)** + .. _class_@GDScript_clamp: - :ref:`float` **clamp** **(** :ref:`float` val, :ref:`float` min, :ref:`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` **parse_json** **(** :ref:`String` json **)** + +Parse json text to a Variant (use :ref:`typeof` to check if it is what you expect). + .. _class_@GDScript_pow: - :ref:`float` **pow** **(** :ref:`float` x, :ref:`float` y **)** @@ -437,31 +463,31 @@ Convert from radians to degrees. - :ref:`float` **rand_range** **(** :ref:`float` from, :ref:`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` **rand_seed** **(** :ref:`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` **randf** **(** **)** -Random value (0 to 1 float). +Return a random floating point value between 0 and 1. .. _class_@GDScript_randi: - :ref:`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` **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` **to_json** **(** :ref:`Variant` var:Variant **)** + +Convert a Variant to json text. + .. _class_@GDScript_type_exists: - :ref:`bool` **type_exists** **(** :ref:`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_@GDScript_validate_json: + +- :ref:`Variant` **validate_json** **(** :ref:`String` json **)** + .. _class_@GDScript_var2bytes: -- :ref:`RawArray` **var2bytes** **(** :ref:`Variant` var **)** +- :ref:`PoolByteArray` **var2bytes** **(** :ref:`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` 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. diff --git a/classes/class_@global scope.rst b/classes/class_@global scope.rst index 9dffc0c90..d9144b774 100644 --- a/classes/class_@global scope.rst +++ b/classes/class_@global scope.rst @@ -16,30 +16,22 @@ Global scope constants and variables. Member Variables ---------------- -- :ref:`AudioServer` **AS** - [AudioServer] singleton - :ref:`AudioServer` **AudioServer** - [AudioServer] singleton +- :ref:`ClassDB` **ClassDB** +- :ref:`Engine` **Engine** - :ref:`Geometry` **Geometry** - [Geometry] singleton -- :ref:`Globals` **Globals** - [Globals] singleton +- :ref:`GlobalConfig` **GlobalConfig** - :ref:`IP` **IP** - [IP] singleton - :ref:`Input` **Input** - [Input] singleton - :ref:`InputMap` **InputMap** - [InputMap] singleton - :ref:`Reference` **Marshalls** - [Marshalls] singleton - :ref:`OS` **OS** - [OS] singleton -- :ref:`PhysicsServer` **PS** - [PhysicsServer] singleton -- :ref:`Physics2DServer` **PS2D** - [Physics2DServer] singleton -- :ref:`PathRemap` **PathRemap** - [PathRemap] singleton - :ref:`Performance` **Performance** - [Performance] singleton - :ref:`Physics2DServer` **Physics2DServer** - [Physics2DServer] singleton - :ref:`PhysicsServer` **PhysicsServer** - [PhysicsServer] singleton - :ref:`ResourceLoader` **ResourceLoader** - [ResourceLoader] singleton - :ref:`ResourceSaver` **ResourceSaver** - [ResourceSaver] singleton -- :ref:`SpatialSoundServer` **SS** - [SpatialSoundServer] singleton -- :ref:`SpatialSound2DServer` **SS2D** - [SpatialSound2DServer] singleton -- :ref:`SpatialSound2DServer` **SpatialSound2DServer** - [SpatialSound2DServer] singleton -- :ref:`SpatialSoundServer` **SpatialSoundServer** - [SpatialSoundServer] singleton -- :ref:`TranslationServer` **TS** - [TranslationServer] singleton - :ref:`TranslationServer` **TranslationServer** - [TranslationServer] singleton -- :ref:`VisualServer` **VS** - [VisualServer] singleton - :ref:`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`. - **TYPE_RECT2** = **6** --- Variable is of type :ref:`Rect2`. - **TYPE_VECTOR3** = **7** --- Variable is of type :ref:`Vector3`. -- **TYPE_MATRIX32** = **8** --- Variable is of type :ref:`Matrix32`. +- **TYPE_TRANSFORM2D** = **8** --- Variable is of type :ref:`Transform2D`. - **TYPE_PLANE** = **9** --- Variable is of type :ref:`Plane`. - **TYPE_QUAT** = **10** --- Variable is of type :ref:`Quat`. -- **TYPE_AABB** = **11** --- Variable is of type :ref:`AABB`. -- **TYPE_MATRIX3** = **12** --- Variable is of type :ref:`Matrix3`. +- **TYPE_RECT3** = **11** --- Variable is of type :ref:`Rect3`. +- **TYPE_BASIS** = **12** --- Variable is of type :ref:`Basis`. - **TYPE_TRANSFORM** = **13** --- Variable is of type :ref:`Transform`. - **TYPE_COLOR** = **14** --- Variable is of type :ref:`Color`. - **TYPE_IMAGE** = **15** --- Variable is of type :ref:`Image`. diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst deleted file mode 100644 index 06f8e7f92..000000000 --- a/classes/class_aabb.rst +++ /dev/null @@ -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` | :ref:`AABB` **(** :ref:`Vector3` pos, :ref:`Vector3` size **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`encloses` **(** :ref:`AABB` with **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`expand` **(** :ref:`Vector3` to_point **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_area` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_endpoint` **(** :ref:`int` idx **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_longest_axis` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_longest_axis_index` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_longest_axis_size` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_shortest_axis` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shortest_axis_index` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_shortest_axis_size` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_support` **(** :ref:`Vector3` dir **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`grow` **(** :ref:`float` by **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_no_area` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_no_surface` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`intersection` **(** :ref:`AABB` with **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects` **(** :ref:`AABB` with **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects_plane` **(** :ref:`Plane` plane **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects_segment` **(** :ref:`Vector3` from, :ref:`Vector3` to **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`merge` **(** :ref:`AABB` with **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - -Member Variables ----------------- - -- :ref:`Vector3` **end** - Ending corner. -- :ref:`Vector3` **pos** - Position (starting corner). -- :ref:`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` **AABB** **(** :ref:`Vector3` pos, :ref:`Vector3` size **)** - -Optional constructor, accepts position and size. - -.. _class_AABB_encloses: - -- :ref:`bool` **encloses** **(** :ref:`AABB` with **)** - -Return true if this :ref:`AABB` completely encloses another one. - -.. _class_AABB_expand: - -- :ref:`AABB` **expand** **(** :ref:`Vector3` to_point **)** - -Return this :ref:`AABB` expanded to include a given point. - -.. _class_AABB_get_area: - -- :ref:`float` **get_area** **(** **)** - -Get the area of the :ref:`AABB`. - -.. _class_AABB_get_endpoint: - -- :ref:`Vector3` **get_endpoint** **(** :ref:`int` idx **)** - -Get the position of the 8 endpoints of the :ref:`AABB` in space. - -.. _class_AABB_get_longest_axis: - -- :ref:`Vector3` **get_longest_axis** **(** **)** - -Return the normalized longest axis of the :ref:`AABB`. - -.. _class_AABB_get_longest_axis_index: - -- :ref:`int` **get_longest_axis_index** **(** **)** - -Return the index of the longest axis of the :ref:`AABB` (according to :ref:`Vector3`::AXIS\* enum). - -.. _class_AABB_get_longest_axis_size: - -- :ref:`float` **get_longest_axis_size** **(** **)** - -Return the scalar length of the longest axis of the :ref:`AABB`. - -.. _class_AABB_get_shortest_axis: - -- :ref:`Vector3` **get_shortest_axis** **(** **)** - -Return the normalized shortest axis of the :ref:`AABB`. - -.. _class_AABB_get_shortest_axis_index: - -- :ref:`int` **get_shortest_axis_index** **(** **)** - -Return the index of the shortest axis of the :ref:`AABB` (according to :ref:`Vector3`::AXIS\* enum). - -.. _class_AABB_get_shortest_axis_size: - -- :ref:`float` **get_shortest_axis_size** **(** **)** - -Return the scalar length of the shortest axis of the :ref:`AABB`. - -.. _class_AABB_get_support: - -- :ref:`Vector3` **get_support** **(** :ref:`Vector3` dir **)** - -Return the support point in a given direction. This is useful for collision detection algorithms. - -.. _class_AABB_grow: - -- :ref:`AABB` **grow** **(** :ref:`float` by **)** - -Return a copy of the :ref:`AABB` grown a given amount of units towards all the sides. - -.. _class_AABB_has_no_area: - -- :ref:`bool` **has_no_area** **(** **)** - -Return true if the :ref:`AABB` is flat or empty. - -.. _class_AABB_has_no_surface: - -- :ref:`bool` **has_no_surface** **(** **)** - -Return true if the :ref:`AABB` is empty. - -.. _class_AABB_has_point: - -- :ref:`bool` **has_point** **(** :ref:`Vector3` point **)** - -Return true if the :ref:`AABB` contains a point. - -.. _class_AABB_intersection: - -- :ref:`AABB` **intersection** **(** :ref:`AABB` with **)** - -Return the intersection between two :ref:`AABB`. An empty AABB (size 0,0,0) is returned on failure. - -.. _class_AABB_intersects: - -- :ref:`bool` **intersects** **(** :ref:`AABB` with **)** - -Return true if the :ref:`AABB` overlaps with another. - -.. _class_AABB_intersects_plane: - -- :ref:`bool` **intersects_plane** **(** :ref:`Plane` plane **)** - -Return true if the :ref:`AABB` is at both sides of a plane. - -.. _class_AABB_intersects_segment: - -- :ref:`bool` **intersects_segment** **(** :ref:`Vector3` from, :ref:`Vector3` to **)** - -Return true if the :ref:`AABB` intersects the line segment between from and to - -.. _class_AABB_merge: - -- :ref:`AABB` **merge** **(** :ref:`AABB` with **)** - -Combine this :ref:`AABB` with another, a larger one is returned that contains both. - - diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 78d69ed43..653c05d03 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -35,8 +35,6 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`LineEdit` | :ref:`register_text_enter` **(** :ref:`Object` line_edit **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_child_rect` **(** :ref:`Control` child **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_hide_on_ok` **(** :ref:`bool` enabled **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_text` **(** :ref:`String` text **)** | @@ -48,6 +46,12 @@ Signals - **confirmed** **(** **)** - **custom_action** **(** :ref:`String` action **)** +Member Variables +---------------- + +- :ref:`bool` **dialog_hide_on_ok** +- :ref:`String` **dialog_text** + Description ----------- @@ -100,10 +104,6 @@ Return the built-in label text. Register a :ref:`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` child **)** - .. _class_AcceptDialog_set_hide_on_ok: - void **set_hide_on_ok** **(** :ref:`bool` enabled **)** diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index f6aa260e4..2637ec4e5 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -23,8 +23,6 @@ Member Functions +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_frame` **(** **)** const | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_modulate` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_offset` **(** **)** const | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`SpriteFrames` | :ref:`get_sprite_frames` **(** **)** const | @@ -49,8 +47,6 @@ Member Functions +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_frame` **(** :ref:`int` frame **)** | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_modulate` **(** :ref:`Color` modulate **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_sprite_frames` **(** :ref:`SpriteFrames` sprite_frames **)** | @@ -61,8 +57,20 @@ Member Functions Signals ------- +- **animation_finished** **(** **)** - **frame_changed** **(** **)** -- **finished** **(** **)** + +Member Variables +---------------- + +- :ref:`String` **animation** +- :ref:`bool` **centered** +- :ref:`bool` **flip_h** +- :ref:`bool` **flip_v** +- :ref:`int` **frame** +- :ref:`SpriteFrames` **frames** +- :ref:`Vector2` **offset** +- :ref:`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` **get_modulate** **(** **)** const - -Return the color modulation for this sprite. - .. _class_AnimatedSprite_get_offset: - :ref:`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` resource). -.. _class_AnimatedSprite_set_modulate: - -- void **set_modulate** **(** :ref:`Color` modulate **)** - -Change the color modulation (multiplication) for this sprite. - .. _class_AnimatedSprite_set_offset: - void **set_offset** **(** :ref:`Vector2` offset **)** diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index 7e4106da1..a705c0341 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -43,6 +43,14 @@ Signals - **frame_changed** **(** **)** +Member Variables +---------------- + +- :ref:`String` **animation** +- :ref:`int` **frame** +- :ref:`SpriteFrames` **frames** +- :ref:`bool` **playing** + Member Function Description --------------------------- diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 6e6ca7c89..2de586966 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -18,83 +18,87 @@ Contains data used to animate everything in the engine. Member Functions ---------------- -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_track` **(** :ref:`int` type, :ref:`int` at_pos=-1 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_track` **(** :ref:`NodePath` path **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_length` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_step` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_track_count` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_loop` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`IntArray` | :ref:`method_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`method_track_get_name` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`method_track_get_params` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_track` **(** :ref:`int` idx **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_length` **(** :ref:`float` time_sec **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop` **(** :ref:`bool` enabled **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_step` **(** :ref:`float` size_sec **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_find_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=false **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_get_interpolation_type` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_get_key_count` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`track_get_key_time` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`track_get_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_get_key_value` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`track_get_path` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_get_type` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`track_is_imported` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_move_down` **(** :ref:`int` idx **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_move_up` **(** :ref:`int` idx **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_remove_key` **(** :ref:`int` idx, :ref:`int` key_idx **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_remove_key_at_pos` **(** :ref:`int` idx, :ref:`float` pos **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_imported` **(** :ref:`int` idx, :ref:`bool` imported **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_interpolation_type` **(** :ref:`int` idx, :ref:`int` interpolation **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` transition **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_key_value` **(** :ref:`int` idx, :ref:`int` key, :ref:`Variant` value **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_path` **(** :ref:`int` idx, :ref:`NodePath` path **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`transform_track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` loc, :ref:`Quat` rot, :ref:`Vector3` scale **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`transform_track_interpolate` **(** :ref:`int` idx, :ref:`float` time_sec **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`IntArray` | :ref:`value_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`value_track_get_update_mode` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`value_track_set_update_mode` **(** :ref:`int` idx, :ref:`int` mode **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_track` **(** :ref:`int` type, :ref:`int` at_pos=-1 **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_track` **(** :ref:`NodePath` path **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_length` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_step` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_track_count` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_loop` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`method_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`method_track_get_name` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`method_track_get_params` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_track` **(** :ref:`int` idx **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_length` **(** :ref:`float` time_sec **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_loop` **(** :ref:`bool` enabled **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_step` **(** :ref:`float` size_sec **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`track_find_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=false **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`track_get_interpolation_loop_wrap` **(** :ref:`int` idx **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`track_get_interpolation_type` **(** :ref:`int` idx **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`track_get_key_count` **(** :ref:`int` idx **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`track_get_key_time` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`track_get_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_get_key_value` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`track_get_path` **(** :ref:`int` idx **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`track_get_type` **(** :ref:`int` idx **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`track_is_imported` **(** :ref:`int` idx **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_move_down` **(** :ref:`int` idx **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_move_up` **(** :ref:`int` idx **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_remove_key` **(** :ref:`int` idx, :ref:`int` key_idx **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_remove_key_at_pos` **(** :ref:`int` idx, :ref:`float` pos **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_imported` **(** :ref:`int` idx, :ref:`bool` imported **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_interpolation_loop_wrap` **(** :ref:`int` idx, :ref:`bool` interpolation **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_interpolation_type` **(** :ref:`int` idx, :ref:`int` interpolation **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` transition **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_key_value` **(** :ref:`int` idx, :ref:`int` key, :ref:`Variant` value **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_path` **(** :ref:`int` idx, :ref:`NodePath` path **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`transform_track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` loc, :ref:`Quat` rot, :ref:`Vector3` scale **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`transform_track_interpolate` **(** :ref:`int` idx, :ref:`float` time_sec **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`value_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`value_track_get_update_mode` **(** :ref:`int` idx **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`value_track_set_update_mode` **(** :ref:`int` idx, :ref:`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` **method_track_get_key_indices** **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const +- :ref:`PoolIntArray` **method_track_get_key_indices** **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`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` **track_get_interpolation_loop_wrap** **(** :ref:`int` idx **)** const + .. _class_Animation_track_get_interpolation_type: - :ref:`int` **track_get_interpolation_type** **(** :ref:`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` idx, :ref:`bool` interpolation **)** + .. _class_Animation_track_set_interpolation_type: - void **track_set_interpolation_type** **(** :ref:`int` idx, :ref:`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` **value_track_get_key_indices** **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const +- :ref:`PoolIntArray` **value_track_get_key_indices** **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const Return all the key indices of a value track, given a position and delta time. diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 8ef211cf0..9eb443aba 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -18,90 +18,97 @@ Container and player of :ref:`Animation` resources. Member Functions ---------------- -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_animation` **(** :ref:`String` name, :ref:`Animation` animation **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`advance` **(** :ref:`float` delta **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`animation_get_next` **(** :ref:`String` anim_from **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_set_next` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_caches` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_queue` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`find_animation` **(** :ref:`Animation` animation **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Animation` | :ref:`get_animation` **(** :ref:`String` name **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_animation_list` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_animation_process_mode` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_autoplay` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_animation` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_current_animation_length` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_current_animation_pos` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_default_blend_time` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pos` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_root` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_speed` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` name **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1, :ref:`bool` from_end=false **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play_backwards` **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue` **(** :ref:`String` name **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_animation` **(** :ref:`String` name **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_animation` **(** :ref:`String` name, :ref:`String` newname **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` pos_sec, :ref:`bool` update=false **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` active **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_process_mode` **(** :ref:`int` mode **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autoplay` **(** :ref:`String` name **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to, :ref:`float` sec **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_animation` **(** :ref:`String` anim **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_blend_time` **(** :ref:`float` sec **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_root` **(** :ref:`NodePath` path **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_speed` **(** :ref:`float` speed **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** :ref:`bool` reset=true **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop_all` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_animation` **(** :ref:`String` name, :ref:`Animation` animation **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`advance` **(** :ref:`float` delta **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`animation_get_next` **(** :ref:`String` anim_from **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`animation_set_next` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_caches` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_queue` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`find_animation` **(** :ref:`Animation` animation **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Animation` | :ref:`get_animation` **(** :ref:`String` name **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_animation_list` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_animation_process_mode` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_autoplay` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_animation` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_current_animation_length` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_current_animation_pos` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_default_blend_time` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pos` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_root` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_speed_scale` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` name **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_active` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1, :ref:`bool` from_end=false **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play_backwards` **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue` **(** :ref:`String` name **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_animation` **(** :ref:`String` name **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_animation` **(** :ref:`String` name, :ref:`String` newname **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` pos_sec, :ref:`bool` update=false **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` active **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation_process_mode` **(** :ref:`int` mode **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_autoplay` **(** :ref:`String` name **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to, :ref:`float` sec **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_animation` **(** :ref:`String` anim **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_blend_time` **(** :ref:`float` sec **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_root` **(** :ref:`NodePath` path **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_speed_scale` **(** :ref:`float` speed **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** :ref:`bool` reset=true **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop_all` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **animation_changed** **(** :ref:`String` old_name, :ref:`String` new_name **)** +- **animation_finished** **(** :ref:`String` name **)** - **animation_started** **(** :ref:`String` name **)** -- **finished** **(** **)** + +Member Variables +---------------- + +- :ref:`float` **playback_default_blend_time** +- :ref:`int` **playback_process_mode** +- :ref:`NodePath` **root_node** Numeric Constants ----------------- @@ -163,7 +170,7 @@ Get an :ref:`Animation` resource by requesting a name. .. _class_AnimationPlayer_get_animation_list: -- :ref:`StringArray` **get_animation_list** **(** **)** const +- :ref:`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_get_speed: +.. _class_AnimationPlayer_get_speed_scale: -- :ref:`float` **get_speed** **(** **)** const +- :ref:`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` speed **)** +- void **set_speed_scale** **(** :ref:`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). diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst index a5c54b46b..21c813380 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -18,135 +18,140 @@ Animation Player that uses a node graph for the blending. Member Functions ---------------- -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`int` type, :ref:`String` id **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`advance` **(** :ref:`float` delta **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Animation` | :ref:`animation_node_get_animation` **(** :ref:`String` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`animation_node_get_master_animation` **(** :ref:`String` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_node_set_animation` **(** :ref:`String` id, :ref:`Animation` animation **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_node_set_master_animation` **(** :ref:`String` id, :ref:`String` source **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`blend2_node_get_amount` **(** :ref:`String` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend2_node_set_amount` **(** :ref:`String` id, :ref:`float` blend **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend2_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`blend3_node_get_amount` **(** :ref:`String` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend3_node_set_amount` **(** :ref:`String` id, :ref:`float` blend **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`blend4_node_get_amount` **(** :ref:`String` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend4_node_set_amount` **(** :ref:`String` id, :ref:`Vector2` blend **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`connect` **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect` **(** :ref:`String` id, :ref:`int` dst_input_idx **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_animation_process_mode` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_master_player` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_node_list` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`mix_node_get_amount` **(** :ref:`String` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mix_node_set_amount` **(** :ref:`String` id, :ref:`float` ratio **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`node_exists` **(** :ref:`String` node **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`node_get_input_count` **(** :ref:`String` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`node_get_input_source` **(** :ref:`String` id, :ref:`int` idx **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`node_get_pos` **(** :ref:`String` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`node_get_type` **(** :ref:`String` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`node_rename` **(** :ref:`String` node, :ref:`String` new_name **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`node_set_pos` **(** :ref:`String` id, :ref:`Vector2` screen_pos **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_autorestart_delay` **(** :ref:`String` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_autorestart_random_delay` **(** :ref:`String` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_fadein_time` **(** :ref:`String` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_fadeout_time` **(** :ref:`String` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`oneshot_node_has_autorestart` **(** :ref:`String` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`oneshot_node_is_active` **(** :ref:`String` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_autorestart` **(** :ref:`String` id, :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_autorestart_delay` **(** :ref:`String` id, :ref:`float` delay_sec **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_autorestart_random_delay` **(** :ref:`String` id, :ref:`float` rand_sec **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_fadein_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_fadeout_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_start` **(** :ref:`String` id **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_stop` **(** :ref:`String` id **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`recompute_caches` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`String` id **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reset` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` enabled **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_process_mode` **(** :ref:`int` mode **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_path` **(** :ref:`NodePath` path **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_master_player` **(** :ref:`NodePath` nodepath **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`timescale_node_get_scale` **(** :ref:`String` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`timescale_node_set_scale` **(** :ref:`String` id, :ref:`float` scale **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`timeseek_node_seek` **(** :ref:`String` id, :ref:`float` pos_sec **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_delete_input` **(** :ref:`String` id, :ref:`int` input_idx **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`transition_node_get_current` **(** :ref:`String` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`transition_node_get_input_count` **(** :ref:`String` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`transition_node_get_xfade_time` **(** :ref:`String` id **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`transition_node_has_input_auto_advance` **(** :ref:`String` id, :ref:`int` input_idx **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_current` **(** :ref:`String` id, :ref:`int` input_idx **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_input_auto_advance` **(** :ref:`String` id, :ref:`int` input_idx, :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_input_count` **(** :ref:`String` id, :ref:`int` count **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_xfade_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_node` **(** :ref:`int` type, :ref:`String` id **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`advance` **(** :ref:`float` delta **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Animation` | :ref:`animation_node_get_animation` **(** :ref:`String` id **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`animation_node_get_master_animation` **(** :ref:`String` id **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`animation_node_set_animation` **(** :ref:`String` id, :ref:`Animation` animation **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`animation_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`animation_node_set_master_animation` **(** :ref:`String` id, :ref:`String` source **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_nodes_connected` **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`blend2_node_get_amount` **(** :ref:`String` id **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend2_node_set_amount` **(** :ref:`String` id, :ref:`float` blend **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend2_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`blend3_node_get_amount` **(** :ref:`String` id **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend3_node_set_amount` **(** :ref:`String` id, :ref:`float` blend **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`blend4_node_get_amount` **(** :ref:`String` id **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend4_node_set_amount` **(** :ref:`String` id, :ref:`Vector2` blend **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`connect_nodes` **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_nodes` **(** :ref:`String` id, :ref:`int` dst_input_idx **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_animation_process_mode` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_master_player` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_node_list` **(** **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_active` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`mix_node_get_amount` **(** :ref:`String` id **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mix_node_set_amount` **(** :ref:`String` id, :ref:`float` ratio **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`node_exists` **(** :ref:`String` node **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`node_get_input_count` **(** :ref:`String` id **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`node_get_input_source` **(** :ref:`String` id, :ref:`int` idx **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`node_get_pos` **(** :ref:`String` id **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`node_get_type` **(** :ref:`String` id **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`node_rename` **(** :ref:`String` node, :ref:`String` new_name **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`node_set_pos` **(** :ref:`String` id, :ref:`Vector2` screen_pos **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`oneshot_node_get_autorestart_delay` **(** :ref:`String` id **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`oneshot_node_get_autorestart_random_delay` **(** :ref:`String` id **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`oneshot_node_get_fadein_time` **(** :ref:`String` id **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`oneshot_node_get_fadeout_time` **(** :ref:`String` id **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`oneshot_node_has_autorestart` **(** :ref:`String` id **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`oneshot_node_is_active` **(** :ref:`String` id **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_set_autorestart` **(** :ref:`String` id, :ref:`bool` enable **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_set_autorestart_delay` **(** :ref:`String` id, :ref:`float` delay_sec **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_set_autorestart_random_delay` **(** :ref:`String` id, :ref:`float` rand_sec **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_set_fadein_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_set_fadeout_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_start` **(** :ref:`String` id **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_stop` **(** :ref:`String` id **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`recompute_caches` **(** **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_node` **(** :ref:`String` id **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reset` **(** **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation_process_mode` **(** :ref:`int` mode **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_path` **(** :ref:`NodePath` path **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_master_player` **(** :ref:`NodePath` nodepath **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`timescale_node_get_scale` **(** :ref:`String` id **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`timescale_node_set_scale` **(** :ref:`String` id, :ref:`float` scale **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`timeseek_node_seek` **(** :ref:`String` id, :ref:`float` pos_sec **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`transition_node_delete_input` **(** :ref:`String` id, :ref:`int` input_idx **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`transition_node_get_current` **(** :ref:`String` id **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`transition_node_get_input_count` **(** :ref:`String` id **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`transition_node_get_xfade_time` **(** :ref:`String` id **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`transition_node_has_input_auto_advance` **(** :ref:`String` id, :ref:`int` input_idx **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`transition_node_set_current` **(** :ref:`String` id, :ref:`int` input_idx **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`transition_node_set_input_auto_advance` **(** :ref:`String` id, :ref:`int` input_idx, :ref:`bool` enable **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`transition_node_set_input_count` **(** :ref:`String` id, :ref:`int` count **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`transition_node_set_xfade_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`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` id, :ref:`String` source **)** +.. _class_AnimationTreePlayer_are_nodes_connected: + +- :ref:`bool` **are_nodes_connected** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** const + .. _class_AnimationTreePlayer_blend2_node_get_amount: - :ref:`float` **blend2_node_get_amount** **(** :ref:`String` id **)** const @@ -230,13 +239,13 @@ Set the animation for an animation node. - void **blend4_node_set_amount** **(** :ref:`String` id, :ref:`Vector2` blend **)** -.. _class_AnimationTreePlayer_connect: +.. _class_AnimationTreePlayer_connect_nodes: -- :ref:`int` **connect** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** +- :ref:`int` **connect_nodes** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** -.. _class_AnimationTreePlayer_disconnect: +.. _class_AnimationTreePlayer_disconnect_nodes: -- void **disconnect** **(** :ref:`String` id, :ref:`int` dst_input_idx **)** +- void **disconnect_nodes** **(** :ref:`String` id, :ref:`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` **get_node_list** **(** **)** +- :ref:`PoolStringArray` **get_node_list** **(** **)** .. _class_AnimationTreePlayer_is_active: - :ref:`bool` **is_active** **(** **)** const -.. _class_AnimationTreePlayer_is_connected: - -- :ref:`bool` **is_connected** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** const - .. _class_AnimationTreePlayer_mix_node_get_amount: - :ref:`float` **mix_node_get_amount** **(** :ref:`String` id **)** const diff --git a/classes/class_area.rst b/classes/class_area.rst index 2a2b7b895..1c5be938f 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -49,7 +49,7 @@ Member Functions +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_monitorable` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_monitoring_enabled` **(** **)** const | +| :ref:`bool` | :ref:`is_monitoring` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Object` area **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ @@ -61,8 +61,6 @@ Member Functions +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enable_monitoring` **(** :ref:`bool` enable **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_gravity` **(** :ref:`float` gravity **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_gravity_distance_scale` **(** :ref:`float` distance_scale **)** | @@ -79,6 +77,8 @@ Member Functions +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_monitorable` **(** :ref:`bool` enable **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_monitoring` **(** :ref:`bool` enable **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_priority` **(** :ref:`float` priority **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_space_override_mode` **(** :ref:`int` enable **)** | @@ -87,14 +87,30 @@ Member Functions Signals ------- -- **area_enter** **(** :ref:`Object` area **)** -- **area_enter_shape** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** -- **area_exit** **(** :ref:`Object` area **)** -- **area_exit_shape** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** -- **body_enter** **(** :ref:`Object` body **)** -- **body_enter_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** -- **body_exit** **(** :ref:`Object` body **)** -- **body_exit_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +- **area_entered** **(** :ref:`Object` area **)** +- **area_exited** **(** :ref:`Object` area **)** +- **area_shape_entered** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +- **area_shape_exited** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +- **body_entered** **(** :ref:`Object` body **)** +- **body_exited** **(** :ref:`Object` body **)** +- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** + +Member Variables +---------------- + +- :ref:`float` **angular_damp** +- :ref:`int` **collision_layers** +- :ref:`int` **collision_mask** +- :ref:`float` **gravity** +- :ref:`float` **gravity_distance_scale** +- :ref:`bool` **gravity_point** +- :ref:`Vector3` **gravity_vec** +- :ref:`float` **linear_damp** +- :ref:`bool` **monitorable** +- :ref:`bool` **monitoring** +- :ref:`int` **priority** +- :ref:`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` **is_monitoring_enabled** **(** **)** const +- :ref:`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` enable **)** - -Set whether this area can detect bodies/areas entering/exiting it. - .. _class_Area_set_gravity: - void **set_gravity** **(** :ref:`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` enable **)** + +Set whether this area can detect bodies/areas entering/exiting it. + .. _class_Area_set_priority: - void **set_priority** **(** :ref:`float` priority **)** diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index f99aaff05..36b874c6a 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -49,7 +49,7 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_monitorable` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_monitoring_enabled` **(** **)** const | +| :ref:`bool` | :ref:`is_monitoring` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Object` area **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ @@ -61,8 +61,6 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enable_monitoring` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_gravity` **(** :ref:`float` gravity **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_gravity_distance_scale` **(** :ref:`float` distance_scale **)** | @@ -79,6 +77,8 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_monitorable` **(** :ref:`bool` enable **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_monitoring` **(** :ref:`bool` enable **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_priority` **(** :ref:`float` priority **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_space_override_mode` **(** :ref:`int` enable **)** | @@ -87,14 +87,30 @@ Member Functions Signals ------- -- **area_enter** **(** :ref:`Object` area **)** -- **area_enter_shape** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** -- **area_exit** **(** :ref:`Object` area **)** -- **area_exit_shape** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** -- **body_enter** **(** :ref:`Object` body **)** -- **body_enter_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** -- **body_exit** **(** :ref:`Object` body **)** -- **body_exit_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +- **area_entered** **(** :ref:`Object` area **)** +- **area_exited** **(** :ref:`Object` area **)** +- **area_shape_entered** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +- **area_shape_exited** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +- **body_entered** **(** :ref:`Object` body **)** +- **body_exited** **(** :ref:`Object` body **)** +- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** + +Member Variables +---------------- + +- :ref:`float` **angular_damp** +- :ref:`int` **collision_layers** +- :ref:`int` **collision_mask** +- :ref:`float` **gravity** +- :ref:`float` **gravity_distance_scale** +- :ref:`bool` **gravity_point** +- :ref:`Vector2` **gravity_vec** +- :ref:`float` **linear_damp** +- :ref:`bool` **monitorable** +- :ref:`bool` **monitoring** +- :ref:`int` **priority** +- :ref:`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` **is_monitoring_enabled** **(** **)** const +- :ref:`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` enable **)** - -Set whether this area can detect bodies/areas entering/exiting it. - .. _class_Area2D_set_gravity: - void **set_gravity** **(** :ref:`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` enable **)** + +Set whether this area can detect bodies/areas entering/exiting it. + .. _class_Area2D_set_priority: - void **set_priority** **(** :ref:`float` priority **)** diff --git a/classes/class_array.rst b/classes/class_array.rst index fb3ed15d7..6990f7b87 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -16,69 +16,67 @@ Generic array datatype. Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`ColorArray` from **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`Vector3Array` from **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`Vector2Array` from **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`StringArray` from **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`RealArray` from **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`IntArray` from **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`RawArray` from **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** var value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`count` **(** var value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase` **(** var value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`front` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`back` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find` **(** var what, :ref:`int` from=0 **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_last` **(** var value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** var value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hash` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`insert` **(** :ref:`int` pos, var value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shared` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pop_back` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pop_front` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** var value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_front` **(** var value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` pos **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` pos **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rfind` **(** var what, :ref:`int` from=-1 **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort_custom` **(** :ref:`Object` obj, :ref:`String` func **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolColorArray` from **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector3Array` from **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector2Array` from **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolStringArray` from **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolRealArray` from **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolIntArray` from **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolByteArray` from **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** var value **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`back` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`count` **(** var value **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase` **(** var value **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find` **(** var what, :ref:`int` from=0 **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_last` **(** var value **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`front` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has` **(** var value **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hash` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`insert` **(** :ref:`int` pos, var value **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`pop_back` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`pop_front` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** var value **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_front` **(** var value **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` pos **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` pos **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rfind` **(** var what, :ref:`int` from=-1 **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort_custom` **(** :ref:`Object` obj, :ref:`String` func **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -90,45 +88,45 @@ Member Function Description .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`ColorArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolColorArray` from **)** -Construct an array from a :ref:`RawArray`. +Construct an array from a :ref:`PoolByteArray`. .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`Vector3Array` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolVector3Array` from **)** -Construct an array from a :ref:`RawArray`. +Construct an array from a :ref:`PoolByteArray`. .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`Vector2Array` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolVector2Array` from **)** -Construct an array from a :ref:`RawArray`. +Construct an array from a :ref:`PoolByteArray`. .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`StringArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolStringArray` from **)** -Construct an array from a :ref:`RawArray`. +Construct an array from a :ref:`PoolStringArray`. .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`RealArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolRealArray` from **)** -Construct an array from a :ref:`RawArray`. +Construct an array from a :ref:`PoolRealArray`. .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`IntArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolIntArray` from **)** -Construct an array from a :ref:`RawArray`. +Construct an array from a :ref:`PoolByteArray`. .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`RawArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolByteArray` from **)** -Construct an array from a :ref:`RawArray`. +Construct an array from a :ref:`PoolByteArray`. .. _class_Array_append: @@ -136,6 +134,12 @@ Construct an array from a :ref:`RawArray`. Append an element at the end of the array (alias of :ref:`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` **front** **(** **)** - -Returns the first element of the array if the array is not empty (size>0). - -.. _class_Array_back: - -- :ref:`Variant` **back** **(** **)** - -Returns the last element of the array if the array is not empty (size>0). - .. _class_Array_find: - :ref:`int` **find** **(** var what, :ref:`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` **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` **is_shared** **(** **)** - -Get whether this is a shared array instance. - .. _class_Array_pop_back: - void **pop_back** **(** **)** diff --git a/classes/class_astar.rst b/classes/class_astar.rst index 8729c138a..c291ce1ee 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -18,37 +18,49 @@ Brief Description Member Functions ---------------- -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=1 **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_point_id` **(** **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector3` to_pos **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_pos_in_segment` **(** :ref:`Vector3` to_pos **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`IntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_pos` **(** :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` id **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=1 **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_point_id` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector3` to_pos **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_pos_in_segment` **(** :ref:`Vector3` to_pos **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_pos` **(** :ref:`int` id **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` id **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- +.. _class_AStar__compute_cost: + +- void **_compute_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual + +.. _class_AStar__estimate_cost: + +- void **_estimate_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual + .. _class_AStar_add_point: - void **add_point** **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=1 **)** @@ -83,11 +95,11 @@ Member Function Description .. _class_AStar_get_id_path: -- :ref:`IntArray` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** +- :ref:`PoolIntArray` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** .. _class_AStar_get_point_path: -- :ref:`Vector3Array` **get_point_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** +- :ref:`PoolVector3Array` **get_point_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** .. _class_AStar_get_point_pos: diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index de6395a98..80b1ec4ad 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -37,6 +37,13 @@ Signals - **atlas_changed** **(** **)** +Member Variables +---------------- + +- :ref:`Texture` **atlas** +- :ref:`Rect2` **margin** +- :ref:`Rect2` **region** + Member Function Description --------------------------- diff --git a/classes/class_materialshader.rst b/classes/class_audiobuslayout.rst similarity index 53% rename from classes/class_materialshader.rst rename to classes/class_audiobuslayout.rst index 7f339af30..97bdf56a4 100644 --- a/classes/class_materialshader.rst +++ b/classes/class_audiobuslayout.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core diff --git a/classes/class_audioeffect.rst b/classes/class_audioeffect.rst new file mode 100644 index 000000000..e3c70b326 --- /dev/null +++ b/classes/class_audioeffect.rst @@ -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` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`AudioEffectCompressor`, :ref:`AudioEffectAmplify`, :ref:`AudioEffectFilter`, :ref:`AudioEffectDistortion`, :ref:`AudioEffectLimiter`, :ref:`AudioEffectDelay`, :ref:`AudioEffectStereoEnhance`, :ref:`AudioEffectReverb`, :ref:`AudioEffectPanner`, :ref:`AudioEffectEQ`, :ref:`AudioEffectChorus`, :ref:`AudioEffectPitchShift`, :ref:`AudioEffectPhaser` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_audioeffectamplify.rst b/classes/class_audioeffectamplify.rst new file mode 100644 index 000000000..f819e0b0d --- /dev/null +++ b/classes/class_audioeffectamplify.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_volume_db` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_volume_db` **(** :ref:`float` volume **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **volume_db** + +Member Function Description +--------------------------- + +.. _class_AudioEffectAmplify_get_volume_db: + +- :ref:`float` **get_volume_db** **(** **)** const + +.. _class_AudioEffectAmplify_set_volume_db: + +- void **set_volume_db** **(** :ref:`float` volume **)** + + diff --git a/classes/class_audioeffectbandlimitfilter.rst b/classes/class_audioeffectbandlimitfilter.rst new file mode 100644 index 000000000..209e9ea75 --- /dev/null +++ b/classes/class_audioeffectbandlimitfilter.rst @@ -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` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_audioeffectbandpassfilter.rst b/classes/class_audioeffectbandpassfilter.rst new file mode 100644 index 000000000..fee17856f --- /dev/null +++ b/classes/class_audioeffectbandpassfilter.rst @@ -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` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst new file mode 100644 index 000000000..acc6874c5 --- /dev/null +++ b/classes/class_audioeffectchorus.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dry` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_voice_count` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_voice_cutoff_hz` **(** :ref:`int` voice_idx **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_voice_delay_ms` **(** :ref:`int` voice_idx **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_voice_depth_ms` **(** :ref:`int` voice_idx **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_voice_level_db` **(** :ref:`int` voice_idx **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_voice_pan` **(** :ref:`int` voice_idx **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_voice_rate_hz` **(** :ref:`int` voice_idx **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_wet` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dry` **(** :ref:`float` amount **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_voice_count` **(** :ref:`int` voices **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_voice_cutoff_hz` **(** :ref:`int` voice_idx, :ref:`float` cutoff_hz **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_voice_delay_ms` **(** :ref:`int` voice_idx, :ref:`float` delay_ms **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_voice_depth_ms` **(** :ref:`int` voice_idx, :ref:`float` depth_ms **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_voice_level_db` **(** :ref:`int` voice_idx, :ref:`float` level_db **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_voice_pan` **(** :ref:`int` voice_idx, :ref:`float` pan **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_voice_rate_hz` **(** :ref:`int` voice_idx, :ref:`float` rate_hz **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_wet` **(** :ref:`float` amount **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **dry** +- :ref:`float` **voice/1/cutoff_hz** +- :ref:`float` **voice/1/delay_ms** +- :ref:`float` **voice/1/depth_ms** +- :ref:`float` **voice/1/level_db** +- :ref:`float` **voice/1/pan** +- :ref:`float` **voice/1/rate_hz** +- :ref:`float` **voice/2/cutoff_hz** +- :ref:`float` **voice/2/delay_ms** +- :ref:`float` **voice/2/depth_ms** +- :ref:`float` **voice/2/level_db** +- :ref:`float` **voice/2/pan** +- :ref:`float` **voice/2/rate_hz** +- :ref:`float` **voice/3/cutoff_hz** +- :ref:`float` **voice/3/delay_ms** +- :ref:`float` **voice/3/depth_ms** +- :ref:`float` **voice/3/level_db** +- :ref:`float` **voice/3/pan** +- :ref:`float` **voice/3/rate_hz** +- :ref:`float` **voice/4/cutoff_hz** +- :ref:`float` **voice/4/delay_ms** +- :ref:`float` **voice/4/depth_ms** +- :ref:`float` **voice/4/level_db** +- :ref:`float` **voice/4/pan** +- :ref:`float` **voice/4/rate_hz** +- :ref:`int` **voice_count** +- :ref:`float` **wet** + +Member Function Description +--------------------------- + +.. _class_AudioEffectChorus_get_dry: + +- :ref:`float` **get_dry** **(** **)** const + +.. _class_AudioEffectChorus_get_voice_count: + +- :ref:`int` **get_voice_count** **(** **)** const + +.. _class_AudioEffectChorus_get_voice_cutoff_hz: + +- :ref:`float` **get_voice_cutoff_hz** **(** :ref:`int` voice_idx **)** const + +.. _class_AudioEffectChorus_get_voice_delay_ms: + +- :ref:`float` **get_voice_delay_ms** **(** :ref:`int` voice_idx **)** const + +.. _class_AudioEffectChorus_get_voice_depth_ms: + +- :ref:`float` **get_voice_depth_ms** **(** :ref:`int` voice_idx **)** const + +.. _class_AudioEffectChorus_get_voice_level_db: + +- :ref:`float` **get_voice_level_db** **(** :ref:`int` voice_idx **)** const + +.. _class_AudioEffectChorus_get_voice_pan: + +- :ref:`float` **get_voice_pan** **(** :ref:`int` voice_idx **)** const + +.. _class_AudioEffectChorus_get_voice_rate_hz: + +- :ref:`float` **get_voice_rate_hz** **(** :ref:`int` voice_idx **)** const + +.. _class_AudioEffectChorus_get_wet: + +- :ref:`float` **get_wet** **(** **)** const + +.. _class_AudioEffectChorus_set_dry: + +- void **set_dry** **(** :ref:`float` amount **)** + +.. _class_AudioEffectChorus_set_voice_count: + +- void **set_voice_count** **(** :ref:`int` voices **)** + +.. _class_AudioEffectChorus_set_voice_cutoff_hz: + +- void **set_voice_cutoff_hz** **(** :ref:`int` voice_idx, :ref:`float` cutoff_hz **)** + +.. _class_AudioEffectChorus_set_voice_delay_ms: + +- void **set_voice_delay_ms** **(** :ref:`int` voice_idx, :ref:`float` delay_ms **)** + +.. _class_AudioEffectChorus_set_voice_depth_ms: + +- void **set_voice_depth_ms** **(** :ref:`int` voice_idx, :ref:`float` depth_ms **)** + +.. _class_AudioEffectChorus_set_voice_level_db: + +- void **set_voice_level_db** **(** :ref:`int` voice_idx, :ref:`float` level_db **)** + +.. _class_AudioEffectChorus_set_voice_pan: + +- void **set_voice_pan** **(** :ref:`int` voice_idx, :ref:`float` pan **)** + +.. _class_AudioEffectChorus_set_voice_rate_hz: + +- void **set_voice_rate_hz** **(** :ref:`int` voice_idx, :ref:`float` rate_hz **)** + +.. _class_AudioEffectChorus_set_wet: + +- void **set_wet** **(** :ref:`float` amount **)** + + diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst new file mode 100644 index 000000000..2d9e3b38d --- /dev/null +++ b/classes/class_audioeffectcompressor.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_attack_us` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_gain` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_mix` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ratio` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_release_ms` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_sidechain` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_treshold` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_attack_us` **(** :ref:`float` attack_us **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gain` **(** :ref:`float` gain **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mix` **(** :ref:`float` mix **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ratio` **(** :ref:`float` ratio **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_release_ms` **(** :ref:`float` release_ms **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sidechain` **(** :ref:`String` sidechain **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_treshold` **(** :ref:`float` treshold **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **attack_us** +- :ref:`float` **gain** +- :ref:`float` **mix** +- :ref:`float` **ratio** +- :ref:`float` **release_ms** +- :ref:`float` **sidechain** +- :ref:`float` **treshold** + +Member Function Description +--------------------------- + +.. _class_AudioEffectCompressor_get_attack_us: + +- :ref:`float` **get_attack_us** **(** **)** const + +.. _class_AudioEffectCompressor_get_gain: + +- :ref:`float` **get_gain** **(** **)** const + +.. _class_AudioEffectCompressor_get_mix: + +- :ref:`float` **get_mix** **(** **)** const + +.. _class_AudioEffectCompressor_get_ratio: + +- :ref:`float` **get_ratio** **(** **)** const + +.. _class_AudioEffectCompressor_get_release_ms: + +- :ref:`float` **get_release_ms** **(** **)** const + +.. _class_AudioEffectCompressor_get_sidechain: + +- :ref:`String` **get_sidechain** **(** **)** const + +.. _class_AudioEffectCompressor_get_treshold: + +- :ref:`float` **get_treshold** **(** **)** const + +.. _class_AudioEffectCompressor_set_attack_us: + +- void **set_attack_us** **(** :ref:`float` attack_us **)** + +.. _class_AudioEffectCompressor_set_gain: + +- void **set_gain** **(** :ref:`float` gain **)** + +.. _class_AudioEffectCompressor_set_mix: + +- void **set_mix** **(** :ref:`float` mix **)** + +.. _class_AudioEffectCompressor_set_ratio: + +- void **set_ratio** **(** :ref:`float` ratio **)** + +.. _class_AudioEffectCompressor_set_release_ms: + +- void **set_release_ms** **(** :ref:`float` release_ms **)** + +.. _class_AudioEffectCompressor_set_sidechain: + +- void **set_sidechain** **(** :ref:`String` sidechain **)** + +.. _class_AudioEffectCompressor_set_treshold: + +- void **set_treshold** **(** :ref:`float` treshold **)** + + diff --git a/classes/class_audioeffectdelay.rst b/classes/class_audioeffectdelay.rst new file mode 100644 index 000000000..6f334818c --- /dev/null +++ b/classes/class_audioeffectdelay.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dry` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_feedback_delay_ms` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_feedback_level_db` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_feedback_lowpass` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tap1_delay_ms` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tap1_level_db` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tap1_pan` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tap2_delay_ms` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tap2_level_db` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tap2_pan` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_feedback_active` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_tap1_active` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_tap2_active` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dry` **(** :ref:`float` amount **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_feedback_active` **(** :ref:`bool` amount **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_feedback_delay_ms` **(** :ref:`float` amount **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_feedback_level_db` **(** :ref:`float` amount **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_feedback_lowpass` **(** :ref:`float` amount **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tap1_active` **(** :ref:`bool` amount **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tap1_delay_ms` **(** :ref:`float` amount **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tap1_level_db` **(** :ref:`float` amount **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tap1_pan` **(** :ref:`float` amount **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tap2_active` **(** :ref:`bool` amount **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tap2_delay_ms` **(** :ref:`float` amount **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tap2_level_db` **(** :ref:`float` amount **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tap2_pan` **(** :ref:`float` amount **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **dry** +- :ref:`bool` **feedback/active** +- :ref:`float` **feedback/delay_ms** +- :ref:`float` **feedback/level_db** +- :ref:`float` **feedback/lowpass** +- :ref:`bool` **tap1/active** +- :ref:`float` **tap1/delay_ms** +- :ref:`float` **tap1/level_db** +- :ref:`float` **tap1/pan** +- :ref:`bool` **tap2/active** +- :ref:`float` **tap2/delay_ms** +- :ref:`float` **tap2/level_db** +- :ref:`float` **tap2/pan** + +Member Function Description +--------------------------- + +.. _class_AudioEffectDelay_get_dry: + +- :ref:`float` **get_dry** **(** **)** + +.. _class_AudioEffectDelay_get_feedback_delay_ms: + +- :ref:`float` **get_feedback_delay_ms** **(** **)** const + +.. _class_AudioEffectDelay_get_feedback_level_db: + +- :ref:`float` **get_feedback_level_db** **(** **)** const + +.. _class_AudioEffectDelay_get_feedback_lowpass: + +- :ref:`float` **get_feedback_lowpass** **(** **)** const + +.. _class_AudioEffectDelay_get_tap1_delay_ms: + +- :ref:`float` **get_tap1_delay_ms** **(** **)** const + +.. _class_AudioEffectDelay_get_tap1_level_db: + +- :ref:`float` **get_tap1_level_db** **(** **)** const + +.. _class_AudioEffectDelay_get_tap1_pan: + +- :ref:`float` **get_tap1_pan** **(** **)** const + +.. _class_AudioEffectDelay_get_tap2_delay_ms: + +- :ref:`float` **get_tap2_delay_ms** **(** **)** const + +.. _class_AudioEffectDelay_get_tap2_level_db: + +- :ref:`float` **get_tap2_level_db** **(** **)** const + +.. _class_AudioEffectDelay_get_tap2_pan: + +- :ref:`float` **get_tap2_pan** **(** **)** const + +.. _class_AudioEffectDelay_is_feedback_active: + +- :ref:`bool` **is_feedback_active** **(** **)** const + +.. _class_AudioEffectDelay_is_tap1_active: + +- :ref:`bool` **is_tap1_active** **(** **)** const + +.. _class_AudioEffectDelay_is_tap2_active: + +- :ref:`bool` **is_tap2_active** **(** **)** const + +.. _class_AudioEffectDelay_set_dry: + +- void **set_dry** **(** :ref:`float` amount **)** + +.. _class_AudioEffectDelay_set_feedback_active: + +- void **set_feedback_active** **(** :ref:`bool` amount **)** + +.. _class_AudioEffectDelay_set_feedback_delay_ms: + +- void **set_feedback_delay_ms** **(** :ref:`float` amount **)** + +.. _class_AudioEffectDelay_set_feedback_level_db: + +- void **set_feedback_level_db** **(** :ref:`float` amount **)** + +.. _class_AudioEffectDelay_set_feedback_lowpass: + +- void **set_feedback_lowpass** **(** :ref:`float` amount **)** + +.. _class_AudioEffectDelay_set_tap1_active: + +- void **set_tap1_active** **(** :ref:`bool` amount **)** + +.. _class_AudioEffectDelay_set_tap1_delay_ms: + +- void **set_tap1_delay_ms** **(** :ref:`float` amount **)** + +.. _class_AudioEffectDelay_set_tap1_level_db: + +- void **set_tap1_level_db** **(** :ref:`float` amount **)** + +.. _class_AudioEffectDelay_set_tap1_pan: + +- void **set_tap1_pan** **(** :ref:`float` amount **)** + +.. _class_AudioEffectDelay_set_tap2_active: + +- void **set_tap2_active** **(** :ref:`bool` amount **)** + +.. _class_AudioEffectDelay_set_tap2_delay_ms: + +- void **set_tap2_delay_ms** **(** :ref:`float` amount **)** + +.. _class_AudioEffectDelay_set_tap2_level_db: + +- void **set_tap2_level_db** **(** :ref:`float` amount **)** + +.. _class_AudioEffectDelay_set_tap2_pan: + +- void **set_tap2_pan** **(** :ref:`float` amount **)** + + diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst new file mode 100644 index 000000000..ff790af49 --- /dev/null +++ b/classes/class_audioeffectdistortion.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_drive` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_keep_hf_hz` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mode` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_post_gain` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pre_gain` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_drive` **(** :ref:`float` drive **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_keep_hf_hz` **(** :ref:`float` keep_hf_hz **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mode` **(** :ref:`int` mode **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_post_gain` **(** :ref:`float` post_gain **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pre_gain` **(** :ref:`float` pre_gain **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **drive** +- :ref:`float` **keep_hf_hz** +- :ref:`int` **mode** +- :ref:`float` **post_gain** +- :ref:`float` **pre_gain** + +Member Function Description +--------------------------- + +.. _class_AudioEffectDistortion_get_drive: + +- :ref:`float` **get_drive** **(** **)** const + +.. _class_AudioEffectDistortion_get_keep_hf_hz: + +- :ref:`float` **get_keep_hf_hz** **(** **)** const + +.. _class_AudioEffectDistortion_get_mode: + +- :ref:`int` **get_mode** **(** **)** const + +.. _class_AudioEffectDistortion_get_post_gain: + +- :ref:`float` **get_post_gain** **(** **)** const + +.. _class_AudioEffectDistortion_get_pre_gain: + +- :ref:`float` **get_pre_gain** **(** **)** const + +.. _class_AudioEffectDistortion_set_drive: + +- void **set_drive** **(** :ref:`float` drive **)** + +.. _class_AudioEffectDistortion_set_keep_hf_hz: + +- void **set_keep_hf_hz** **(** :ref:`float` keep_hf_hz **)** + +.. _class_AudioEffectDistortion_set_mode: + +- void **set_mode** **(** :ref:`int` mode **)** + +.. _class_AudioEffectDistortion_set_post_gain: + +- void **set_post_gain** **(** :ref:`float` post_gain **)** + +.. _class_AudioEffectDistortion_set_pre_gain: + +- void **set_pre_gain** **(** :ref:`float` pre_gain **)** + + diff --git a/classes/class_audioeffecteq.rst b/classes/class_audioeffecteq.rst new file mode 100644 index 000000000..82df0ea95 --- /dev/null +++ b/classes/class_audioeffecteq.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`AudioEffectEQ6`, :ref:`AudioEffectEQ21`, :ref:`AudioEffectEQ10` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_band_count` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_band_gain_db` **(** :ref:`int` band_idx **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_band_gain_db` **(** :ref:`int` band_idx, :ref:`float` volume_db **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_AudioEffectEQ_get_band_count: + +- :ref:`int` **get_band_count** **(** **)** const + +.. _class_AudioEffectEQ_get_band_gain_db: + +- :ref:`float` **get_band_gain_db** **(** :ref:`int` band_idx **)** const + +.. _class_AudioEffectEQ_set_band_gain_db: + +- void **set_band_gain_db** **(** :ref:`int` band_idx, :ref:`float` volume_db **)** + + diff --git a/classes/class_audioeffecteq10.rst b/classes/class_audioeffecteq10.rst new file mode 100644 index 000000000..a843ad586 --- /dev/null +++ b/classes/class_audioeffecteq10.rst @@ -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` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_audioeffecteq21.rst b/classes/class_audioeffecteq21.rst new file mode 100644 index 000000000..b42cad674 --- /dev/null +++ b/classes/class_audioeffecteq21.rst @@ -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` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_audioeffecteq6.rst b/classes/class_audioeffecteq6.rst new file mode 100644 index 000000000..21095cb2f --- /dev/null +++ b/classes/class_audioeffecteq6.rst @@ -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` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst new file mode 100644 index 000000000..32b84ee37 --- /dev/null +++ b/classes/class_audioeffectfilter.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`AudioEffectHighPassFilter`, :ref:`AudioEffectBandLimitFilter`, :ref:`AudioEffectLowShelfFilter`, :ref:`AudioEffectHighShelfFilter`, :ref:`AudioEffectBandPassFilter`, :ref:`AudioEffectNotchFilter`, :ref:`AudioEffectLowPassFilter` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_cutoff` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_db` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_gain` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_resonance` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cutoff` **(** :ref:`float` freq **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_db` **(** :ref:`int` amount **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gain` **(** :ref:`float` amount **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_resonance` **(** :ref:`float` amount **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **cutoff_hz** +- :ref:`int` **dB** +- :ref:`float` **gain** +- :ref:`float` **resonance** + +Member Function Description +--------------------------- + +.. _class_AudioEffectFilter_get_cutoff: + +- :ref:`float` **get_cutoff** **(** **)** const + +.. _class_AudioEffectFilter_get_db: + +- :ref:`int` **get_db** **(** **)** const + +.. _class_AudioEffectFilter_get_gain: + +- :ref:`float` **get_gain** **(** **)** const + +.. _class_AudioEffectFilter_get_resonance: + +- :ref:`float` **get_resonance** **(** **)** const + +.. _class_AudioEffectFilter_set_cutoff: + +- void **set_cutoff** **(** :ref:`float` freq **)** + +.. _class_AudioEffectFilter_set_db: + +- void **set_db** **(** :ref:`int` amount **)** + +.. _class_AudioEffectFilter_set_gain: + +- void **set_gain** **(** :ref:`float` amount **)** + +.. _class_AudioEffectFilter_set_resonance: + +- void **set_resonance** **(** :ref:`float` amount **)** + + diff --git a/classes/class_audioeffecthighpassfilter.rst b/classes/class_audioeffecthighpassfilter.rst new file mode 100644 index 000000000..eb9fe9f94 --- /dev/null +++ b/classes/class_audioeffecthighpassfilter.rst @@ -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` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_audioeffecthighshelffilter.rst b/classes/class_audioeffecthighshelffilter.rst new file mode 100644 index 000000000..e3d0f7b66 --- /dev/null +++ b/classes/class_audioeffecthighshelffilter.rst @@ -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` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst new file mode 100644 index 000000000..a37a52531 --- /dev/null +++ b/classes/class_audioeffectlimiter.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ceiling_db` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_soft_clip_db` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_soft_clip_ratio` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_treshold_db` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ceiling_db` **(** :ref:`float` ceiling **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_soft_clip_db` **(** :ref:`float` soft_clip **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_soft_clip_ratio` **(** :ref:`float` soft_clip **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_treshold_db` **(** :ref:`float` treshold **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **ceiling_db** +- :ref:`float` **soft_clip_db** +- :ref:`float` **soft_clip_ratio** +- :ref:`float` **treshold_db** + +Member Function Description +--------------------------- + +.. _class_AudioEffectLimiter_get_ceiling_db: + +- :ref:`float` **get_ceiling_db** **(** **)** const + +.. _class_AudioEffectLimiter_get_soft_clip_db: + +- :ref:`float` **get_soft_clip_db** **(** **)** const + +.. _class_AudioEffectLimiter_get_soft_clip_ratio: + +- :ref:`float` **get_soft_clip_ratio** **(** **)** const + +.. _class_AudioEffectLimiter_get_treshold_db: + +- :ref:`float` **get_treshold_db** **(** **)** const + +.. _class_AudioEffectLimiter_set_ceiling_db: + +- void **set_ceiling_db** **(** :ref:`float` ceiling **)** + +.. _class_AudioEffectLimiter_set_soft_clip_db: + +- void **set_soft_clip_db** **(** :ref:`float` soft_clip **)** + +.. _class_AudioEffectLimiter_set_soft_clip_ratio: + +- void **set_soft_clip_ratio** **(** :ref:`float` soft_clip **)** + +.. _class_AudioEffectLimiter_set_treshold_db: + +- void **set_treshold_db** **(** :ref:`float` treshold **)** + + diff --git a/classes/class_audioeffectlowpassfilter.rst b/classes/class_audioeffectlowpassfilter.rst new file mode 100644 index 000000000..d4649aef3 --- /dev/null +++ b/classes/class_audioeffectlowpassfilter.rst @@ -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` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_audioeffectlowshelffilter.rst b/classes/class_audioeffectlowshelffilter.rst new file mode 100644 index 000000000..384575034 --- /dev/null +++ b/classes/class_audioeffectlowshelffilter.rst @@ -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` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_rendertargettexture.rst b/classes/class_audioeffectnotchfilter.rst similarity index 59% rename from classes/class_rendertargettexture.rst rename to classes/class_audioeffectnotchfilter.rst index 4f3ef897d..01bfffbf0 100644 --- a/classes/class_rendertargettexture.rst +++ b/classes/class_audioeffectnotchfilter.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core diff --git a/classes/class_audioeffectpanner.rst b/classes/class_audioeffectpanner.rst new file mode 100644 index 000000000..a8009205e --- /dev/null +++ b/classes/class_audioeffectpanner.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pan` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pan` **(** :ref:`float` cpanume **)** | ++----------------------------+-------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **pan** + +Member Function Description +--------------------------- + +.. _class_AudioEffectPanner_get_pan: + +- :ref:`float` **get_pan** **(** **)** const + +.. _class_AudioEffectPanner_set_pan: + +- void **set_pan** **(** :ref:`float` cpanume **)** + + diff --git a/classes/class_audioeffectphaser.rst b/classes/class_audioeffectphaser.rst new file mode 100644 index 000000000..063e80813 --- /dev/null +++ b/classes/class_audioeffectphaser.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_depth` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_feedback` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_range_max_hz` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_range_min_hz` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rate_hz` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_depth` **(** :ref:`float` depth **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_feedback` **(** :ref:`float` fbk **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_range_max_hz` **(** :ref:`float` hz **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_range_min_hz` **(** :ref:`float` hz **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rate_hz` **(** :ref:`float` hz **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **depth** +- :ref:`float` **feedback** +- :ref:`float` **range_max_hz** +- :ref:`float` **range_min_hz** +- :ref:`float` **rate_hz** + +Member Function Description +--------------------------- + +.. _class_AudioEffectPhaser_get_depth: + +- :ref:`float` **get_depth** **(** **)** const + +.. _class_AudioEffectPhaser_get_feedback: + +- :ref:`float` **get_feedback** **(** **)** const + +.. _class_AudioEffectPhaser_get_range_max_hz: + +- :ref:`float` **get_range_max_hz** **(** **)** const + +.. _class_AudioEffectPhaser_get_range_min_hz: + +- :ref:`float` **get_range_min_hz** **(** **)** const + +.. _class_AudioEffectPhaser_get_rate_hz: + +- :ref:`float` **get_rate_hz** **(** **)** const + +.. _class_AudioEffectPhaser_set_depth: + +- void **set_depth** **(** :ref:`float` depth **)** + +.. _class_AudioEffectPhaser_set_feedback: + +- void **set_feedback** **(** :ref:`float` fbk **)** + +.. _class_AudioEffectPhaser_set_range_max_hz: + +- void **set_range_max_hz** **(** :ref:`float` hz **)** + +.. _class_AudioEffectPhaser_set_range_min_hz: + +- void **set_range_min_hz** **(** :ref:`float` hz **)** + +.. _class_AudioEffectPhaser_set_rate_hz: + +- void **set_rate_hz** **(** :ref:`float` hz **)** + + diff --git a/classes/class_audioeffectpitchshift.rst b/classes/class_audioeffectpitchshift.rst new file mode 100644 index 000000000..45c083b43 --- /dev/null +++ b/classes/class_audioeffectpitchshift.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pitch_scale` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pitch_scale` **(** :ref:`float` rate **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **pitch_scale** + +Member Function Description +--------------------------- + +.. _class_AudioEffectPitchShift_get_pitch_scale: + +- :ref:`float` **get_pitch_scale** **(** **)** const + +.. _class_AudioEffectPitchShift_set_pitch_scale: + +- void **set_pitch_scale** **(** :ref:`float` rate **)** + + diff --git a/classes/class_audioeffectreverb.rst b/classes/class_audioeffectreverb.rst new file mode 100644 index 000000000..d4f3f9d28 --- /dev/null +++ b/classes/class_audioeffectreverb.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_damping` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dry` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_hpf` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_predelay_feedback` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_predelay_msec` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_room_size` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_spread` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_wet` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_damping` **(** :ref:`float` amount **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dry` **(** :ref:`float` amount **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hpf` **(** :ref:`float` amount **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_predelay_feedback` **(** :ref:`float` feedback **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_predelay_msec` **(** :ref:`float` msec **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_room_size` **(** :ref:`float` size **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_spread` **(** :ref:`float` amount **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_wet` **(** :ref:`float` amount **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **damping** +- :ref:`float` **dry** +- :ref:`float` **hipass** +- :ref:`float` **predelay_feedback** +- :ref:`float` **predelay_msec** +- :ref:`float` **room_size** +- :ref:`float` **spread** +- :ref:`float` **wet** + +Member Function Description +--------------------------- + +.. _class_AudioEffectReverb_get_damping: + +- :ref:`float` **get_damping** **(** **)** const + +.. _class_AudioEffectReverb_get_dry: + +- :ref:`float` **get_dry** **(** **)** const + +.. _class_AudioEffectReverb_get_hpf: + +- :ref:`float` **get_hpf** **(** **)** const + +.. _class_AudioEffectReverb_get_predelay_feedback: + +- :ref:`float` **get_predelay_feedback** **(** **)** const + +.. _class_AudioEffectReverb_get_predelay_msec: + +- :ref:`float` **get_predelay_msec** **(** **)** const + +.. _class_AudioEffectReverb_get_room_size: + +- :ref:`float` **get_room_size** **(** **)** const + +.. _class_AudioEffectReverb_get_spread: + +- :ref:`float` **get_spread** **(** **)** const + +.. _class_AudioEffectReverb_get_wet: + +- :ref:`float` **get_wet** **(** **)** const + +.. _class_AudioEffectReverb_set_damping: + +- void **set_damping** **(** :ref:`float` amount **)** + +.. _class_AudioEffectReverb_set_dry: + +- void **set_dry** **(** :ref:`float` amount **)** + +.. _class_AudioEffectReverb_set_hpf: + +- void **set_hpf** **(** :ref:`float` amount **)** + +.. _class_AudioEffectReverb_set_predelay_feedback: + +- void **set_predelay_feedback** **(** :ref:`float` feedback **)** + +.. _class_AudioEffectReverb_set_predelay_msec: + +- void **set_predelay_msec** **(** :ref:`float` msec **)** + +.. _class_AudioEffectReverb_set_room_size: + +- void **set_room_size** **(** :ref:`float` size **)** + +.. _class_AudioEffectReverb_set_spread: + +- void **set_spread** **(** :ref:`float` amount **)** + +.. _class_AudioEffectReverb_set_wet: + +- void **set_wet** **(** :ref:`float` amount **)** + + diff --git a/classes/class_audioeffectstereoenhance.rst b/classes/class_audioeffectstereoenhance.rst new file mode 100644 index 000000000..82b3b2d50 --- /dev/null +++ b/classes/class_audioeffectstereoenhance.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pan_pullout` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_surround` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_time_pullout` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pan_pullout` **(** :ref:`float` amount **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_surround` **(** :ref:`float` amount **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_time_pullout` **(** :ref:`float` amount **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **pan_pullout** +- :ref:`float` **surround** +- :ref:`float` **time_pullout_ms** + +Member Function Description +--------------------------- + +.. _class_AudioEffectStereoEnhance_get_pan_pullout: + +- :ref:`float` **get_pan_pullout** **(** **)** const + +.. _class_AudioEffectStereoEnhance_get_surround: + +- :ref:`float` **get_surround** **(** **)** const + +.. _class_AudioEffectStereoEnhance_get_time_pullout: + +- :ref:`float` **get_time_pullout** **(** **)** const + +.. _class_AudioEffectStereoEnhance_set_pan_pullout: + +- void **set_pan_pullout** **(** :ref:`float` amount **)** + +.. _class_AudioEffectStereoEnhance_set_surround: + +- void **set_surround** **(** :ref:`float` amount **)** + +.. _class_AudioEffectStereoEnhance_set_time_pullout: + +- void **set_time_pullout** **(** :ref:`float` amount **)** + + diff --git a/classes/class_audioplayer.rst b/classes/class_audioplayer.rst new file mode 100644 index 000000000..f12e2e160 --- /dev/null +++ b/classes/class_audioplayer.rst @@ -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` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bus` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mix_target` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pos` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_stream` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_volume_db` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`float` from_pos=0 **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` to_pos **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus` **(** :ref:`String` bus **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mix_target` **(** :ref:`int` mix_target **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_volume_db` **(** :ref:`float` volume_db **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`bool` **autoplay** +- :ref:`String` **bus** +- :ref:`int` **mix_target** +- :ref:`bool` **playing** +- :ref:`AudioStream` **stream** +- :ref:`float` **volume_db** + +Member Function Description +--------------------------- + +.. _class_AudioPlayer_get_bus: + +- :ref:`String` **get_bus** **(** **)** const + +.. _class_AudioPlayer_get_mix_target: + +- :ref:`int` **get_mix_target** **(** **)** const + +.. _class_AudioPlayer_get_pos: + +- :ref:`float` **get_pos** **(** **)** + +.. _class_AudioPlayer_get_stream: + +- :ref:`Object` **get_stream** **(** **)** const + +.. _class_AudioPlayer_get_volume_db: + +- :ref:`float` **get_volume_db** **(** **)** const + +.. _class_AudioPlayer_is_autoplay_enabled: + +- :ref:`bool` **is_autoplay_enabled** **(** **)** + +.. _class_AudioPlayer_is_playing: + +- :ref:`bool` **is_playing** **(** **)** const + +.. _class_AudioPlayer_play: + +- void **play** **(** :ref:`float` from_pos=0 **)** + +.. _class_AudioPlayer_seek: + +- void **seek** **(** :ref:`float` to_pos **)** + +.. _class_AudioPlayer_set_autoplay: + +- void **set_autoplay** **(** :ref:`bool` enable **)** + +.. _class_AudioPlayer_set_bus: + +- void **set_bus** **(** :ref:`String` bus **)** + +.. _class_AudioPlayer_set_mix_target: + +- void **set_mix_target** **(** :ref:`int` mix_target **)** + +.. _class_AudioPlayer_set_stream: + +- void **set_stream** **(** :ref:`AudioStream` stream **)** + +.. _class_AudioPlayer_set_volume_db: + +- void **set_volume_db** **(** :ref:`float` volume_db **)** + +.. _class_AudioPlayer_stop: + +- void **stop** **(** **)** + + diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index af6382705..b63438ccd 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -8,8 +8,6 @@ AudioServer **Inherits:** :ref:`Object` -**Inherited By:** :ref:`AudioServerSW` - **Category:** Core Brief Description @@ -20,119 +18,76 @@ Server interface for low level audio access. Member Functions ---------------- -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_event_voice_global_volume_scale` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fx_global_volume_scale` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_stream_global_volume_scale` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`sample_create` **(** :ref:`int` format, :ref:`bool` stereo, :ref:`int` length **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`sample_get_data` **(** :ref:`RID` sample **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`sample_get_description` **(** :ref:`RID` sample **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`sample_get_format` **(** :ref:`RID` sample **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`sample_get_length` **(** :ref:`RID` sample **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`sample_get_loop_begin` **(** :ref:`RID` sample **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`sample_get_loop_end` **(** :ref:`RID` sample **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`sample_get_loop_format` **(** :ref:`RID` sample **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`sample_get_mix_rate` **(** :ref:`RID` sample **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`sample_is_stereo` **(** :ref:`RID` sample **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sample_set_data` **(** :ref:`RID` sample, :ref:`RawArray` data **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sample_set_description` **(** :ref:`RID` sample, :ref:`String` description **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sample_set_loop_begin` **(** :ref:`RID` sample, :ref:`int` pos **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sample_set_loop_end` **(** :ref:`RID` sample, :ref:`int` pos **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sample_set_loop_format` **(** :ref:`RID` sample, :ref:`int` loop_format **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sample_set_mix_rate` **(** :ref:`RID` sample, :ref:`int` mix_rate **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sample_set_signed_data` **(** :ref:`RID` sample, :ref:`RealArray` data **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_event_voice_global_volume_scale` **(** :ref:`float` scale **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fx_global_volume_scale` **(** :ref:`float` scale **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream_global_volume_scale` **(** :ref:`float` scale **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`voice_create` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice_get_chorus` **(** :ref:`RID` voice **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice_get_filter_cutoff` **(** :ref:`RID` voice **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice_get_filter_resonance` **(** :ref:`RID` voice **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`voice_get_filter_type` **(** :ref:`RID` voice **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`voice_get_mix_rate` **(** :ref:`RID` voice **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice_get_pan` **(** :ref:`RID` voice **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice_get_pan_depth` **(** :ref:`RID` voice **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice_get_pan_height` **(** :ref:`RID` voice **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice_get_reverb` **(** :ref:`RID` voice **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`voice_get_reverb_type` **(** :ref:`RID` voice **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice_get_volume` **(** :ref:`RID` voice **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`voice_is_positional` **(** :ref:`RID` voice **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voice_play` **(** :ref:`RID` voice, :ref:`RID` sample **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voice_set_chorus` **(** :ref:`RID` voice, :ref:`float` chorus **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voice_set_filter` **(** :ref:`RID` voice, :ref:`int` type, :ref:`float` cutoff, :ref:`float` resonance, :ref:`float` gain=0 **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voice_set_mix_rate` **(** :ref:`RID` voice, :ref:`int` rate **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voice_set_pan` **(** :ref:`RID` voice, :ref:`float` pan, :ref:`float` depth=0, :ref:`float` height=0 **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voice_set_positional` **(** :ref:`RID` voice, :ref:`bool` enabled **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voice_set_reverb` **(** :ref:`RID` voice, :ref:`int` room, :ref:`float` reverb **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voice_set_volume` **(** :ref:`RID` voice, :ref:`float` volume **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voice_stop` **(** :ref:`RID` voice **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bus` **(** :ref:`int` at_pos=-1 **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bus_effect` **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` arg2=-1 **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioBusLayout` | :ref:`generate_bus_layout` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bus_count` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioEffect` | :ref:`get_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_bus_effect_count` **(** :ref:`int` bus_idx, :ref:`Object` arg1, :ref:`int` arg2 **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bus_name` **(** :ref:`int` bus_idx **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bus_peak_volume_left_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bus_peak_volume_right_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bus_send` **(** :ref:`int` bus_idx **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bus_volume_db` **(** :ref:`int` bus_idx **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_mix_rate` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_speaker_mode` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_bus_bypassing_effects` **(** :ref:`int` bus_idx **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_bus_mute` **(** :ref:`int` bus_idx **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_bus_solo` **(** :ref:`int` bus_idx **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lock` **(** **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_bus` **(** :ref:`int` index, :ref:`int` to_index **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_bus` **(** :ref:`int` index **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_bypass_effects` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_count` **(** :ref:`int` amount **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`bool` enabled **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_layout` **(** :ref:`AudioBusLayout` bus_layout **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_mute` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_name` **(** :ref:`int` bus_idx, :ref:`String` name **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_send` **(** :ref:`int` bus_idx, :ref:`String` send **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_solo` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_volume_db` **(** :ref:`int` bus_idx, :ref:`float` volume_db **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`swap_bus_effects` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` by_effect_idx **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`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` rid **)** +- void **add_bus** **(** :ref:`int` at_pos=-1 **)** -Free a :ref:`RID` resource. +.. _class_AudioServer_add_bus_effect: -.. _class_AudioServer_get_event_voice_global_volume_scale: +- void **add_bus_effect** **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` arg2=-1 **)** -- :ref:`float` **get_event_voice_global_volume_scale** **(** **)** const +.. _class_AudioServer_generate_bus_layout: -Return the global scale for event-based stream playback. +- :ref:`AudioBusLayout` **generate_bus_layout** **(** **)** const -.. _class_AudioServer_get_fx_global_volume_scale: +.. _class_AudioServer_get_bus_count: -- :ref:`float` **get_fx_global_volume_scale** **(** **)** const +- :ref:`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` **get_bus_effect** **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** -- :ref:`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` bus_idx, :ref:`Object` arg1, :ref:`int` arg2 **)** -.. _class_AudioServer_sample_create: +.. _class_AudioServer_get_bus_name: -- :ref:`RID` **sample_create** **(** :ref:`int` format, :ref:`bool` stereo, :ref:`int` length **)** +- :ref:`String` **get_bus_name** **(** :ref:`int` bus_idx **)** const -Create an audio sample, return a :ref:`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` **get_bus_peak_volume_left_db** **(** :ref:`int` bus_idx, :ref:`int` channel **)** const -.. _class_AudioServer_sample_get_data: +.. _class_AudioServer_get_bus_peak_volume_right_db: -- :ref:`RawArray` **sample_get_data** **(** :ref:`RID` sample **)** const +- :ref:`float` **get_bus_peak_volume_right_db** **(** :ref:`int` bus_idx, :ref:`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` **get_bus_send** **(** :ref:`int` bus_idx **)** const -- :ref:`String` **sample_get_description** **(** :ref:`RID` sample **)** const +.. _class_AudioServer_get_bus_volume_db: -Return the description of an audio sample. Mainly used for organization. +- :ref:`float` **get_bus_volume_db** **(** :ref:`int` bus_idx **)** const -.. _class_AudioServer_sample_get_format: +.. _class_AudioServer_get_mix_rate: -- :ref:`int` **sample_get_format** **(** :ref:`RID` sample **)** const +- :ref:`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` **get_speaker_mode** **(** **)** const -- :ref:`int` **sample_get_length** **(** :ref:`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` **is_bus_bypassing_effects** **(** :ref:`int` bus_idx **)** const -.. _class_AudioServer_sample_get_loop_begin: +.. _class_AudioServer_is_bus_effect_enabled: -- :ref:`int` **sample_get_loop_begin** **(** :ref:`RID` sample **)** const +- :ref:`bool` **is_bus_effect_enabled** **(** :ref:`int` bus_idx, :ref:`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_is_bus_mute: -.. _class_AudioServer_sample_get_loop_end: +- :ref:`bool` **is_bus_mute** **(** :ref:`int` bus_idx **)** const -- :ref:`int` **sample_get_loop_end** **(** :ref:`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`. +- :ref:`bool` **is_bus_solo** **(** :ref:`int` bus_idx **)** const -.. _class_AudioServer_sample_get_loop_format: +.. _class_AudioServer_lock: -- :ref:`int` **sample_get_loop_format** **(** :ref:`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` index, :ref:`int` to_index **)** -- :ref:`int` **sample_get_mix_rate** **(** :ref:`RID` sample **)** const +.. _class_AudioServer_remove_bus: -Return the mix rate of the given sample. +- void **remove_bus** **(** :ref:`int` index **)** -.. _class_AudioServer_sample_is_stereo: +.. _class_AudioServer_remove_bus_effect: -- :ref:`bool` **sample_is_stereo** **(** :ref:`RID` sample **)** const +- void **remove_bus_effect** **(** :ref:`int` bus_idx, :ref:`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` bus_idx, :ref:`bool` enable **)** -- void **sample_set_data** **(** :ref:`RID` sample, :ref:`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` amount **)** -Get the sample length (:ref:`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` bus_idx, :ref:`int` effect_idx, :ref:`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`), multiply it by 2. +- void **set_bus_layout** **(** :ref:`AudioBusLayout` bus_layout **)** -.. _class_AudioServer_sample_set_description: +.. _class_AudioServer_set_bus_mute: -- void **sample_set_description** **(** :ref:`RID` sample, :ref:`String` description **)** +- void **set_bus_mute** **(** :ref:`int` bus_idx, :ref:`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` bus_idx, :ref:`String` name **)** -- void **sample_set_loop_begin** **(** :ref:`RID` sample, :ref:`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`. +- void **set_bus_send** **(** :ref:`int` bus_idx, :ref:`String` send **)** -.. _class_AudioServer_sample_set_loop_end: +.. _class_AudioServer_set_bus_solo: -- void **sample_set_loop_end** **(** :ref:`RID` sample, :ref:`int` pos **)** +- void **set_bus_solo** **(** :ref:`int` bus_idx, :ref:`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_set_bus_volume_db: -.. _class_AudioServer_sample_set_loop_format: +- void **set_bus_volume_db** **(** :ref:`int` bus_idx, :ref:`float` volume_db **)** -- void **sample_set_loop_format** **(** :ref:`RID` sample, :ref:`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` bus_idx, :ref:`int` effect_idx, :ref:`int` by_effect_idx **)** -.. _class_AudioServer_sample_set_mix_rate: +.. _class_AudioServer_unlock: -- void **sample_set_mix_rate** **(** :ref:`RID` sample, :ref:`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` sample, :ref:`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`. - -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` scale **)** - -Set global scale for event-based stream (:ref:`EventStream`) playback. Default is 1.0. - -.. _class_AudioServer_set_fx_global_volume_scale: - -- void **set_fx_global_volume_scale** **(** :ref:`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` scale **)** - -Set global scale for stream playback. Default is 1.0. - -.. _class_AudioServer_voice_create: - -- :ref:`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_voice_get_chorus: - -- :ref:`float` **voice_get_chorus** **(** :ref:`RID` voice **)** const - -Return the current chorus send for a given voice (0 to 1). - -.. _class_AudioServer_voice_get_filter_cutoff: - -- :ref:`float` **voice_get_filter_cutoff** **(** :ref:`RID` voice **)** const - -Return the current filter cutoff (in hz) for a given voice. - -.. _class_AudioServer_voice_get_filter_resonance: - -- :ref:`float` **voice_get_filter_resonance** **(** :ref:`RID` voice **)** const - -Return the current filter resonance for a given voice. - -.. _class_AudioServer_voice_get_filter_type: - -- :ref:`int` **voice_get_filter_type** **(** :ref:`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` **voice_get_mix_rate** **(** :ref:`RID` voice **)** const - -Return the current mix rate for a given voice. - -.. _class_AudioServer_voice_get_pan: - -- :ref:`float` **voice_get_pan** **(** :ref:`RID` voice **)** const - -Return the current pan for a given voice (-1 to +1 range). - -.. _class_AudioServer_voice_get_pan_depth: - -- :ref:`float` **voice_get_pan_depth** **(** :ref:`RID` voice **)** const - -Return the current pan depth for a given voice (-1 to +1 range). - -.. _class_AudioServer_voice_get_pan_height: - -- :ref:`float` **voice_get_pan_height** **(** :ref:`RID` voice **)** const - -Return the current pan height for a given voice (-1 to +1 range). - -.. _class_AudioServer_voice_get_reverb: - -- :ref:`float` **voice_get_reverb** **(** :ref:`RID` voice **)** const - -Return the current reverb send for a given voice (0 to 1). - -.. _class_AudioServer_voice_get_reverb_type: - -- :ref:`int` **voice_get_reverb_type** **(** :ref:`RID` voice **)** const - -Return the current reverb type for a given voice from the REVERB\_\* enum. - -.. _class_AudioServer_voice_get_volume: - -- :ref:`float` **voice_get_volume** **(** :ref:`RID` voice **)** const - -Return the current volume for a given voice. - -.. _class_AudioServer_voice_is_positional: - -- :ref:`bool` **voice_is_positional** **(** :ref:`RID` voice **)** const - -Return whether the current voice is positional. See :ref:`voice_set_positional`. - -.. _class_AudioServer_voice_play: - -- void **voice_play** **(** :ref:`RID` voice, :ref:`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` voice, :ref:`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` voice, :ref:`int` type, :ref:`float` cutoff, :ref:`float` resonance, :ref:`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` voice, :ref:`int` rate **)** - -Set a different playback mix rate for the given voice. - -.. _class_AudioServer_voice_set_pan: - -- void **voice_set_pan** **(** :ref:`RID` voice, :ref:`float` pan, :ref:`float` depth=0, :ref:`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` voice, :ref:`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` voice, :ref:`int` room, :ref:`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` voice, :ref:`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` voice **)** - -Stop a given voice. +- void **unlock** **(** **)** diff --git a/classes/class_audioserversw.rst b/classes/class_audioserversw.rst deleted file mode 100644 index 0a0441204..000000000 --- a/classes/class_audioserversw.rst +++ /dev/null @@ -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` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Software implementation of :ref:`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. - diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index 7118cf108..8b363150b 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -8,7 +8,7 @@ AudioStream **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`AudioStreamMPC`, :ref:`AudioStreamOGGVorbis`, :ref:`AudioStreamOpus` +**Inherited By:** :ref:`AudioStreamSample`, :ref:`AudioStreamOGGVorbis` **Category:** Core diff --git a/classes/class_audiostreammpc.rst b/classes/class_audiostreammpc.rst deleted file mode 100644 index b9d0fffee..000000000 --- a/classes/class_audiostreammpc.rst +++ /dev/null @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -MusePack audio stream driver. - -Description ------------ - -MusePack audio stream driver. - diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index 317247aa8..4be97ee72 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -15,8 +15,47 @@ Brief Description OGG Vorbis audio stream driver. +Member Functions +---------------- + ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_loop` **(** **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_data` **(** :ref:`PoolByteArray` data **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_loop` **(** :ref:`bool` enable **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`PoolByteArray` **data** +- :ref:`bool` **loop** + Description ----------- OGG Vorbis audio stream driver. +Member Function Description +--------------------------- + +.. _class_AudioStreamOGGVorbis_get_data: + +- :ref:`PoolByteArray` **get_data** **(** **)** const + +.. _class_AudioStreamOGGVorbis_has_loop: + +- :ref:`bool` **has_loop** **(** **)** const + +.. _class_AudioStreamOGGVorbis_set_data: + +- void **set_data** **(** :ref:`PoolByteArray` data **)** + +.. _class_AudioStreamOGGVorbis_set_loop: + +- void **set_loop** **(** :ref:`bool` enable **)** + + diff --git a/classes/class_audiostreamopus.rst b/classes/class_audiostreamopus.rst deleted file mode 100644 index 7d511bb40..000000000 --- a/classes/class_audiostreamopus.rst +++ /dev/null @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Opus Codec audio stream driver. - -Description ------------ - -Opus Codec audio stream driver. - diff --git a/classes/class_audiostreamplayback.rst b/classes/class_audiostreamplayback.rst index 93f2f675f..ba2ccece3 100644 --- a/classes/class_audiostreamplayback.rst +++ b/classes/class_audiostreamplayback.rst @@ -15,84 +15,3 @@ Brief Description -Member Functions ----------------- - -+----------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_channels` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_length` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_loop_count` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_minimum_buffer_size` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mix_rate` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pos` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_loop` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_pos_sec=0 **)** | -+----------------------------+------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek_pos` **(** :ref:`float` pos **)** | -+----------------------------+------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop` **(** :ref:`bool` enabled **)** | -+----------------------------+------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+----------------------------+------------------------------------------------------------------------------------------------------+ - -Member Function Description ---------------------------- - -.. _class_AudioStreamPlayback_get_channels: - -- :ref:`int` **get_channels** **(** **)** const - -.. _class_AudioStreamPlayback_get_length: - -- :ref:`float` **get_length** **(** **)** const - -.. _class_AudioStreamPlayback_get_loop_count: - -- :ref:`int` **get_loop_count** **(** **)** const - -.. _class_AudioStreamPlayback_get_minimum_buffer_size: - -- :ref:`int` **get_minimum_buffer_size** **(** **)** const - -.. _class_AudioStreamPlayback_get_mix_rate: - -- :ref:`int` **get_mix_rate** **(** **)** const - -.. _class_AudioStreamPlayback_get_pos: - -- :ref:`float` **get_pos** **(** **)** const - -.. _class_AudioStreamPlayback_has_loop: - -- :ref:`bool` **has_loop** **(** **)** const - -.. _class_AudioStreamPlayback_is_playing: - -- :ref:`bool` **is_playing** **(** **)** const - -.. _class_AudioStreamPlayback_play: - -- void **play** **(** :ref:`float` from_pos_sec=0 **)** - -.. _class_AudioStreamPlayback_seek_pos: - -- void **seek_pos** **(** :ref:`float` pos **)** - -.. _class_AudioStreamPlayback_set_loop: - -- void **set_loop** **(** :ref:`bool` enabled **)** - -.. _class_AudioStreamPlayback_stop: - -- void **stop** **(** **)** - - diff --git a/classes/class_audiostreamsample.rst b/classes/class_audiostreamsample.rst new file mode 100644 index 000000000..9aa43311e --- /dev/null +++ b/classes/class_audiostreamsample.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_format` **(** **)** const | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_loop_begin` **(** **)** const | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_loop_end` **(** **)** const | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_loop_mode` **(** **)** const | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mix_rate` **(** **)** const | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_stereo` **(** **)** const | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_data` **(** :ref:`PoolByteArray` data **)** | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_format` **(** :ref:`int` format **)** | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_loop_begin` **(** :ref:`int` loop_begin **)** | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_loop_end` **(** :ref:`int` loop_end **)** | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_loop_mode` **(** :ref:`int` loop_mode **)** | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mix_rate` **(** :ref:`int` mix_rate **)** | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stereo` **(** :ref:`bool` stereo **)** | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`PoolByteArray` **data** +- :ref:`int` **format** +- :ref:`int` **loop_begin** +- :ref:`int` **loop_end** +- :ref:`int` **loop_mode** +- :ref:`int` **mix_rate** +- :ref:`bool` **stereo** + +Member Function Description +--------------------------- + +.. _class_AudioStreamSample_get_data: + +- :ref:`PoolByteArray` **get_data** **(** **)** const + +.. _class_AudioStreamSample_get_format: + +- :ref:`int` **get_format** **(** **)** const + +.. _class_AudioStreamSample_get_loop_begin: + +- :ref:`int` **get_loop_begin** **(** **)** const + +.. _class_AudioStreamSample_get_loop_end: + +- :ref:`int` **get_loop_end** **(** **)** const + +.. _class_AudioStreamSample_get_loop_mode: + +- :ref:`int` **get_loop_mode** **(** **)** const + +.. _class_AudioStreamSample_get_mix_rate: + +- :ref:`int` **get_mix_rate** **(** **)** const + +.. _class_AudioStreamSample_is_stereo: + +- :ref:`bool` **is_stereo** **(** **)** const + +.. _class_AudioStreamSample_set_data: + +- void **set_data** **(** :ref:`PoolByteArray` data **)** + +.. _class_AudioStreamSample_set_format: + +- void **set_format** **(** :ref:`int` format **)** + +.. _class_AudioStreamSample_set_loop_begin: + +- void **set_loop_begin** **(** :ref:`int` loop_begin **)** + +.. _class_AudioStreamSample_set_loop_end: + +- void **set_loop_end** **(** :ref:`int` loop_end **)** + +.. _class_AudioStreamSample_set_loop_mode: + +- void **set_loop_mode** **(** :ref:`int` loop_mode **)** + +.. _class_AudioStreamSample_set_mix_rate: + +- void **set_mix_rate** **(** :ref:`int` mix_rate **)** + +.. _class_AudioStreamSample_set_stereo: + +- void **set_stereo** **(** :ref:`bool` stereo **)** + + diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index 982a2931c..5d1347322 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_rect` **(** :ref:`Rect2` rect **)** | +----------------------------+--------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **copy_mode** +- :ref:`Rect2` **rect** + Numeric Constants ----------------- diff --git a/classes/class_bakedlight.rst b/classes/class_bakedlight.rst index aa221b755..62310ae8c 100644 --- a/classes/class_bakedlight.rst +++ b/classes/class_bakedlight.rst @@ -6,7 +6,7 @@ BakedLight ========== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core @@ -18,314 +18,61 @@ Brief Description Member Functions ---------------- -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_lightmap` **(** :ref:`Texture` texture, :ref:`Vector2` gen_size **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_lightmaps` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_lightmap` **(** :ref:`int` id **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ao_radius` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ao_strength` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_bake_flag` **(** :ref:`int` flag **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bounces` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_cell_extra_margin` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell_subdivision` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_edge_damp` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_energy_multiplier` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_format` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gamma_adjust` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_initial_lattice_subdiv` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`get_light` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_normal_damp` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`get_octree` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_plot_size` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_realtime_color` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_realtime_color_enabled` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_realtime_energy` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`IntArray` | :ref:`get_sampler_octree` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_saturation` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tint` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_transfer_lightmaps_only_to_uv2` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ao_radius` **(** :ref:`float` ao_radius **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ao_strength` **(** :ref:`float` ao_strength **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_flag` **(** :ref:`int` flag, :ref:`bool` enabled **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bounces` **(** :ref:`int` bounces **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_extra_margin` **(** :ref:`float` cell_extra_margin **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_subdivision` **(** :ref:`int` cell_subdivision **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_edge_damp` **(** :ref:`float` edge_damp **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_energy_multiplier` **(** :ref:`float` energy_multiplier **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_format` **(** :ref:`int` format **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gamma_adjust` **(** :ref:`float` gamma_adjust **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_initial_lattice_subdiv` **(** :ref:`int` cell_subdivision **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_light` **(** :ref:`RawArray` light **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal_damp` **(** :ref:`float` normal_damp **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_octree` **(** :ref:`RawArray` octree **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_plot_size` **(** :ref:`float` plot_size **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_realtime_color` **(** :ref:`Color` tint **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_realtime_color_enabled` **(** :ref:`bool` enabled **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_realtime_energy` **(** :ref:`float` energy **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sampler_octree` **(** :ref:`IntArray` sampler_octree **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_saturation` **(** :ref:`float` saturation **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tint` **(** :ref:`float` tint **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transfer_lightmaps_only_to_uv2` **(** :ref:`bool` enable **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------+----------------------------------------------------------------------------------------------------+ +| void | :ref:`bake` **(** **)** | ++------------------------+----------------------------------------------------------------------------------------------------+ +| void | :ref:`bake_lights` **(** **)** | ++------------------------+----------------------------------------------------------------------------------------------------+ +| void | :ref:`bake_radiance` **(** **)** | ++------------------------+----------------------------------------------------------------------------------------------------+ +| void | :ref:`debug_mesh_albedo` **(** **)** | ++------------------------+----------------------------------------------------------------------------------------------------+ +| void | :ref:`debug_mesh_light` **(** **)** | ++------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cell_subdiv` **(** **)** const | ++------------------------+----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_subdiv` **(** :ref:`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` **cell_subdiv** Member Function Description --------------------------- -.. _class_BakedLight_add_lightmap: +.. _class_BakedLight_bake: -- void **add_lightmap** **(** :ref:`Texture` texture, :ref:`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` id **)** +- void **bake_radiance** **(** **)** -.. _class_BakedLight_get_ao_radius: +.. _class_BakedLight_debug_mesh_albedo: -- :ref:`float` **get_ao_radius** **(** **)** const +- void **debug_mesh_albedo** **(** **)** -.. _class_BakedLight_get_ao_strength: +.. _class_BakedLight_debug_mesh_light: -- :ref:`float` **get_ao_strength** **(** **)** const +- void **debug_mesh_light** **(** **)** -.. _class_BakedLight_get_bake_flag: +.. _class_BakedLight_get_cell_subdiv: -- :ref:`bool` **get_bake_flag** **(** :ref:`int` flag **)** const +- :ref:`int` **get_cell_subdiv** **(** **)** const -.. _class_BakedLight_get_bounces: +.. _class_BakedLight_set_cell_subdiv: -- :ref:`int` **get_bounces** **(** **)** const - -.. _class_BakedLight_get_cell_extra_margin: - -- :ref:`float` **get_cell_extra_margin** **(** **)** const - -.. _class_BakedLight_get_cell_subdivision: - -- :ref:`int` **get_cell_subdivision** **(** **)** const - -.. _class_BakedLight_get_edge_damp: - -- :ref:`float` **get_edge_damp** **(** **)** const - -.. _class_BakedLight_get_energy_multiplier: - -- :ref:`float` **get_energy_multiplier** **(** **)** const - -.. _class_BakedLight_get_format: - -- :ref:`int` **get_format** **(** **)** const - -.. _class_BakedLight_get_gamma_adjust: - -- :ref:`float` **get_gamma_adjust** **(** **)** const - -.. _class_BakedLight_get_initial_lattice_subdiv: - -- :ref:`int` **get_initial_lattice_subdiv** **(** **)** const - -.. _class_BakedLight_get_light: - -- :ref:`RawArray` **get_light** **(** **)** const - -.. _class_BakedLight_get_mode: - -- :ref:`int` **get_mode** **(** **)** const - -.. _class_BakedLight_get_normal_damp: - -- :ref:`float` **get_normal_damp** **(** **)** const - -.. _class_BakedLight_get_octree: - -- :ref:`RawArray` **get_octree** **(** **)** const - -.. _class_BakedLight_get_plot_size: - -- :ref:`float` **get_plot_size** **(** **)** const - -.. _class_BakedLight_get_realtime_color: - -- :ref:`Color` **get_realtime_color** **(** **)** const - -.. _class_BakedLight_get_realtime_color_enabled: - -- :ref:`bool` **get_realtime_color_enabled** **(** **)** const - -.. _class_BakedLight_get_realtime_energy: - -- :ref:`float` **get_realtime_energy** **(** **)** const - -.. _class_BakedLight_get_sampler_octree: - -- :ref:`IntArray` **get_sampler_octree** **(** **)** const - -.. _class_BakedLight_get_saturation: - -- :ref:`float` **get_saturation** **(** **)** const - -.. _class_BakedLight_get_tint: - -- :ref:`float` **get_tint** **(** **)** const - -.. _class_BakedLight_get_transfer_lightmaps_only_to_uv2: - -- :ref:`bool` **get_transfer_lightmaps_only_to_uv2** **(** **)** const - -.. _class_BakedLight_set_ao_radius: - -- void **set_ao_radius** **(** :ref:`float` ao_radius **)** - -.. _class_BakedLight_set_ao_strength: - -- void **set_ao_strength** **(** :ref:`float` ao_strength **)** - -.. _class_BakedLight_set_bake_flag: - -- void **set_bake_flag** **(** :ref:`int` flag, :ref:`bool` enabled **)** - -.. _class_BakedLight_set_bounces: - -- void **set_bounces** **(** :ref:`int` bounces **)** - -.. _class_BakedLight_set_cell_extra_margin: - -- void **set_cell_extra_margin** **(** :ref:`float` cell_extra_margin **)** - -.. _class_BakedLight_set_cell_subdivision: - -- void **set_cell_subdivision** **(** :ref:`int` cell_subdivision **)** - -.. _class_BakedLight_set_edge_damp: - -- void **set_edge_damp** **(** :ref:`float` edge_damp **)** - -.. _class_BakedLight_set_energy_multiplier: - -- void **set_energy_multiplier** **(** :ref:`float` energy_multiplier **)** - -.. _class_BakedLight_set_format: - -- void **set_format** **(** :ref:`int` format **)** - -.. _class_BakedLight_set_gamma_adjust: - -- void **set_gamma_adjust** **(** :ref:`float` gamma_adjust **)** - -.. _class_BakedLight_set_initial_lattice_subdiv: - -- void **set_initial_lattice_subdiv** **(** :ref:`int` cell_subdivision **)** - -.. _class_BakedLight_set_light: - -- void **set_light** **(** :ref:`RawArray` light **)** - -.. _class_BakedLight_set_mode: - -- void **set_mode** **(** :ref:`int` mode **)** - -.. _class_BakedLight_set_normal_damp: - -- void **set_normal_damp** **(** :ref:`float` normal_damp **)** - -.. _class_BakedLight_set_octree: - -- void **set_octree** **(** :ref:`RawArray` octree **)** - -.. _class_BakedLight_set_plot_size: - -- void **set_plot_size** **(** :ref:`float` plot_size **)** - -.. _class_BakedLight_set_realtime_color: - -- void **set_realtime_color** **(** :ref:`Color` tint **)** - -.. _class_BakedLight_set_realtime_color_enabled: - -- void **set_realtime_color_enabled** **(** :ref:`bool` enabled **)** - -.. _class_BakedLight_set_realtime_energy: - -- void **set_realtime_energy** **(** :ref:`float` energy **)** - -.. _class_BakedLight_set_sampler_octree: - -- void **set_sampler_octree** **(** :ref:`IntArray` sampler_octree **)** - -.. _class_BakedLight_set_saturation: - -- void **set_saturation** **(** :ref:`float` saturation **)** - -.. _class_BakedLight_set_tint: - -- void **set_tint** **(** :ref:`float` tint **)** - -.. _class_BakedLight_set_transfer_lightmaps_only_to_uv2: - -- void **set_transfer_lightmaps_only_to_uv2** **(** :ref:`bool` enable **)** +- void **set_cell_subdiv** **(** :ref:`int` steps **)** diff --git a/classes/class_bakedlightinstance.rst b/classes/class_bakedlightinstance.rst deleted file mode 100644 index ba7e192e2..000000000 --- a/classes/class_bakedlightinstance.rst +++ /dev/null @@ -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` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - -Member Functions ----------------- - -+------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_baked_light` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_baked_light_instance` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_baked_light` **(** :ref:`Object` baked_light **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------+ - -Signals -------- - -- **baked_light_changed** **(** **)** - -Member Function Description ---------------------------- - -.. _class_BakedLightInstance_get_baked_light: - -- :ref:`Object` **get_baked_light** **(** **)** const - -.. _class_BakedLightInstance_get_baked_light_instance: - -- :ref:`RID` **get_baked_light_instance** **(** **)** const - -.. _class_BakedLightInstance_set_baked_light: - -- void **set_baked_light** **(** :ref:`Object` baked_light **)** - - diff --git a/classes/class_bakedlightsampler.rst b/classes/class_bakedlightsampler.rst deleted file mode 100644 index 4f41c2016..000000000 --- a/classes/class_bakedlightsampler.rst +++ /dev/null @@ -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` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - -Member Functions ----------------- - -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_resolution` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_resolution` **(** :ref:`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` **get_param** **(** :ref:`int` param **)** const - -.. _class_BakedLightSampler_get_resolution: - -- :ref:`int` **get_resolution** **(** **)** const - -.. _class_BakedLightSampler_set_param: - -- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** - -.. _class_BakedLightSampler_set_resolution: - -- void **set_resolution** **(** :ref:`int` resolution **)** - - diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index fda01376a..c0e99037c 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -20,39 +20,43 @@ Provides a base class for different kinds of buttons. Member Functions ---------------- -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_pressed` **(** **)** virtual | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_toggled` **(** :ref:`bool` pressed **)** virtual | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_click_on_press` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_draw_mode` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_enabled_focus_mode` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_shortcut` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_disabled` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hovered` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_toggle_mode` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_click_on_press` **(** :ref:`bool` enable **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled_focus_mode` **(** :ref:`int` mode **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shortcut` **(** :ref:`Object` shortcut **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_toggle_mode` **(** :ref:`bool` enabled **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_pressed` **(** **)** virtual | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_toggled` **(** :ref:`bool` pressed **)** virtual | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_action_mode` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_button_group` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_draw_mode` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_enabled_focus_mode` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_shortcut` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_disabled` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_hovered` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pressed` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_toggle_mode` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_action_mode` **(** :ref:`int` mode **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button_group` **(** :ref:`Object` button_group **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enabled_focus_mode` **(** :ref:`int` mode **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shortcut` **(** :ref:`Object` shortcut **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_toggle_mode` **(** :ref:`bool` enabled **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -60,9 +64,19 @@ Signals - **button_down** **(** **)** - **button_up** **(** **)** - **pressed** **(** **)** -- **released** **(** **)** - **toggled** **(** :ref:`bool` pressed **)** +Member Variables +---------------- + +- :ref:`int` **action_mode** +- :ref:`bool` **disabled** +- :ref:`int` **enabled_focus_mode** +- :ref:`ButtonGroup` **group** +- :ref:`bool` **is_pressed** +- :ref:`ShortCut` **shortcut** +- :ref:`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` **get_click_on_press** **(** **)** const +- :ref:`int` **get_action_mode** **(** **)** const -Return the state of the click_on_press property (see :ref:`set_click_on_press`). +Return the current mode of action (see :ref:`set_action_mode`) (one of the ACTION_MODE\_\* constants). + +.. _class_BaseButton_get_button_group: + +- :ref:`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_click_on_press: +.. _class_BaseButton_set_action_mode: -- void **set_click_on_press** **(** :ref:`bool` enable **)** +- void **set_action_mode** **(** :ref:`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` button_group **)** .. _class_BaseButton_set_disabled: diff --git a/classes/class_matrix3.rst b/classes/class_basis.rst similarity index 53% rename from classes/class_matrix3.rst rename to classes/class_basis.rst index 4cb812341..97723e033 100644 --- a/classes/class_matrix3.rst +++ b/classes/class_basis.rst @@ -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` | :ref:`Matrix3` **(** :ref:`Quat` from **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix3` | :ref:`Matrix3` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix3` | :ref:`Matrix3` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`determinant` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_euler` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_orthogonal_index` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_scale` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix3` | :ref:`inverse` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix3` | :ref:`orthonormalized` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix3` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix3` | :ref:`scaled` **(** :ref:`Vector3` scale **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tdotx` **(** :ref:`Vector3` with **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tdoty` **(** :ref:`Vector3` with **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tdotz` **(** :ref:`Vector3` with **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix3` | :ref:`transposed` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`xform` **(** :ref:`Vector3` v **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`xform_inv` **(** :ref:`Vector3` v **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Quat` from **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`determinant` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_euler` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_orthogonal_index` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_scale` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`inverse` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`orthonormalized` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`scaled` **(** :ref:`Vector3` scale **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tdotx` **(** :ref:`Vector3` with **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tdoty` **(** :ref:`Vector3` with **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tdotz` **(** :ref:`Vector3` with **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`transposed` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`xform` **(** :ref:`Vector3` v **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`xform_inv` **(** :ref:`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`. +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`. + +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` **Matrix3** **(** :ref:`Quat` from **)** +- :ref:`Basis` **Basis** **(** :ref:`Quat` from **)** -Create a matrix from a quaternion. +Create a rotation matrix from the given quaternion. -.. _class_Matrix3_Matrix3: +.. _class_Basis_Basis: -- :ref:`Matrix3` **Matrix3** **(** :ref:`Vector3` axis, :ref:`float` phi **)** +- :ref:`Basis` **Basis** **(** :ref:`Vector3` axis, :ref:`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` **Matrix3** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** +- :ref:`Basis` **Basis** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** Create a matrix from 3 axis vectors. -.. _class_Matrix3_determinant: +.. _class_Basis_determinant: - :ref:`float` **determinant** **(** **)** Return the determinant of the matrix. -.. _class_Matrix3_get_euler: +.. _class_Basis_get_euler: - :ref:`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` **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` **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` **inverse** **(** **)** +.. _class_Basis_inverse: -Return the affine inverse of the matrix. +- :ref:`Basis` **inverse** **(** **)** -.. _class_Matrix3_orthonormalized: +Return the inverse of the matrix. -- :ref:`Matrix3` **orthonormalized** **(** **)** +.. _class_Basis_orthonormalized: + +- :ref:`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` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** +- :ref:`Basis` **rotated** **(** :ref:`Vector3` axis, :ref:`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`. The axis must be a normalized vector. -- :ref:`Matrix3` **scaled** **(** :ref:`Vector3` scale **)** +.. _class_Basis_scaled: -Return the scaled version of the matrix, by a 3D scale. +- :ref:`Basis` **scaled** **(** :ref:`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_Basis_tdotx: - :ref:`float` **tdotx** **(** :ref:`Vector3` with **)** Transposed dot product with the x axis of the matrix. -.. _class_Matrix3_tdoty: +.. _class_Basis_tdoty: - :ref:`float` **tdoty** **(** :ref:`Vector3` with **)** Transposed dot product with the y axis of the matrix. -.. _class_Matrix3_tdotz: +.. _class_Basis_tdotz: - :ref:`float` **tdotz** **(** :ref:`Vector3` with **)** Transposed dot product with the z axis of the matrix. -.. _class_Matrix3_transposed: +.. _class_Basis_transposed: -- :ref:`Matrix3` **transposed** **(** **)** +- :ref:`Basis` **transposed** **(** **)** Return the transposed version of the matrix. -.. _class_Matrix3_xform: +.. _class_Basis_xform: - :ref:`Vector3` **xform** **(** :ref:`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` **xform_inv** **(** :ref:`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. diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index 98aad1e7f..545cb51db 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -34,6 +34,11 @@ Member Functions | void | :ref:`set_bit_rect` **(** :ref:`Rect2` p_rect, :ref:`bool` bit **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Dictionary` **data** + Member Function Description --------------------------- diff --git a/classes/class_bitmapfont.rst b/classes/class_bitmapfont.rst index 681c35778..66998ea12 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -48,6 +48,17 @@ Member Functions | void | :ref:`set_height` **(** :ref:`float` px **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **ascent** +- :ref:`PoolIntArray` **chars** +- :ref:`bool` **distance_field** +- :ref:`BitmapFont` **fallback** +- :ref:`float` **height** +- :ref:`PoolIntArray` **kernings** +- :ref:`Array` **textures** + Member Function Description --------------------------- diff --git a/classes/class_boneattachment.rst b/classes/class_boneattachment.rst index b8432743e..1682cb18d 100644 --- a/classes/class_boneattachment.rst +++ b/classes/class_boneattachment.rst @@ -15,8 +15,29 @@ Brief Description A node that will attach to a bone. +Member Functions +---------------- + ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bone_name` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_name` **(** :ref:`String` bone_name **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ + Description ----------- This node must be the child of a :ref:`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` **get_bone_name** **(** **)** const + +.. _class_BoneAttachment_set_bone_name: + +- void **set_bone_name** **(** :ref:`String` bone_name **)** + + diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index 69993e069..dadb71e8c 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -8,7 +8,7 @@ BoxContainer **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`VBoxContainer`, :ref:`ButtonGroup`, :ref:`HBoxContainer`, :ref:`ColorPicker` +**Inherited By:** :ref:`VBoxContainer`, :ref:`HBoxContainer`, :ref:`ColorPicker` **Category:** Core @@ -28,6 +28,11 @@ Member Functions | void | :ref:`set_alignment` **(** :ref:`int` alignment **)** | +------------------------+------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **alignment** + Numeric Constants ----------------- diff --git a/classes/class_boxshape.rst b/classes/class_boxshape.rst index cb3b97b17..922dcbdee 100644 --- a/classes/class_boxshape.rst +++ b/classes/class_boxshape.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_extents` **(** :ref:`Vector3` extents **)** | +--------------------------------+----------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Vector3` **extents** + Description ----------- diff --git a/classes/class_button.rst b/classes/class_button.rst index 0d2af721b..480ebbef0 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -42,6 +42,15 @@ Member Functions | void | :ref:`set_text_align` **(** :ref:`int` align **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **align** +- :ref:`bool` **clip_text** +- :ref:`bool` **flat** +- :ref:`Texture` **icon** +- :ref:`String` **text** + Numeric Constants ----------------- diff --git a/classes/class_buttonarray.rst b/classes/class_buttonarray.rst index 4b73281fc..dc260936c 100644 --- a/classes/class_buttonarray.rst +++ b/classes/class_buttonarray.rst @@ -20,37 +20,50 @@ Array of Buttons. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_button` **(** :ref:`String` text **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_button` **(** :ref:`Texture` icon, :ref:`String` text="" **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_button` **(** :ref:`int` button_idx **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_button_count` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_button_icon` **(** :ref:`int` button_idx **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_button_text` **(** :ref:`int` button_idx **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_hovered` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selected` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button_icon` **(** :ref:`int` button_idx, :ref:`Texture` icon **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button_text` **(** :ref:`int` button_idx, :ref:`String` text **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_selected` **(** :ref:`int` button_idx **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_button` **(** :ref:`String` text, :ref:`String` tooltip="" **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_button` **(** :ref:`Texture` icon, :ref:`String` text="", :ref:`String` tooltip="" **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_button` **(** :ref:`int` button_idx **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_button_count` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_button_icon` **(** :ref:`int` button_idx **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_button_text` **(** :ref:`int` button_idx **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_button_tooltip` **(** :ref:`int` button_idx **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_hovered` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selected` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_flat` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button_icon` **(** :ref:`int` button_idx, :ref:`Texture` icon **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button_text` **(** :ref:`int` button_idx, :ref:`String` text **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button_tooltip` **(** :ref:`int` button_idx, :ref:`String` text **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flat` **(** :ref:`bool` enabled **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_selected` **(** :ref:`int` button_idx **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **button_selected** **(** :ref:`int` button_idx **)** +Member Variables +---------------- + +- :ref:`bool` **flat** + Numeric Constants ----------------- @@ -72,15 +85,15 @@ Member Function Description .. _class_ButtonArray_add_button: -- void **add_button** **(** :ref:`String` text **)** +- void **add_button** **(** :ref:`String` text, :ref:`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` icon, :ref:`String` text="" **)** +- void **add_icon_button** **(** :ref:`Texture` icon, :ref:`String` text="", :ref:`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` **get_button_tooltip** **(** :ref:`int` button_idx **)** const + +Return the tooltip of the specified button. + .. _class_ButtonArray_get_hovered: - :ref:`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` **is_flat** **(** **)** const + .. _class_ButtonArray_set_button_icon: - void **set_button_icon** **(** :ref:`int` button_idx, :ref:`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` button_idx, :ref:`String` text **)** + +Define the tooltip of the specified button. + +.. _class_ButtonArray_set_flat: + +- void **set_flat** **(** :ref:`bool` enabled **)** + .. _class_ButtonArray_set_selected: - void **set_selected** **(** :ref:`int` button_idx **)** diff --git a/classes/class_buttongroup.rst b/classes/class_buttongroup.rst index 23adf3ca1..e1c4bb1e0 100644 --- a/classes/class_buttongroup.rst +++ b/classes/class_buttongroup.rst @@ -6,7 +6,7 @@ ButtonGroup =========== -**Inherits:** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core @@ -18,17 +18,9 @@ Group of Buttons. Member Functions ---------------- -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_button_list` **(** **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BaseButton` | :ref:`get_focused_button` **(** **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BaseButton` | :ref:`get_pressed_button` **(** **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_pressed_button_index` **(** **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressed_button` **(** :ref:`BaseButton` button **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+------------------------------------------------------------------------------+ +| :ref:`BaseButton` | :ref:`get_pressed_button` **(** **)** | ++--------------------------------------+------------------------------------------------------------------------------+ Description ----------- @@ -38,34 +30,10 @@ Group of :ref:`Button`. All direct and indirect children buttons b Member Function Description --------------------------- -.. _class_ButtonGroup_get_button_list: - -- :ref:`Array` **get_button_list** **(** **)** const - -Return the list of all the buttons in the group. - -.. _class_ButtonGroup_get_focused_button: - -- :ref:`BaseButton` **get_focused_button** **(** **)** const - -Return the focused button. - .. _class_ButtonGroup_get_pressed_button: -- :ref:`BaseButton` **get_pressed_button** **(** **)** const +- :ref:`BaseButton` **get_pressed_button** **(** **)** Return the pressed button. -.. _class_ButtonGroup_get_pressed_button_index: - -- :ref:`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` button **)** - -Set the button to be pressed. - diff --git a/classes/class_camera.rst b/classes/class_camera.rst index 340f7b16c..12f2e1ca4 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -25,17 +25,21 @@ Member Functions +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform` | :ref:`get_camera_transform` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cull_mask` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Environment` | :ref:`get_environment` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_fov` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_h_offset` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_keep_aspect_mode` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_projection` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_size` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_visible_layers` **(** **)** const | +| :ref:`float` | :ref:`get_v_offset` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_zfar` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -55,15 +59,19 @@ Member Functions +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`project_ray_origin` **(** :ref:`Vector2` screen_point **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cull_mask` **(** :ref:`int` mask **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_environment` **(** :ref:`Environment` env **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_offset` **(** :ref:`float` ofs **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_keep_aspect_mode` **(** :ref:`int` mode **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_orthogonal` **(** :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_perspective` **(** :ref:`float` fov, :ref:`float` z_near, :ref:`float` z_far **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visible_layers` **(** :ref:`int` mask **)** | +| void | :ref:`set_v_offset` **(** :ref:`float` ofs **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`unproject_position` **(** :ref:`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` transform. +.. _class_Camera_get_cull_mask: + +- :ref:`int` **get_cull_mask** **(** **)** const + .. _class_Camera_get_environment: - :ref:`Environment` **get_environment** **(** **)** const @@ -102,6 +114,10 @@ Get the camera transform. Subclassed cameras (such as CharacterCamera) may provi - :ref:`float` **get_fov** **(** **)** const +.. _class_Camera_get_h_offset: + +- :ref:`float` **get_h_offset** **(** **)** const + .. _class_Camera_get_keep_aspect_mode: - :ref:`int` **get_keep_aspect_mode** **(** **)** const @@ -114,9 +130,9 @@ Get the camera transform. Subclassed cameras (such as CharacterCamera) may provi - :ref:`float` **get_size** **(** **)** const -.. _class_Camera_get_visible_layers: +.. _class_Camera_get_v_offset: -- :ref:`int` **get_visible_layers** **(** **)** const +- :ref:`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` 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` mask **)** + .. _class_Camera_set_environment: - void **set_environment** **(** :ref:`Environment` env **)** +.. _class_Camera_set_h_offset: + +- void **set_h_offset** **(** :ref:`float` ofs **)** + .. _class_Camera_set_keep_aspect_mode: - void **set_keep_aspect_mode** **(** :ref:`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` mask **)** +- void **set_v_offset** **(** :ref:`float` ofs **)** .. _class_Camera_unproject_position: diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index b738621a4..3d50d21bb 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -92,6 +92,28 @@ Member Functions | void | :ref:`set_zoom` **(** :ref:`Vector2` zoom **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **anchor_mode** +- :ref:`bool` **current** +- :ref:`float` **drag_margin_bottom** +- :ref:`bool` **drag_margin_h_enabled** +- :ref:`float` **drag_margin_left** +- :ref:`float` **drag_margin_right** +- :ref:`float` **drag_margin_top** +- :ref:`bool` **drag_margin_v_enabled** +- :ref:`int` **limit_bottom** +- :ref:`int` **limit_left** +- :ref:`int` **limit_right** +- :ref:`bool` **limit_smoothed** +- :ref:`int` **limit_top** +- :ref:`Vector2` **offset** +- :ref:`bool` **rotating** +- :ref:`bool` **smoothing_enabled** +- :ref:`float` **smoothing_speed** +- :ref:`Vector2` **zoom** + Numeric Constants ----------------- diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index c451df78a..6ad5091f0 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -20,119 +20,123 @@ Base class of anything 2D. Member Functions ---------------- -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_draw` **(** **)** virtual | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color(1,1,1,1) **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_circle` **(** :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_colored_polygon` **(** :ref:`Vector2Array` points, :ref:`Color` color, :ref:`Vector2Array` uvs=Vector2Array([]), :ref:`Texture` texture=NULL **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1, :ref:`bool` antialiased=false **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polygon` **(** :ref:`Vector2Array` points, :ref:`ColorArray` colors, :ref:`Vector2Array` uvs=Vector2Array([]), :ref:`Texture` texture=NULL **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_primitive` **(** :ref:`Vector2Array` points, :ref:`ColorArray` colors, :ref:`Vector2Array` uvs, :ref:`Texture` texture=NULL, :ref:`float` width=1 **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect` **(** :ref:`Rect2` rect, :ref:`Color` color **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_set_transform` **(** :ref:`Vector2` pos, :ref:`float` rot, :ref:`Vector2` scale **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_set_transform_matrix` **(** :ref:`Matrix32` xform **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`Color` modulate=Color(1,1,1,1), :ref:`int` clip_w=-1 **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_style_box` **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture` **(** :ref:`Texture` texture, :ref:`Vector2` pos, :ref:`Color` modulate=Color(1,1,1,1) **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture_rect` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture_rect_region` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`edit_get_state` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_rotate` **(** :ref:`float` degrees **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_set_rect` **(** :ref:`Rect2` rect **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_set_state` **(** :ref:`Variant` state **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_mode` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas_item` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`get_canvas_transform` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_mouse_pos` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`get_global_transform` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`get_global_transform_with_canvas` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_and_children_rect` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_light_mask` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_local_mouse_pos` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`CanvasItemMaterial` | :ref:`get_material` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_opacity` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_self_opacity` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`get_transform` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_use_parent_material` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`get_viewport_transform` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_world_2d` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hide` **(** **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_draw_behind_parent_enabled` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hidden` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`make_canvas_pos_local` **(** :ref:`Vector2` screen_point **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`InputEvent` | :ref:`make_input_local` **(** :ref:`InputEvent` event **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_mode` **(** :ref:`int` blend_mode **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_behind_parent` **(** :ref:`bool` enable **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hidden` **(** :ref:`bool` hidden **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_light_mask` **(** :ref:`int` light_mask **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`CanvasItemMaterial` material **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_opacity` **(** :ref:`float` opacity **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_self_opacity` **(** :ref:`float` self_opacity **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_parent_material` **(** :ref:`bool` enable **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show` **(** **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update` **(** **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_draw` **(** **)** virtual | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color(1,1,1,1) **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_circle` **(** :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_colored_polygon` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`Texture` texture=NULL **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1, :ref:`bool` antialiased=false **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_polygon` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`Texture` texture=NULL **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_primitive` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=NULL, :ref:`float` width=1 **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_rect` **(** :ref:`Rect2` rect, :ref:`Color` color **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_set_transform` **(** :ref:`Vector2` pos, :ref:`float` rot, :ref:`Vector2` scale **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_set_transform_matrix` **(** :ref:`Transform2D` xform **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`Color` modulate=Color(1,1,1,1), :ref:`int` clip_w=-1 **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_style_box` **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture` **(** :ref:`Texture` texture, :ref:`Vector2` pos, :ref:`Color` modulate=Color(1,1,1,1) **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture_rect` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture_rect_region` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`edit_get_state` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_rotate` **(** :ref:`float` degrees **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_set_rect` **(** :ref:`Rect2` rect **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_set_state` **(** :ref:`Variant` state **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_canvas` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_canvas_item` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_mouse_pos` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_global_transform` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_global_transform_with_canvas` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_and_children_rect` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_light_mask` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_local_mouse_pos` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ShaderMaterial` | :ref:`get_material` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_modulate` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_self_modulate` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_use_parent_material` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_viewport_transform` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_world_2d` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hide` **(** **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_draw_behind_parent_enabled` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_visible` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`make_canvas_pos_local` **(** :ref:`Vector2` screen_point **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`InputEvent` | :ref:`make_input_local` **(** :ref:`InputEvent` event **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_behind_parent` **(** :ref:`bool` enable **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_light_mask` **(** :ref:`int` light_mask **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material` **(** :ref:`ShaderMaterial` material **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_modulate` **(** :ref:`Color` modulate **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_self_modulate` **(** :ref:`Color` self_modulate **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_parent_material` **(** :ref:`bool` enable **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_visible` **(** :ref:`bool` arg0 **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`show` **(** **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update` **(** **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -142,6 +146,18 @@ Signals - **item_rect_changed** **(** **)** - **visibility_changed** **(** **)** +Member Variables +---------------- + +- :ref:`int` **light_mask** +- :ref:`ShaderMaterial` **material** +- :ref:`Color` **modulate** +- :ref:`Color` **self_modulate** +- :ref:`bool` **show_behind_parent** +- :ref:`bool` **show_on_top** +- :ref:`bool` **use_parent_material** +- :ref:`bool` **visible** + Numeric Constants ----------------- @@ -192,7 +208,7 @@ Draw a colored circle. .. _class_CanvasItem_draw_colored_polygon: -- void **draw_colored_polygon** **(** :ref:`Vector2Array` points, :ref:`Color` color, :ref:`Vector2Array` uvs=Vector2Array([]), :ref:`Texture` texture=NULL **)** +- void **draw_colored_polygon** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`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` points, :ref:`ColorArray` colors, :ref:`Vector2Array` uvs=Vector2Array([]), :ref:`Texture` texture=NULL **)** +- void **draw_polygon** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`Texture` texture=NULL **)** Draw a polygon of any amount of points, convex or concave. .. _class_CanvasItem_draw_primitive: -- void **draw_primitive** **(** :ref:`Vector2Array` points, :ref:`ColorArray` colors, :ref:`Vector2Array` uvs, :ref:`Texture` texture=NULL, :ref:`float` width=1 **)** +- void **draw_primitive** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=NULL, :ref:`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` xform **)** +- void **draw_set_transform_matrix** **(** :ref:`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`, this is an :ref:`Array` with (in order) a :ref:`Vector2` for position, a float for rotation and another :ref:`Vector2` for scale. For :ref:`Control` this is a :ref:`Rect2` with the position and size. -.. _class_CanvasItem_get_blend_mode: - -- :ref:`int` **get_blend_mode** **(** **)** const - -Return the current blending mode from enum BLEND_MODE\_\*. - .. _class_CanvasItem_get_canvas: - :ref:`RID` **get_canvas** **(** **)** const @@ -302,7 +312,7 @@ Return the canvas item RID used by :ref:`VisualServer` for t .. _class_CanvasItem_get_canvas_transform: -- :ref:`Matrix32` **get_canvas_transform** **(** **)** const +- :ref:`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` **get_global_transform** **(** **)** const +- :ref:`Transform2D` **get_global_transform** **(** **)** const Get the global transform matrix of this item. .. _class_CanvasItem_get_global_transform_with_canvas: -- :ref:`Matrix32` **get_global_transform_with_canvas** **(** **)** const +- :ref:`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` **get_material** **(** **)** const +- :ref:`ShaderMaterial` **get_material** **(** **)** const Get the material of this item. -.. _class_CanvasItem_get_opacity: +.. _class_CanvasItem_get_modulate: -- :ref:`float` **get_opacity** **(** **)** const +- :ref:`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` **get_self_opacity** **(** **)** const +- :ref:`Color` **get_self_modulate** **(** **)** const -Return the canvas item self-opacity. +Get the self-modulate of the CanvasItem. .. _class_CanvasItem_get_transform: -- :ref:`Matrix32` **get_transform** **(** **)** const +- :ref:`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_CanvasItem_get_viewport_transform: -- :ref:`Matrix32` **get_viewport_transform** **(** **)** const +- :ref:`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` **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` called) the function will return false. +- :ref:`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_is_transform_notification_enabled: + +- :ref:`bool` **is_transform_notification_enabled** **(** **)** const + .. _class_CanvasItem_is_visible: - :ref:`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` **is_visible_in_tree** **(** **)** const + .. _class_CanvasItem_make_canvas_pos_local: - :ref:`Vector2` **make_canvas_pos_local** **(** :ref:`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` blend_mode **)** - -Set the blending mode from enum BLEND_MODE\_\*. - .. _class_CanvasItem_set_draw_behind_parent: - void **set_draw_behind_parent** **(** :ref:`bool` enable **)** Set whether the canvas item is drawn behind its parent. -.. _class_CanvasItem_set_hidden: - -- void **set_hidden** **(** :ref:`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` light_mask **)** @@ -468,21 +472,29 @@ Set the ligtht mask number of this item. .. _class_CanvasItem_set_material: -- void **set_material** **(** :ref:`CanvasItemMaterial` material **)** +- void **set_material** **(** :ref:`ShaderMaterial` material **)** Set the material of this item. -.. _class_CanvasItem_set_opacity: +.. _class_CanvasItem_set_modulate: -- void **set_opacity** **(** :ref:`float` opacity **)** +- void **set_modulate** **(** :ref:`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` self_opacity **)** +- void **set_notify_local_transform** **(** :ref:`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` enable **)** + +.. _class_CanvasItem_set_self_modulate: + +- void **set_self_modulate** **(** :ref:`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` 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** **(** **)** diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst deleted file mode 100644 index 213d23cb8..000000000 --- a/classes/class_canvasitemmaterial.rst +++ /dev/null @@ -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` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - -Member Functions ----------------- - -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shader` | :ref:`get_shader` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_shader_param` **(** :ref:`String` param **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shading_mode` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shader` **(** :ref:`Shader` shader **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shader_param` **(** :ref:`String` param, :ref:`Variant` value **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shading_mode` **(** :ref:`int` mode **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Numeric Constants ------------------ - -- **SHADING_NORMAL** = **0** -- **SHADING_UNSHADED** = **1** -- **SHADING_ONLY_LIGHT** = **2** - -Member Function Description ---------------------------- - -.. _class_CanvasItemMaterial_get_shader: - -- :ref:`Shader` **get_shader** **(** **)** const - -.. _class_CanvasItemMaterial_get_shader_param: - -- void **get_shader_param** **(** :ref:`String` param **)** const - -.. _class_CanvasItemMaterial_get_shading_mode: - -- :ref:`int` **get_shading_mode** **(** **)** const - -.. _class_CanvasItemMaterial_set_shader: - -- void **set_shader** **(** :ref:`Shader` shader **)** - -.. _class_CanvasItemMaterial_set_shader_param: - -- void **set_shader_param** **(** :ref:`String` param, :ref:`Variant` value **)** - -.. _class_CanvasItemMaterial_set_shading_mode: - -- void **set_shading_mode** **(** :ref:`int` mode **)** - - diff --git a/classes/class_canvasitemshadergraph.rst b/classes/class_canvasitemshadergraph.rst deleted file mode 100644 index ceefc935a..000000000 --- a/classes/class_canvasitemshadergraph.rst +++ /dev/null @@ -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` **<** :ref:`Shader` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index 383889da2..85e6008b0 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -20,37 +20,45 @@ Canvas Item layer. Member Functions ---------------- -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Viewport` | :ref:`get_custom_viewport` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotationd` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`get_transform` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_viewport` **(** :ref:`Viewport` viewport **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer` **(** :ref:`int` layer **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotationd` **(** :ref:`float` degrees **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Matrix32` transform **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Viewport` | :ref:`get_custom_viewport` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_layer` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotationd` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_viewport` **(** :ref:`Viewport` viewport **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_layer` **(** :ref:`int` layer **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotationd` **(** :ref:`float` degrees **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform` **(** :ref:`Transform2D` transform **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`int` **layer** +- :ref:`Vector2` **offset** +- :ref:`float` **rotation** +- :ref:`Vector2` **scale** Description ----------- @@ -96,7 +104,7 @@ Return the base scale for this layer (helper). .. _class_CanvasLayer_get_transform: -- :ref:`Matrix32` **get_transform** **(** **)** const +- :ref:`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` transform **)** +- void **set_transform** **(** :ref:`Transform2D` transform **)** Set the base transform for this layer. diff --git a/classes/class_canvasmodulate.rst b/classes/class_canvasmodulate.rst index a2360a4c7..ba6ad115c 100644 --- a/classes/class_canvasmodulate.rst +++ b/classes/class_canvasmodulate.rst @@ -24,10 +24,15 @@ Member Functions | void | :ref:`set_color` **(** :ref:`Color` color **)** | +----------------------------+------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Color` **color** + Description ----------- -CanvasModulate tints the canvas elements using its asigned color +CanvasModulate tints the canvas elements using its assigned color Member Function Description --------------------------- diff --git a/classes/class_capsuleshape.rst b/classes/class_capsuleshape.rst index 9d701c135..399c6ae8c 100644 --- a/classes/class_capsuleshape.rst +++ b/classes/class_capsuleshape.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_radius` **(** :ref:`float` radius **)** | +----------------------------+-------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **height** +- :ref:`float` **radius** + Description ----------- diff --git a/classes/class_capsuleshape2d.rst b/classes/class_capsuleshape2d.rst index 317c973af..fd67bd16d 100644 --- a/classes/class_capsuleshape2d.rst +++ b/classes/class_capsuleshape2d.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_radius` **(** :ref:`float` radius **)** | +----------------------------+---------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **height** +- :ref:`float` **radius** + Description ----------- diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index e99063dcb..21f472c6c 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_use_top_left` **(** :ref:`bool` enable **)** | +--------------------------+--------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`bool` **use_top_left** + Description ----------- diff --git a/classes/class_circleshape2d.rst b/classes/class_circleshape2d.rst index a65325ee2..f4e142ac0 100644 --- a/classes/class_circleshape2d.rst +++ b/classes/class_circleshape2d.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_radius` **(** :ref:`float` radius **)** | +----------------------------+--------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **radius** + Description ----------- diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst new file mode 100644 index 000000000..ce607bd2f --- /dev/null +++ b/classes/class_classdb.rst @@ -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` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_instance` **(** :ref:`String` class **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_exists` **(** :ref:`String` class **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`class_get_category` **(** :ref:`String` class **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`class_get_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`class_get_integer_constant_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`class_get_method_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`class_get_property_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`class_get_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`class_get_signal_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_has_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_has_method` **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_has_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_class_list` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_inheriters_from_class` **(** :ref:`String` class **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_parent_class` **(** :ref:`String` class **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`instance` **(** :ref:`String` class **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class_enabled` **(** :ref:`String` class **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_parent_class` **(** :ref:`String` class, :ref:`String` inherits **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_ClassDB_can_instance: + +- :ref:`bool` **can_instance** **(** :ref:`String` class **)** const + +.. _class_ClassDB_class_exists: + +- :ref:`bool` **class_exists** **(** :ref:`String` class **)** const + +.. _class_ClassDB_class_get_category: + +- :ref:`String` **class_get_category** **(** :ref:`String` class **)** const + +.. _class_ClassDB_class_get_integer_constant: + +- :ref:`int` **class_get_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** const + +.. _class_ClassDB_class_get_integer_constant_list: + +- :ref:`PoolStringArray` **class_get_integer_constant_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const + +.. _class_ClassDB_class_get_method_list: + +- :ref:`Array` **class_get_method_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const + +.. _class_ClassDB_class_get_property_list: + +- :ref:`Array` **class_get_property_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const + +.. _class_ClassDB_class_get_signal: + +- :ref:`Dictionary` **class_get_signal** **(** :ref:`String` class, :ref:`String` signal **)** const + +.. _class_ClassDB_class_get_signal_list: + +- :ref:`Array` **class_get_signal_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const + +.. _class_ClassDB_class_has_integer_constant: + +- :ref:`bool` **class_has_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** const + +.. _class_ClassDB_class_has_method: + +- :ref:`bool` **class_has_method** **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const + +.. _class_ClassDB_class_has_signal: + +- :ref:`bool` **class_has_signal** **(** :ref:`String` class, :ref:`String` signal **)** const + +.. _class_ClassDB_get_class_list: + +- :ref:`PoolStringArray` **get_class_list** **(** **)** const + +.. _class_ClassDB_get_inheriters_from_class: + +- :ref:`PoolStringArray` **get_inheriters_from_class** **(** :ref:`String` class **)** const + +.. _class_ClassDB_get_parent_class: + +- :ref:`String` **get_parent_class** **(** :ref:`String` class **)** const + +.. _class_ClassDB_instance: + +- :ref:`Variant` **instance** **(** :ref:`String` class **)** const + +.. _class_ClassDB_is_class_enabled: + +- :ref:`bool` **is_class_enabled** **(** :ref:`String` class **)** const + +.. _class_ClassDB_is_parent_class: + +- :ref:`bool` **is_parent_class** **(** :ref:`String` class, :ref:`String` inherits **)** const + + diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index 64395da26..45c57b451 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -58,8 +58,14 @@ Signals ------- - **input_event** **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_pos, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** -- **mouse_enter** **(** **)** -- **mouse_exit** **(** **)** +- **mouse_entered** **(** **)** +- **mouse_exited** **(** **)** + +Member Variables +---------------- + +- :ref:`bool` **input_capture_on_drag** +- :ref:`bool` **input_ray_pickable** Member Function Description --------------------------- diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 378176523..b96dcb15f 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -20,42 +20,47 @@ Base node for 2D collisionables. Member Functions ---------------- -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input_event` **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** virtual | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shape` **(** :ref:`Shape2D` shape, :ref:`Matrix32` transform=((1, 0), (0, 1), (0, 0)) **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_shapes` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_rid` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`get_shape` **(** :ref:`int` shape_idx **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shape_count` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`get_shape_transform` **(** :ref:`int` shape_idx **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pickable` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shape_set_as_trigger` **(** :ref:`int` shape_idx **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_shape` **(** :ref:`int` shape_idx **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pickable` **(** :ref:`bool` enabled **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`int` shape_idx, :ref:`Shape` shape **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape_as_trigger` **(** :ref:`int` shape_idx, :ref:`bool` enable **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape_transform` **(** :ref:`int` shape_idx, :ref:`Matrix32` transform **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input_event` **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** virtual | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_shape` **(** :ref:`Shape2D` shape, :ref:`Transform2D` transform=((1, 0), (0, 1), (0, 0)) **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_shapes` **(** **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_rid` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape2D` | :ref:`get_shape` **(** :ref:`int` shape_idx **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shape_count` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_shape_transform` **(** :ref:`int` shape_idx **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pickable` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shape_set_as_trigger` **(** :ref:`int` shape_idx **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_shape` **(** :ref:`int` shape_idx **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pickable` **(** :ref:`bool` enabled **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape` **(** :ref:`int` shape_idx, :ref:`Shape` shape **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape_as_trigger` **(** :ref:`int` shape_idx, :ref:`bool` enable **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape_transform` **(** :ref:`int` shape_idx, :ref:`Transform2D` transform **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **input_event** **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** -- **mouse_enter** **(** **)** -- **mouse_exit** **(** **)** +- **mouse_entered** **(** **)** +- **mouse_exited** **(** **)** + +Member Variables +---------------- + +- :ref:`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` shape, :ref:`Matrix32` transform=((1, 0), (0, 1), (0, 0)) **)** +- void **add_shape** **(** :ref:`Shape2D` shape, :ref:`Transform2D` transform=((1, 0), (0, 1), (0, 0)) **)** Add a :ref:`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` **get_shape_transform** **(** :ref:`int` shape_idx **)** const +- :ref:`Transform2D` **get_shape_transform** **(** :ref:`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` shape_idx, :ref:`Matrix32` transform **)** +- void **set_shape_transform** **(** :ref:`int` shape_idx, :ref:`Transform2D` transform **)** Change the shape transform in the collision body. diff --git a/classes/class_collisionpolygon.rst b/classes/class_collisionpolygon.rst index d9efe026a..6a244466f 100644 --- a/classes/class_collisionpolygon.rst +++ b/classes/class_collisionpolygon.rst @@ -18,23 +18,31 @@ Brief Description Member Functions ---------------- -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_build_mode` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_object_first_shape` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_object_last_shape` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_depth` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`get_polygon` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_build_mode` **(** :ref:`int` build_mode **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_depth` **(** :ref:`float` depth **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_polygon` **(** :ref:`Vector2Array` polygon **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_build_mode` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_object_first_shape` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_object_last_shape` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_depth` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_polygon` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_build_mode` **(** :ref:`int` build_mode **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_depth` **(** :ref:`float` depth **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`int` **build_mode** +- :ref:`float` **depth** +- :ref:`PoolVector2Array` **polygon** +- :ref:`Vector2` **shape_range** Member Function Description --------------------------- @@ -57,7 +65,7 @@ Member Function Description .. _class_CollisionPolygon_get_polygon: -- :ref:`Vector2Array` **get_polygon** **(** **)** const +- :ref:`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` polygon **)** +- void **set_polygon** **(** :ref:`PoolVector2Array` polygon **)** diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index c10da462c..a07230914 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -18,23 +18,31 @@ Editor-only class for easy editing of collision polygons. Member Functions ---------------- -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_build_mode` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_object_first_shape` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_object_last_shape` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`get_polygon` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_trigger` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_build_mode` **(** :ref:`int` build_mode **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_polygon` **(** :ref:`Vector2Array` polygon **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_trigger` **(** :ref:`bool` trigger **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_build_mode` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_object_first_shape` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_object_last_shape` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_polygon` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_trigger` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_build_mode` **(** :ref:`int` build_mode **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_trigger` **(** :ref:`bool` trigger **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`int` **build_mode** +- :ref:`PoolVector2Array` **polygon** +- :ref:`Vector2` **shape_range** +- :ref:`bool` **trigger** Description ----------- @@ -68,7 +76,7 @@ Return the index of the last shape generated by the editor. .. _class_CollisionPolygon2D_get_polygon: -- :ref:`Vector2Array` **get_polygon** **(** **)** const +- :ref:`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` polygon **)** +- void **set_polygon** **(** :ref:`PoolVector2Array` polygon **)** Set the array of points forming the polygon. diff --git a/classes/class_collisionshape.rst b/classes/class_collisionshape.rst index d890f693a..7548cb07d 100644 --- a/classes/class_collisionshape.rst +++ b/classes/class_collisionshape.rst @@ -34,6 +34,13 @@ Member Functions | void | :ref:`set_trigger` **(** :ref:`bool` enable **)** | +------------------------------+-------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **_update_shape_index** +- :ref:`Shape` **shape** +- :ref:`bool` **trigger** + Member Function Description --------------------------- diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index 2384d49d1..42b409365 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -30,6 +30,13 @@ Member Functions | void | :ref:`set_trigger` **(** :ref:`bool` enable **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **_update_shape_index** +- :ref:`Shape2D` **shape** +- :ref:`bool` **trigger** + Description ----------- diff --git a/classes/class_colorarray.rst b/classes/class_colorarray.rst deleted file mode 100644 index 3f6f546af..000000000 --- a/classes/class_colorarray.rst +++ /dev/null @@ -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` | :ref:`ColorArray` **(** :ref:`Array` from **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`Color` color **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`ColorArray` array **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Color` color **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`Color` color **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`Color` color **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`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` **ColorArray** **(** :ref:`Array` from **)** - -Create from a generic array. - -.. _class_ColorArray_append: - -- void **append** **(** :ref:`Color` color **)** - -Append an element at the end of the array (alias of :ref:`push_back`). - -.. _class_ColorArray_append_array: - -- void **append_array** **(** :ref:`ColorArray` array **)** - -Append an :ref:`ColorArray` at the end of this array. - -.. _class_ColorArray_insert: - -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`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` color **)** - -Append a value to the array. - -.. _class_ColorArray_remove: - -- void **remove** **(** :ref:`int` idx **)** - -Remove an element from the array by index. - -.. _class_ColorArray_resize: - -- void **resize** **(** :ref:`int` idx **)** - -Set the size of the :ref:`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` idx, :ref:`Color` color **)** - -Change the :ref:`Color` at the given index. - -.. _class_ColorArray_size: - -- :ref:`int` **size** **(** **)** - -Return the array size. - - diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 701812f5b..1f8e6413e 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -18,21 +18,21 @@ Color picker control. Member Functions ---------------- -+----------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`add_preset` **(** :ref:`Color` arg0 **)** | -+----------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editing_alpha` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_raw_mode` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+----------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_edit_alpha` **(** :ref:`bool` show **)** | -+----------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_raw_mode` **(** :ref:`bool` mode **)** | -+----------------------------+----------------------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_preset` **(** :ref:`Color` arg0 **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_pick_color` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editing_alpha` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_raw_mode` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_edit_alpha` **(** :ref:`bool` show **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pick_color` **(** :ref:`Color` color **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_raw_mode` **(** :ref:`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` **get_color** **(** **)** const +- :ref:`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` color **)** - -Select the current color. - .. _class_ColorPicker_set_edit_alpha: - void **set_edit_alpha** **(** :ref:`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` color **)** + +Select the current color. + .. _class_ColorPicker_set_raw_mode: - void **set_raw_mode** **(** :ref:`bool` mode **)** diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index 4cfbe10ea..6f6334aee 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -18,23 +18,29 @@ Button that pops out a :ref:`ColorPicker` Member Functions ---------------- -+----------------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`ColorPicker` | :ref:`get_picker` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editing_alpha` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_edit_alpha` **(** :ref:`bool` show **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------+ ++----------------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_pick_color` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`ColorPicker` | :ref:`get_picker` **(** **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editing_alpha` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_edit_alpha` **(** :ref:`bool` show **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pick_color` **(** :ref:`Color` color **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------+ Signals ------- - **color_changed** **(** :ref:`Color` color **)** +Member Variables +---------------- + +- :ref:`Color` **color** +- :ref:`bool` **edit_alpha** + Description ----------- @@ -43,11 +49,9 @@ Encapsulates a :ref:`ColorPicker` making it accesible by pres Member Function Description --------------------------- -.. _class_ColorPickerButton_get_color: +.. _class_ColorPickerButton_get_pick_color: -- :ref:`Color` **get_color** **(** **)** const - -Gets the current color +- :ref:`Color` **get_pick_color** **(** **)** const .. _class_ColorPickerButton_get_picker: @@ -59,16 +63,14 @@ Gets the current color See :ref:`ColorPicker.is_edit_alpha` -.. _class_ColorPickerButton_set_color: - -- void **set_color** **(** :ref:`Color` color **)** - -Sets the current color - .. _class_ColorPickerButton_set_edit_alpha: - void **set_edit_alpha** **(** :ref:`bool` show **)** See :ref:`ColorPicker.set_edit_alpha` +.. _class_ColorPickerButton_set_pick_color: + +- void **set_pick_color** **(** :ref:`Color` color **)** + diff --git a/classes/class_colorramp.rst b/classes/class_colorramp.rst index cfe5ec25c..067bc4e97 100644 --- a/classes/class_colorramp.rst +++ b/classes/class_colorramp.rst @@ -18,31 +18,37 @@ Color interpolator node Member Functions ---------------- -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`float` offset, :ref:`Color` color **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`int` point **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ColorArray` | :ref:`get_colors` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_offset` **(** :ref:`int` point **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RealArray` | :ref:`get_offsets` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`interpolate` **(** :ref:`float` offset **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` offset **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`int` point, :ref:`Color` color **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_colors` **(** :ref:`ColorArray` colors **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`int` point, :ref:`float` offset **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offsets` **(** :ref:`RealArray` offsets **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`float` offset, :ref:`Color` color **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** :ref:`int` point **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolColorArray` | :ref:`get_colors` **(** **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_offset` **(** :ref:`int` point **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`get_offsets` **(** **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`interpolate` **(** :ref:`float` offset **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` offset **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`int` point, :ref:`Color` color **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_colors` **(** :ref:`PoolColorArray` colors **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`int` point, :ref:`float` offset **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offsets` **(** :ref:`PoolRealArray` offsets **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **colors** +- :ref:`float` **offsets** Description ----------- @@ -66,7 +72,7 @@ Returns the color of the ramp color at index *point* .. _class_ColorRamp_get_colors: -- :ref:`ColorArray` **get_colors** **(** **)** const +- :ref:`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` **get_offsets** **(** **)** const +- :ref:`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` colors **)** +- void **set_colors** **(** :ref:`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` offsets **)** +- void **set_offsets** **(** :ref:`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. diff --git a/classes/class_colorframe.rst b/classes/class_colorrect.rst similarity index 75% rename from classes/class_colorframe.rst rename to classes/class_colorrect.rst index 4b230b969..13c579b95 100644 --- a/classes/class_colorframe.rst +++ b/classes/class_colorrect.rst @@ -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` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` @@ -18,20 +18,25 @@ Brief Description Member Functions ---------------- -+----------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_frame_color` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame_color` **(** :ref:`Color` color **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_frame_color` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frame_color` **(** :ref:`Color` color **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Color` **color** Member Function Description --------------------------- -.. _class_ColorFrame_get_frame_color: +.. _class_ColorRect_get_frame_color: - :ref:`Color` **get_frame_color** **(** **)** const -.. _class_ColorFrame_set_frame_color: +.. _class_ColorRect_set_frame_color: - void **set_frame_color** **(** :ref:`Color` color **)** diff --git a/classes/class_concavepolygonshape.rst b/classes/class_concavepolygonshape.rst index dc038f906..16ce6b30c 100644 --- a/classes/class_concavepolygonshape.rst +++ b/classes/class_concavepolygonshape.rst @@ -18,11 +18,11 @@ Concave polygon shape. Member Functions ---------------- -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3Array` | :ref:`get_faces` **(** **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_faces` **(** :ref:`Vector3Array` faces **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_faces` **(** :ref:`PoolVector3Array` faces **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -34,13 +34,13 @@ Member Function Description .. _class_ConcavePolygonShape_get_faces: -- :ref:`Vector3Array` **get_faces** **(** **)** const +- :ref:`PoolVector3Array` **get_faces** **(** **)** const Return the faces (an array of triangles). .. _class_ConcavePolygonShape_set_faces: -- void **set_faces** **(** :ref:`Vector3Array` faces **)** +- void **set_faces** **(** :ref:`PoolVector3Array` faces **)** Set the faces (an array of triangles). diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index a6c10de31..9874ea98a 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -18,11 +18,16 @@ Concave polygon 2D shape resource for physics. Member Functions ---------------- -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`get_segments` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_segments` **(** :ref:`Vector2Array` segments **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_segments` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_segments` **(** :ref:`PoolVector2Array` segments **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`PoolVector2Array` **segments** Description ----------- @@ -36,13 +41,13 @@ Member Function Description .. _class_ConcavePolygonShape2D_get_segments: -- :ref:`Vector2Array` **get_segments** **(** **)** const +- :ref:`PoolVector2Array` **get_segments** **(** **)** const Return the array of segments. .. _class_ConcavePolygonShape2D_set_segments: -- void **set_segments** **(** :ref:`Vector2Array` segments **)** +- void **set_segments** **(** :ref:`PoolVector2Array` segments **)** Set the array of segments. diff --git a/classes/class_conetwistjoint.rst b/classes/class_conetwistjoint.rst index 45d318916..3e7dc0231 100644 --- a/classes/class_conetwistjoint.rst +++ b/classes/class_conetwistjoint.rst @@ -24,6 +24,15 @@ Member Functions | void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **bias** +- :ref:`float` **relaxation** +- :ref:`float` **softness** +- :ref:`float` **swing_span** +- :ref:`float` **twist_span** + Numeric Constants ----------------- diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index 853c9e84e..ac455d201 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -18,23 +18,25 @@ Helper class to handle INI-style files. Member Functions ---------------- -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_section_keys` **(** :ref:`String` section **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_sections` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=NULL **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_section` **(** :ref:`String` section **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_section_key` **(** :ref:`String` section, :ref:`String` key **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`load` **(** :ref:`String` path **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`save` **(** :ref:`String` path **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_section` **(** :ref:`String` section **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_section_keys` **(** :ref:`String` section **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_sections` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=NULL **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_section` **(** :ref:`String` section **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_section_key` **(** :ref:`String` section, :ref:`String` key **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`load` **(** :ref:`String` path **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`save` **(** :ref:`String` path **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_value` **(** :ref:`String` section, :ref:`String` key, :ref:`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` section **)** + .. _class_ConfigFile_get_section_keys: -- :ref:`StringArray` **get_section_keys** **(** :ref:`String` section **)** const +- :ref:`PoolStringArray` **get_section_keys** **(** :ref:`String` section **)** const Return an array of all defined key identifiers in the specified section. .. _class_ConfigFile_get_sections: -- :ref:`StringArray` **get_sections** **(** **)** const +- :ref:`PoolStringArray` **get_sections** **(** **)** const Return an array of all defined section identifiers. diff --git a/classes/class_container.rst b/classes/class_container.rst index 08ff8f14f..d4a8a59ad 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -8,7 +8,7 @@ Container **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`PanelContainer`, :ref:`GridContainer`, :ref:`ScrollContainer`, :ref:`MarginContainer`, :ref:`CenterContainer`, :ref:`GraphNode`, :ref:`SplitContainer`, :ref:`BoxContainer` +**Inherited By:** :ref:`PanelContainer`, :ref:`GridContainer`, :ref:`ScrollContainer`, :ref:`ViewportContainer`, :ref:`MarginContainer`, :ref:`CenterContainer`, :ref:`GraphNode`, :ref:`SplitContainer`, :ref:`BoxContainer` **Category:** Core diff --git a/classes/class_control.rst b/classes/class_control.rst index 46e098363..0e534b9eb 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -8,7 +8,7 @@ Control **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`Label`, :ref:`Tabs`, :ref:`TextureFrame`, :ref:`ButtonArray`, :ref:`VideoPlayer`, :ref:`LineEdit`, :ref:`ColorFrame`, :ref:`Container`, :ref:`ReferenceFrame`, :ref:`Patch9Frame`, :ref:`TextEdit`, :ref:`BaseButton`, :ref:`Popup`, :ref:`Tree`, :ref:`Separator`, :ref:`Panel`, :ref:`TabContainer`, :ref:`Range`, :ref:`RichTextLabel`, :ref:`GraphEdit`, :ref:`ItemList` +**Inherited By:** :ref:`TextureRect`, :ref:`ColorRect`, :ref:`Label`, :ref:`Tabs`, :ref:`ButtonArray`, :ref:`GraphEdit`, :ref:`VideoPlayer`, :ref:`NinePatchRect`, :ref:`LineEdit`, :ref:`Container`, :ref:`TextEdit`, :ref:`BaseButton`, :ref:`Popup`, :ref:`Tree`, :ref:`Separator`, :ref:`ReferenceRect`, :ref:`Panel`, :ref:`TabContainer`, :ref:`Range`, :ref:`RichTextLabel`, :ref:`ItemList` **Category:** Core @@ -21,7 +21,9 @@ Member Functions ---------------- +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input_event` **(** :ref:`InputEvent` event **)** virtual | +| :ref:`Vector2` | :ref:`_get_minimum_size` **(** **)** virtual | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_gui_input` **(** :ref:`InputEvent` event **)** virtual | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`accept_event` **(** **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -83,7 +85,7 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** virtual | +| :ref:`int` | :ref:`get_mouse_filter` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_parent_area_size` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -133,13 +135,13 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_icon_override` **(** :ref:`String` name **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`has_point` **(** :ref:`Vector2` point **)** virtual | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_stylebox_override` **(** :ref:`String` name **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ignoring_mouse` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_stopping_mouse` **(** **)** const | +| :ref:`bool` | :ref:`is_clipping_contents` **(** **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`minimum_size_changed` **(** **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -153,6 +155,8 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_begin` **(** :ref:`Vector2` pos **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clip_contents` **(** :ref:`bool` enable **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_custom_minimum_size` **(** :ref:`Vector2` size **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_default_cursor_shape` **(** :ref:`int` shape **)** | @@ -171,10 +175,10 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_h_size_flags` **(** :ref:`int` flags **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ignore_mouse` **(** :ref:`bool` ignore **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_margin` **(** :ref:`int` margin, :ref:`float` offset **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mouse_filter` **(** :ref:`int` filter **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_pos` **(** :ref:`Vector2` pos **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_rotation` **(** :ref:`float` radians **)** | @@ -185,8 +189,6 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_size` **(** :ref:`Vector2` size **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stop_mouse` **(** :ref:`bool` stop **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_stretch_ratio` **(** :ref:`float` ratio **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_theme` **(** :ref:`Theme` theme **)** | @@ -203,23 +205,50 @@ Member Functions Signals ------- -- **focus_enter** **(** **)** -- **focus_exit** **(** **)** -- **input_event** **(** :ref:`InputEvent` ev **)** +- **focus_entered** **(** **)** +- **focus_exited** **(** **)** +- **gui_input** **(** :ref:`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` **anchor_bottom** +- :ref:`int` **anchor_left** +- :ref:`int` **anchor_right** +- :ref:`int` **anchor_top** +- :ref:`NodePath` **focus_neighbour_bottom** +- :ref:`NodePath` **focus_neighbour_left** +- :ref:`NodePath` **focus_neighbour_right** +- :ref:`NodePath` **focus_neighbour_top** +- :ref:`String` **hint_tooltip** +- :ref:`int` **margin_bottom** +- :ref:`int` **margin_left** +- :ref:`int` **margin_right** +- :ref:`int` **margin_top** +- :ref:`int` **mouse_filter** +- :ref:`bool` **rect_clip_content** +- :ref:`Vector2` **rect_min_size** +- :ref:`Vector2` **rect_pos** +- :ref:`float` **rect_rotation** +- :ref:`Vector2` **rect_scale** +- :ref:`Vector2` **rect_size** +- :ref:`int` **size_flags_horizontal** +- :ref:`int` **size_flags_stretch_ratio** +- :ref:`int` **size_flags_vertical** +- :ref:`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`. Setting Member Function Description --------------------------- -.. _class_Control__input_event: +.. _class_Control__get_minimum_size: -- void **_input_event** **(** :ref:`InputEvent` event **)** virtual +- :ref:`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` 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` **get_minimum_size** **(** **)** virtual +- :ref:`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` **has_icon_override** **(** :ref:`String` name **)** const +.. _class_Control_has_point: + +- void **has_point** **(** :ref:`Vector2` point **)** virtual + .. _class_Control_has_stylebox: - :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const @@ -559,15 +601,9 @@ Return whether the Control is the current focused control (see :ref:`set_focus_m - :ref:`bool` **has_stylebox_override** **(** :ref:`String` name **)** const -.. _class_Control_is_ignoring_mouse: +.. _class_Control_is_clipping_contents: -- :ref:`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` **is_stopping_mouse** **(** **)** const +- :ref:`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_clip_contents: + +- void **set_clip_contents** **(** :ref:`bool` enable **)** + .. _class_Control_set_custom_minimum_size: - void **set_custom_minimum_size** **(** :ref:`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` ignore **)** - -Ignore mouse events on this control (even touchpad events send mouse events). - .. _class_Control_set_margin: - void **set_margin** **(** :ref:`int` margin, :ref:`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` 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` 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_stop_mouse: - -- void **set_stop_mouse** **(** :ref:`bool` stop **)** - .. _class_Control_set_stretch_ratio: - void **set_stretch_ratio** **(** :ref:`float` ratio **)** diff --git a/classes/class_convexpolygonshape.rst b/classes/class_convexpolygonshape.rst index 787927619..52aaa07a5 100644 --- a/classes/class_convexpolygonshape.rst +++ b/classes/class_convexpolygonshape.rst @@ -18,11 +18,16 @@ Convex Polygon Shape. Member Functions ---------------- -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3Array` | :ref:`get_points` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_points` **(** :ref:`Vector3Array` points **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_points` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_points` **(** :ref:`PoolVector3Array` points **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Array` **points** Description ----------- @@ -34,10 +39,10 @@ Member Function Description .. _class_ConvexPolygonShape_get_points: -- :ref:`Vector3Array` **get_points** **(** **)** const +- :ref:`PoolVector3Array` **get_points** **(** **)** const .. _class_ConvexPolygonShape_set_points: -- void **set_points** **(** :ref:`Vector3Array` points **)** +- void **set_points** **(** :ref:`PoolVector3Array` points **)** diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index ffb917a0b..d627ed385 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -18,13 +18,18 @@ Convex Polygon Shape for 2D physics. Member Functions ---------------- -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`get_points` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_cloud` **(** :ref:`Vector2Array` point_cloud **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_points` **(** :ref:`Vector2Array` points **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_points` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_cloud` **(** :ref:`PoolVector2Array` point_cloud **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_points` **(** :ref:`PoolVector2Array` points **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`PoolVector2Array` **points** Description ----------- @@ -38,19 +43,19 @@ Member Function Description .. _class_ConvexPolygonShape2D_get_points: -- :ref:`Vector2Array` **get_points** **(** **)** const +- :ref:`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` point_cloud **)** +- void **set_point_cloud** **(** :ref:`PoolVector2Array` point_cloud **)** Currently, this method does nothing. .. _class_ConvexPolygonShape2D_set_points: -- void **set_points** **(** :ref:`Vector2Array` points **)** +- void **set_points** **(** :ref:`PoolVector2Array` points **)** Set a list of points in either clockwise or counter clockwise order, forming a convex polygon. diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index 2e475d8f6..de1dfb955 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -25,8 +25,6 @@ Member Functions +----------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_lossy_storage_quality` **(** **)** const | +----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_rid` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`get_side` **(** :ref:`int` side **)** const | +----------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_storage` **(** **)** const | @@ -74,10 +72,6 @@ Member Function Description - :ref:`float` **get_lossy_storage_quality** **(** **)** const -.. _class_CubeMap_get_rid: - -- :ref:`RID` **get_rid** **(** **)** const - .. _class_CubeMap_get_side: - :ref:`Image` **get_side** **(** :ref:`int` side **)** const diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index 6b75db7ab..ade4c810f 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -18,41 +18,49 @@ Describes a Bezier curve in 2D space. Member Functions ---------------- -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector2` pos, :ref:`Vector2` in=Vector2(0, 0), :ref:`Vector2` out=Vector2(0, 0), :ref:`int` atpos=-1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_baked_length` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`get_baked_points` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_pos` **(** :ref:`int` idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` idx **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_pos` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`tesselate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector2` pos, :ref:`Vector2` in=Vector2(0, 0), :ref:`Vector2` out=Vector2(0, 0), :ref:`int` atpos=-1 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_baked_length` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_baked_points` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_pos` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` idx **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_pos` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`tesselate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`int` **_data** +- :ref:`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`), 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` **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` **get_baked_points** **(** **)** const +- :ref:`PoolVector2Array` **get_baked_points** **(** **)** const -Returns the cache of points as a :ref:`Vector2Array`. +Returns the cache of points as a :ref:`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` **tesselate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const +- :ref:`PoolVector2Array` **tesselate** **(** :ref:`int` max_stages=5, :ref:`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. diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index c137e89ec..032ac392f 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -18,47 +18,55 @@ Describes a Bezier curve in 3D space. Member Functions ---------------- -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector3` pos, :ref:`Vector3` in=Vector3(0, 0, 0), :ref:`Vector3` out=Vector3(0, 0, 0), :ref:`int` atpos=-1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_baked_length` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3Array` | :ref:`get_baked_points` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RealArray` | :ref:`get_baked_tilts` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_pos` **(** :ref:`int` idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_tilt` **(** :ref:`int` idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` idx **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_pos` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_tilt` **(** :ref:`int` idx, :ref:`float` tilt **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3Array` | :ref:`tesselate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector3` pos, :ref:`Vector3` in=Vector3(0, 0, 0), :ref:`Vector3` out=Vector3(0, 0, 0), :ref:`int` atpos=-1 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_baked_length` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_baked_points` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`get_baked_tilts` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_pos` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_tilt` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` idx **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_pos` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_tilt` **(** :ref:`int` idx, :ref:`float` tilt **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`tesselate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`int` **_data** +- :ref:`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`), 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` **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` **get_baked_points** **(** **)** const +- :ref:`PoolVector3Array` **get_baked_points** **(** **)** const -Returns the cache of points as a :ref:`Vector3Array`. +Returns the cache of points as a :ref:`PoolVector3Array`. .. _class_Curve3D_get_baked_tilts: -- :ref:`RealArray` **get_baked_tilts** **(** **)** const +- :ref:`PoolRealArray` **get_baked_tilts** **(** **)** const Returns the cache of tilts as a :ref:`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` **tesselate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const +- :ref:`PoolVector3Array` **tesselate** **(** :ref:`int` max_stages=5, :ref:`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. diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst new file mode 100644 index 000000000..268b17daf --- /dev/null +++ b/classes/class_curvetexture.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_max` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_min` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_points` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max` **(** :ref:`float` max **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_min` **(** :ref:`float` min **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_points` **(** :ref:`PoolVector2Array` points **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_width` **(** :ref:`int` width **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **max** +- :ref:`float` **min** +- :ref:`PoolVector2Array` **points** +- :ref:`int` **width** + +Member Function Description +--------------------------- + +.. _class_CurveTexture_get_max: + +- :ref:`float` **get_max** **(** **)** const + +.. _class_CurveTexture_get_min: + +- :ref:`float` **get_min** **(** **)** const + +.. _class_CurveTexture_get_points: + +- :ref:`PoolVector2Array` **get_points** **(** **)** const + +.. _class_CurveTexture_set_max: + +- void **set_max** **(** :ref:`float` max **)** + +.. _class_CurveTexture_set_min: + +- void **set_min** **(** :ref:`float` min **)** + +.. _class_CurveTexture_set_points: + +- void **set_points** **(** :ref:`PoolVector2Array` points **)** + +.. _class_CurveTexture_set_width: + +- void **set_width** **(** :ref:`int` width **)** + + diff --git a/classes/class_dampedspringjoint2d.rst b/classes/class_dampedspringjoint2d.rst index 368ab8843..a9db9aa21 100644 --- a/classes/class_dampedspringjoint2d.rst +++ b/classes/class_dampedspringjoint2d.rst @@ -36,6 +36,14 @@ Member Functions | void | :ref:`set_stiffness` **(** :ref:`float` stiffness **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **damping** +- :ref:`float` **length** +- :ref:`float` **rest_length** +- :ref:`float` **stiffness** + Description ----------- diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index 5f4bff6cb..bde14d739 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -16,29 +16,25 @@ Dictionary type. Member Functions ---------------- -+------------------------------+-----------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+------------------------------+-----------------------------------------------------------------------------------------------+ -| void | :ref:`erase` **(** var key **)** | -+------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** var key **)** | -+------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_all` **(** :ref:`Array` keys **)** | -+------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hash` **(** **)** | -+------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`keys` **(** **)** | -+------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`parse_json` **(** :ref:`String` json **)** | -+------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_json` **(** **)** | -+------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`values` **(** **)** | -+------------------------------+-----------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------+ +| void | :ref:`erase` **(** var key **)** | ++----------------------------+---------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has` **(** var key **)** | ++----------------------------+---------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_all` **(** :ref:`Array` keys **)** | ++----------------------------+---------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hash` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`keys` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`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_parse_json: - -- :ref:`int` **parse_json** **(** :ref:`String` json **)** - -Parse json text to the dictionary. Return OK when successed or the error code when failed. - .. _class_Dictionary_size: - :ref:`int` **size** **(** **)** Return the size of the dictionary (in pairs). -.. _class_Dictionary_to_json: - -- :ref:`String` **to_json** **(** **)** - -Return the dictionary as json text. - .. _class_Dictionary_values: - :ref:`Array` **values** **(** **)** diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index 804055f36..91b585790 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -18,26 +18,33 @@ Directional Light, such as the Sun or the Moon. Member Functions ---------------- -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_mode` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_shadow_param` **(** :ref:`int` param **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_mode` **(** :ref:`int` mode **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_param` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_mode` **(** **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_blend_splits_enabled` **(** **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_splits` **(** :ref:`bool` enabled **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_mode` **(** :ref:`int` mode **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **directional_shadow_bias_split_scale** +- :ref:`bool` **directional_shadow_blend_splits** +- :ref:`int` **directional_shadow_mode** +- :ref:`float` **directional_shadow_normal_bias** +- :ref:`float` **directional_shadow_split_1** +- :ref:`float` **directional_shadow_split_2** +- :ref:`float` **directional_shadow_split_3** Numeric Constants ----------------- - **SHADOW_ORTHOGONAL** = **0** -- **SHADOW_PERSPECTIVE** = **1** -- **SHADOW_PARALLEL_2_SPLITS** = **2** -- **SHADOW_PARALLEL_4_SPLITS** = **3** -- **SHADOW_PARAM_MAX_DISTANCE** = **0** -- **SHADOW_PARAM_PSSM_SPLIT_WEIGHT** = **1** -- **SHADOW_PARAM_PSSM_ZOFFSET_SCALE** = **2** +- **SHADOW_PARALLEL_2_SPLITS** = **1** +- **SHADOW_PARALLEL_4_SPLITS** = **2** Description ----------- @@ -51,16 +58,16 @@ Member Function Description - :ref:`int` **get_shadow_mode** **(** **)** const -.. _class_DirectionalLight_get_shadow_param: +.. _class_DirectionalLight_is_blend_splits_enabled: -- :ref:`float` **get_shadow_param** **(** :ref:`int` param **)** const +- :ref:`bool` **is_blend_splits_enabled** **(** **)** const + +.. _class_DirectionalLight_set_blend_splits: + +- void **set_blend_splits** **(** :ref:`bool` enabled **)** .. _class_DirectionalLight_set_shadow_mode: - void **set_shadow_mode** **(** :ref:`int` mode **)** -.. _class_DirectionalLight_set_shadow_param: - -- void **set_shadow_param** **(** :ref:`int` param, :ref:`float` value **)** - diff --git a/classes/class_directory.rst b/classes/class_directory.rst index 8a1b31686..ac18f7e43 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -18,41 +18,43 @@ Type used to handle the filesystem. Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`change_dir` **(** :ref:`String` todir **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`copy` **(** :ref:`String` from, :ref:`String` to **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`current_is_dir` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`dir_exists` **(** :ref:`String` path **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_dir` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_drive` **(** :ref:`int` idx **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_drive_count` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_next` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_space_left` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`list_dir_begin` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`list_dir_end` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`make_dir` **(** :ref:`String` path **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`make_dir_recursive` **(** :ref:`String` path **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`open` **(** :ref:`String` path **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`remove` **(** :ref:`String` path **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`rename` **(** :ref:`String` from, :ref:`String` to **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`change_dir` **(** :ref:`String` todir **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`copy` **(** :ref:`String` from, :ref:`String` to **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`current_is_dir` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`dir_exists` **(** :ref:`String` path **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_dir` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_current_drive` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_drive` **(** :ref:`int` idx **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_drive_count` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_next` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_space_left` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`list_dir_begin` **(** :ref:`bool` skip_navigational=false, :ref:`bool` skip_hidden=false **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`list_dir_end` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`make_dir` **(** :ref:`String` path **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`make_dir_recursive` **(** :ref:`String` path **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`open` **(** :ref:`String` path **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`remove` **(** :ref:`String` path **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`rename` **(** :ref:`String` from, :ref:`String` to **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -120,6 +122,10 @@ Return whether the target file exists. The argument can be relative to the curre Return the absolute path to the currently opened directory (e.g. ``res://folder`` or ``C:\tmp\folder``). +.. _class_Directory_get_current_drive: + +- :ref:`int` **get_current_drive** **(** **)** + .. _class_Directory_get_drive: - :ref:`String` **get_drive** **(** :ref:`int` idx **)** @@ -136,7 +142,9 @@ On Windows, return the number of drives (partitions) mounted on the current file - :ref:`String` **get_next** **(** **)** -Return the next element (file or directory) in the current directory (including ``.`` and ``..``). The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. :ref:`list_dir_end` would not be mandatory in such a case). +Return the next element (file or directory) in the current directory (including ``.`` and ``..``, unless ``skip_navigational`` was given to :ref:`list_dir_begin`). + +The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. :ref:`list_dir_end` would not be mandatory in such a case). .. _class_Directory_get_space_left: @@ -146,11 +154,13 @@ On Unix desktop systems, return the available space on the current directory's d .. _class_Directory_list_dir_begin: -- :ref:`bool` **list_dir_begin** **(** **)** +- :ref:`int` **list_dir_begin** **(** :ref:`bool` skip_navigational=false, :ref:`bool` skip_hidden=false **)** Initialise the stream used to list all files and directories using the :ref:`get_next` function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with :ref:`list_dir_end`. -Return true if the stream could not be initialised. +If you pass ``skip_navigational``, then ``.`` and ``..`` would be filtered out. + +If you pass ``skip_hidden``, then hidden files would be filtered out. .. _class_Directory_list_dir_end: diff --git a/classes/class_dllibrary.rst b/classes/class_dllibrary.rst new file mode 100644 index 000000000..3c67df013 --- /dev/null +++ b/classes/class_dllibrary.rst @@ -0,0 +1,38 @@ +.. 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_DLLibrary: + +DLLibrary +========= + +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_platform_file` **(** :ref:`String` platform **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_platform_file` **(** :ref:`String` platform, :ref:`String` file **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_DLLibrary_get_platform_file: + +- :ref:`String` **get_platform_file** **(** :ref:`String` platform **)** const + +.. _class_DLLibrary_set_platform_file: + +- void **set_platform_file** **(** :ref:`String` platform, :ref:`String` file **)** + + diff --git a/classes/class_dlscript.rst b/classes/class_dlscript.rst new file mode 100644 index 000000000..fb3e6bd1f --- /dev/null +++ b/classes/class_dlscript.rst @@ -0,0 +1,56 @@ +.. 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_DLScript: + +DLScript +======== + +**Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_library` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_script_name` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_library` **(** :ref:`Object` library **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_script_name` **(** :ref:`String` script_name **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`DLLibrary` **library** +- :ref:`String` **script_name** + +Member Function Description +--------------------------- + +.. _class_DLScript_get_library: + +- :ref:`Object` **get_library** **(** **)** const + +.. _class_DLScript_get_script_name: + +- :ref:`String` **get_script_name** **(** **)** const + +.. _class_DLScript_set_library: + +- void **set_library** **(** :ref:`Object` library **)** + +.. _class_DLScript_set_script_name: + +- void **set_script_name** **(** :ref:`String` script_name **)** + + diff --git a/classes/class_dynamicfont.rst b/classes/class_dynamicfont.rst index b8ecb81fe..3bd9f007c 100644 --- a/classes/class_dynamicfont.rst +++ b/classes/class_dynamicfont.rst @@ -50,6 +50,18 @@ Member Functions | void | :ref:`set_use_mipmaps` **(** :ref:`bool` enable **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **extra_spacing_bottom** +- :ref:`int` **extra_spacing_char** +- :ref:`int` **extra_spacing_space** +- :ref:`int` **extra_spacing_top** +- :ref:`DynamicFontData` **font_data** +- :ref:`int` **size** +- :ref:`bool` **use_filter** +- :ref:`bool` **use_mipmaps** + Numeric Constants ----------------- diff --git a/classes/class_dynamicfontdata.rst b/classes/class_dynamicfontdata.rst index 34fcdda23..0cc38f3b1 100644 --- a/classes/class_dynamicfontdata.rst +++ b/classes/class_dynamicfontdata.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_font_path` **(** :ref:`String` path **)** | +------------------------------+----------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`String` **font_path** + Member Function Description --------------------------- diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst deleted file mode 100644 index 261e52222..000000000 --- a/classes/class_editorexportplugin.rst +++ /dev/null @@ -1,45 +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_EditorExportPlugin: - -EditorExportPlugin -================== - -**Inherits:** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Editor plugin to control the export process. - -Member Functions ----------------- - -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`custom_export` **(** :ref:`String` name, EditorExportPlatform platform **)** virtual | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -Description ------------ - -This plugin is added into EditorImportExport and allows to modify the behavior of the export process for individual files. - -Member Function Description ---------------------------- - -.. _class_EditorExportPlugin_custom_export: - -- :ref:`Variant` **custom_export** **(** :ref:`String` name, EditorExportPlatform platform **)** virtual - -This function is called for each file exported and depending from the return value one of many things might happen. - -1) If returned value is null, the file is exported as is. - -2) If the returned value is a RawAray (array of bytes), the content of that array becomes the new file being exported. - -3) If the file must also change its name when exported, then a :ref:`Dictionary` must be returned with two fields: 'name' with the new filename and 'data' with a :ref:`RawArray` containing the raw contents of the file. Even if the name is changed, the run-time will redirect the old file to the new file automatically when accessed. - - diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index 62549b5bb..c7f297298 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -65,7 +65,7 @@ Signals - **dir_selected** **(** :ref:`String` dir **)** - **file_selected** **(** :ref:`String` path **)** -- **files_selected** **(** :ref:`StringArray` paths **)** +- **files_selected** **(** :ref:`PoolStringArray` paths **)** Numeric Constants ----------------- diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index 0781a62b8..5101e73a5 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -18,23 +18,23 @@ Resource filesystem, as the editor sees it. Member Functions ---------------- -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file_type` **(** :ref:`String` path **)** const | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystemDirectory` | :ref:`get_filesystem` **(** **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystemDirectory` | :ref:`get_path` **(** :ref:`String` path **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_scanning_progress` **(** **)** const | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_scanning` **(** **)** const | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scan` **(** **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scan_sources` **(** **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_file` **(** :ref:`String` path **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file_type` **(** :ref:`String` path **)** const | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystemDirectory` | :ref:`get_filesystem` **(** **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystemDirectory` | :ref:`get_filesystem_path` **(** :ref:`String` path **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_scanning_progress` **(** **)** const | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_scanning` **(** **)** const | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scan` **(** **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scan_sources` **(** **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_file` **(** :ref:`String` path **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -62,9 +62,9 @@ Get the type of the file, given the full path. Get the root directory object. -.. _class_EditorFileSystem_get_path: +.. _class_EditorFileSystem_get_filesystem_path: -- :ref:`EditorFileSystemDirectory` **get_path** **(** :ref:`String` path **)** +- :ref:`EditorFileSystemDirectory` **get_filesystem_path** **(** :ref:`String` path **)** .. _class_EditorFileSystem_get_scanning_progress: diff --git a/classes/class_editorfilesystemdirectory.rst b/classes/class_editorfilesystemdirectory.rst index e1907e160..482289cd2 100644 --- a/classes/class_editorfilesystemdirectory.rst +++ b/classes/class_editorfilesystemdirectory.rst @@ -41,8 +41,6 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_subdir_count` **(** **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_missing_sources` **(** :ref:`int` idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- @@ -91,8 +89,4 @@ Member Function Description - :ref:`int` **get_subdir_count** **(** **)** const -.. _class_EditorFileSystemDirectory_is_missing_sources: - -- :ref:`bool` **is_missing_sources** **(** :ref:`int` idx **)** const - diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst deleted file mode 100644 index 63b90d98f..000000000 --- a/classes/class_editorimportplugin.rst +++ /dev/null @@ -1,117 +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_EditorImportPlugin: - -EditorImportPlugin -================== - -**Inherits:** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Import plugin for editor - -Member Functions ----------------- - -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_reimport_multiple_files` **(** **)** virtual | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`custom_export` **(** :ref:`String` path, EditorExportPlatform platform **)** virtual | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`expand_source_path` **(** :ref:`String` path **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** virtual | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_visible_name` **(** **)** virtual | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`import` **(** :ref:`String` path, :ref:`ResourceImportMetadata` from **)** virtual | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`import_dialog` **(** :ref:`String` from **)** virtual | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`import_from_drop` **(** :ref:`StringArray` files, :ref:`String` dest_path **)** virtual | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reimport_multiple_files` **(** :ref:`StringArray` files **)** virtual | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`validate_source_path` **(** :ref:`String` path **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Description ------------ - -Import plugins make it easy to handle importing of external assets into a project. They way they work is not that obvious though, so please make sure to read the documentation, tutorials and examples. - -Member Function Description ---------------------------- - -.. _class_EditorImportPlugin_can_reimport_multiple_files: - -- :ref:`bool` **can_reimport_multiple_files** **(** **)** virtual - -.. _class_EditorImportPlugin_custom_export: - -- :ref:`RawArray` **custom_export** **(** :ref:`String` path, EditorExportPlatform platform **)** virtual - -Generally, files that are imported stay the same when exported. The only exception is in some cases when the file must be re-imported for different platforms (ie. texture compression). - -If you want to customize the export process, it's recommended to use :ref:`EditorExportPlugin.custom_export` instead. - -.. _class_EditorImportPlugin_expand_source_path: - -- :ref:`String` **expand_source_path** **(** :ref:`String` path **)** - -.. _class_EditorImportPlugin_get_name: - -- :ref:`String` **get_name** **(** **)** virtual - -Get the name of the import plugin, which will be used to identify content imported by this plugin. Try to use lowercase and underscores if possible. - -.. _class_EditorImportPlugin_get_visible_name: - -- :ref:`String` **get_visible_name** **(** **)** virtual - -Visible name for this plugin, which will be shown on the import menu. - -.. _class_EditorImportPlugin_import: - -- :ref:`int` **import** **(** :ref:`String` path, :ref:`ResourceImportMetadata` from **)** virtual - -Perform an import of an external resources into the project. This function is both called on import (from the dialog) or re-import (manual or automatic when external source files changed). - -An import process generally works like this: - -1) Check the metadata for source files and options. Metadata is either generated in the import dialog or taken from an existing resource upon reimport. - -2) Perform the import process into a new resource. Some times the resource being re-imported may be already loaded and in use, so checking for this by using :ref:`ResourceLoader.has` is recommended. Otherwise create a new resource. - -3) Set the metadata from the argument into the existing or new resource being created using :ref:`Resource.set_import_metadata`. - -4) Save the resource into 'path' (function argument) - -.. _class_EditorImportPlugin_import_dialog: - -- void **import_dialog** **(** :ref:`String` from **)** virtual - -This function is called when either the user chooses to import a resource of this type (Import menu), or when the user chooses to re-import the resource (from filesystem). In the later case, the path for the existing file is supplied in the argument. - -If the path is supplied, it is recommended to read the import metadata with :ref:`ResourceLoader.load_import_metadata` and fill in the fields with the values contained there. - -The dialog can be shown in any way (just use a ConfirmationDialog and pop it up). Upon confirmation, fill up a ResourceImportMetadata and call the :ref:`EditorImportPlugin.import` function with this information. - -.. _class_EditorImportPlugin_import_from_drop: - -- void **import_from_drop** **(** :ref:`StringArray` files, :ref:`String` dest_path **)** virtual - -.. _class_EditorImportPlugin_reimport_multiple_files: - -- void **reimport_multiple_files** **(** :ref:`StringArray` files **)** virtual - -.. _class_EditorImportPlugin_validate_source_path: - -- :ref:`String` **validate_source_path** **(** :ref:`String` path **)** - - diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index d14c5faf7..af8272881 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -27,9 +27,7 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_custom_type` **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_export_plugin` **(** :ref:`EditorExportPlugin` plugin **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_import_plugin` **(** :ref:`EditorImportPlugin` plugin **)** | +| void | :ref:`add_tool_submenu_item` **(** :ref:`String` name, :ref:`PopupMenu` submenu **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_changes` **(** **)** virtual | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -39,22 +37,22 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`edit` **(** :ref:`Object` object **)** virtual | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`forward_canvas_input_event` **(** :ref:`Matrix32` canvas_xform, :ref:`InputEvent` event **)** virtual | +| void | :ref:`edit_resource` **(** :ref:`Object` arg0 **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`forward_draw_over_canvas` **(** :ref:`Matrix32` canvas_xform, :ref:`Control` canvas **)** virtual | +| :ref:`bool` | :ref:`forward_canvas_gui_input` **(** :ref:`Transform2D` canvas_xform, :ref:`InputEvent` event **)** virtual | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`forward_spatial_input_event` **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual | +| void | :ref:`forward_draw_over_canvas` **(** :ref:`Transform2D` canvas_xform, :ref:`Control` canvas **)** virtual | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`forward_spatial_gui_input` **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`get_base_control` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_breakpoints` **(** **)** virtual | +| :ref:`PoolStringArray` | :ref:`get_breakpoints` **(** **)** virtual | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorSettings` | :ref:`get_editor_settings` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`get_editor_viewport` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_resource` **(** :ref:`Resource` p_resource **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_name` **(** **)** virtual | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorFileSystem` | :ref:`get_resource_filesystem` **(** **)** | @@ -89,10 +87,6 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_custom_type` **(** :ref:`String` type **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_export_plugin` **(** :ref:`EditorExportPlugin` plugin **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_import_plugin` **(** :ref:`EditorImportPlugin` plugin **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`save_external_data` **(** **)** virtual | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_state` **(** :ref:`Dictionary` state **)** virtual | @@ -168,19 +162,9 @@ You can use the :ref:`EditorPlugin.handles` to check During run-time, this will be a simple object with a script so this function does not need to be called then. -.. _class_EditorPlugin_add_export_plugin: +.. _class_EditorPlugin_add_tool_submenu_item: -- void **add_export_plugin** **(** :ref:`EditorExportPlugin` plugin **)** - -Add an export plugin. Plugins of this kind can change files being exported. On exit don't forget to call :ref:`remove_export_plugin`. - -.. _class_EditorPlugin_add_import_plugin: - -- void **add_import_plugin** **(** :ref:`EditorImportPlugin` plugin **)** - -Add an import plugin. These plugins manage importing external content (from outside the project) into formats the engine can understand. - -On exit, don't forget to remove the plugin by calling :ref:`remove_import_plugin` +- void **add_tool_submenu_item** **(** :ref:`String` name, :ref:`PopupMenu` submenu **)** .. _class_EditorPlugin_apply_changes: @@ -208,21 +192,25 @@ This is used for plugins that create gizmos used by the spatial editor. Just che This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object. -.. _class_EditorPlugin_forward_canvas_input_event: +.. _class_EditorPlugin_edit_resource: -- :ref:`bool` **forward_canvas_input_event** **(** :ref:`Matrix32` canvas_xform, :ref:`InputEvent` event **)** virtual +- void **edit_resource** **(** :ref:`Object` arg0 **)** + +.. _class_EditorPlugin_forward_canvas_gui_input: + +- :ref:`bool` **forward_canvas_gui_input** **(** :ref:`Transform2D` canvas_xform, :ref:`InputEvent` event **)** virtual If your plugin is active (because handles() returned true to the object), any input interaction with the 2D canvas editor will be first forwarded here. The canvas transform (containing zoom and offset to transform to edited world coordinates) is provided, but the input supplied is in untransformed coordinates to the canvas editor. Return true if you want to eat this event and not pass it to the canvas editor. .. _class_EditorPlugin_forward_draw_over_canvas: -- void **forward_draw_over_canvas** **(** :ref:`Matrix32` canvas_xform, :ref:`Control` canvas **)** virtual +- void **forward_draw_over_canvas** **(** :ref:`Transform2D` canvas_xform, :ref:`Control` canvas **)** virtual This function is called every time the 2D canvas editor draws (which overlays over the edited scene). Drawing over the supplied control will draw over the edited scene. To convert from control coordinates to edited scene coordinates (including zoom and offset), a transform is also provided. If you require this control to be redraw, call :ref:`update_canvas`. -.. _class_EditorPlugin_forward_spatial_input_event: +.. _class_EditorPlugin_forward_spatial_gui_input: -- :ref:`bool` **forward_spatial_input_event** **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual +- :ref:`bool` **forward_spatial_gui_input** **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual This is a low level function for plugins that edit a given objet type derived from Spatial to capture the input of the viewport. The function is only being called if your object is being edited. @@ -238,7 +226,7 @@ Get a base control where it's safe to place dialogs. Many plugins open dialogs a .. _class_EditorPlugin_get_breakpoints: -- :ref:`StringArray` **get_breakpoints** **(** **)** virtual +- :ref:`PoolStringArray` **get_breakpoints** **(** **)** virtual This is for editors that edit script based objects. You can return a list of breakpoints in the format (script:line), for example: res://path_to_script.gd:25 @@ -254,12 +242,6 @@ Get the general settings for the editor (the same window that appears in the Set Get the main editor control. Use this as a parent for main screens. -.. _class_EditorPlugin_edit_resource: - -- void **edit_resource** **(** :ref:`Resource` p_resource **)** - -Tells the editor to handle the edit of the given resource. Ex: If you pass a Script as a argument, the editor will open the scriptEditor. - .. _class_EditorPlugin_get_name: - :ref:`String` **get_name** **(** **)** virtual @@ -360,18 +342,6 @@ Remove the control from the dock. Don't forget to call this if you added one, so Remove a custom type added by :ref:`EditorPlugin.add_custom_type` -.. _class_EditorPlugin_remove_export_plugin: - -- void **remove_export_plugin** **(** :ref:`EditorExportPlugin` plugin **)** - -Remove the export plugin, don't forget to call this on exit. - -.. _class_EditorPlugin_remove_import_plugin: - -- void **remove_import_plugin** **(** :ref:`EditorImportPlugin` plugin **)** - -Remove the import plugin, don't forget to call this on exit. - .. _class_EditorPlugin_save_external_data: - void **save_external_data** **(** **)** virtual diff --git a/classes/class_editorscenepostimport.rst b/classes/class_editorscenepostimport.rst deleted file mode 100644 index 98c6e113e..000000000 --- a/classes/class_editorscenepostimport.rst +++ /dev/null @@ -1,41 +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_EditorScenePostImport: - -EditorScenePostImport -===================== - -**Inherits:** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Base script for post-processing scenes being imported. - -Member Functions ----------------- - -+-------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`post_import` **(** :ref:`Object` scene **)** virtual | -+-------+---------------------------------------------------------------------------------------------------------------------+ - -Description ------------ - -These scripts can modify scenes after being imported by the 3D Scene import option of the Import menu. - -Member Function Description ---------------------------- - -.. _class_EditorScenePostImport_post_import: - -- void **post_import** **(** :ref:`Object` scene **)** virtual - -This function is called upon import with the imported scene. - -Just do any changes desired to the scene and return it. If null is returned, import will fail and throw an error to the user. - - diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 7abf3d9b8..ff385b788 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -18,23 +18,23 @@ Object that holds the project-independent editor settings. Member Functions ---------------- -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_property_info` **(** :ref:`Dictionary` info **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase` **(** :ref:`String` property **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_favorite_dirs` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_project_settings_path` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_recent_dirs` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_settings_path` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_favorite_dirs` **(** :ref:`StringArray` dirs **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_recent_dirs` **(** :ref:`StringArray` dirs **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_property_info` **(** :ref:`Dictionary` info **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase` **(** :ref:`String` property **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_favorite_dirs` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_project_settings_path` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_recent_dirs` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_settings_path` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_favorite_dirs` **(** :ref:`PoolStringArray` dirs **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_recent_dirs` **(** :ref:`PoolStringArray` dirs **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -86,7 +86,7 @@ Erase a given setting (pass full property path). .. _class_EditorSettings_get_favorite_dirs: -- :ref:`StringArray` **get_favorite_dirs** **(** **)** const +- :ref:`PoolStringArray` **get_favorite_dirs** **(** **)** const Get the list of favorite directories for this project. @@ -98,7 +98,7 @@ Get the specific project settings path. Projects all have an unique sub-director .. _class_EditorSettings_get_recent_dirs: -- :ref:`StringArray` **get_recent_dirs** **(** **)** const +- :ref:`PoolStringArray` **get_recent_dirs** **(** **)** const Get the list of recently visited folders in the file dialog for this project. @@ -114,13 +114,13 @@ settings/templates - where export templates are located .. _class_EditorSettings_set_favorite_dirs: -- void **set_favorite_dirs** **(** :ref:`StringArray` dirs **)** +- void **set_favorite_dirs** **(** :ref:`PoolStringArray` dirs **)** Set the list of favorite directories for this project. .. _class_EditorSettings_set_recent_dirs: -- void **set_recent_dirs** **(** :ref:`StringArray` dirs **)** +- void **set_recent_dirs** **(** :ref:`PoolStringArray` dirs **)** Set the list of recently visited folders in the file dialog for this project. diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index 1ddaff972..b54913426 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -18,33 +18,33 @@ Custom gizmo for editing Spatial objects. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_segments` **(** :ref:`Vector3Array` segments **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_triangles` **(** TriangleMesh triangles **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_handles` **(** :ref:`Vector3Array` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_lines` **(** :ref:`Vector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_mesh` **(** :ref:`Mesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton=RID() **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_unscaled_billboard` **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`commit_handle` **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel **)** virtual | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_handle_name` **(** :ref:`int` index **)** virtual | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_handle_value` **(** :ref:`int` index **)** virtual | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`redraw` **(** **)** virtual | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_handle` **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_spatial_node` **(** :ref:`Spatial` node **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_segments` **(** :ref:`PoolVector3Array` segments **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_handles` **(** :ref:`PoolVector3Array` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_lines` **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_mesh` **(** :ref:`Mesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton=RID() **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_unscaled_billboard` **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`commit_handle` **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel **)** virtual | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_handle_name` **(** :ref:`int` index **)** virtual | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_handle_value` **(** :ref:`int` index **)** virtual | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`redraw` **(** **)** virtual | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_handle` **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_spatial_node` **(** :ref:`Spatial` node **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -56,17 +56,17 @@ Member Function Description .. _class_EditorSpatialGizmo_add_collision_segments: -- void **add_collision_segments** **(** :ref:`Vector3Array` segments **)** +- void **add_collision_segments** **(** :ref:`PoolVector3Array` segments **)** .. _class_EditorSpatialGizmo_add_collision_triangles: -- void **add_collision_triangles** **(** TriangleMesh triangles **)** +- void **add_collision_triangles** **(** :ref:`TriangleMesh` triangles **)** Add collision triangles to the gizmo for picking. A :ref:`TriangleMesh` can be generated from a regular :ref:`Mesh` too. Call this function during :ref:`redraw`. .. _class_EditorSpatialGizmo_add_handles: -- void **add_handles** **(** :ref:`Vector3Array` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** +- void **add_handles** **(** :ref:`PoolVector3Array` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** Add a list of handles (points) which can be used to deform the object being edited. @@ -74,7 +74,7 @@ There are virtual functions which will be called upon editing of these handles. .. _class_EditorSpatialGizmo_add_lines: -- void **add_lines** **(** :ref:`Vector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** +- void **add_lines** **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** Add lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during :ref:`redraw`. diff --git a/classes/class_engine.rst b/classes/class_engine.rst new file mode 100644 index 000000000..11ca1df58 --- /dev/null +++ b/classes/class_engine.rst @@ -0,0 +1,120 @@ +.. 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_Engine: + +Engine +====== + +**Inherits:** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_custom_level` **(** **)** const | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frames_drawn` **(** **)** | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_frames_per_second` **(** **)** const | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_iterations_per_second` **(** **)** const | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`MainLoop` | :ref:`get_main_loop` **(** **)** const | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_target_fps` **(** **)** const | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_time_scale` **(** **)** | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_version_info` **(** **)** const | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_iterations_per_second` **(** :ref:`int` iterations_per_second **)** | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_target_fps` **(** :ref:`int` target_fps **)** | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_time_scale` **(** :ref:`float` time_scale **)** | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_Engine_get_custom_level: + +- :ref:`String` **get_custom_level** **(** **)** const + +Returns the value of the commandline argument "-level". + +.. _class_Engine_get_frames_drawn: + +- :ref:`int` **get_frames_drawn** **(** **)** + +Return the total amount of frames drawn. + +.. _class_Engine_get_frames_per_second: + +- :ref:`float` **get_frames_per_second** **(** **)** const + +Returns the frames per second of the running game. + +.. _class_Engine_get_iterations_per_second: + +- :ref:`int` **get_iterations_per_second** **(** **)** const + +Return the amount of fixed iterations per second (for fixed process and physics). + +.. _class_Engine_get_main_loop: + +- :ref:`MainLoop` **get_main_loop** **(** **)** const + +Return the main loop object (see :ref:`MainLoop` and :ref:`SceneTree`). + +.. _class_Engine_get_target_fps: + +- :ref:`float` **get_target_fps** **(** **)** const + +.. _class_Engine_get_time_scale: + +- :ref:`float` **get_time_scale** **(** **)** + +.. _class_Engine_get_version_info: + +- :ref:`Dictionary` **get_version_info** **(** **)** const + +Returns the current engine version information in a Dictionary. + + + +"major" - Holds the major version number as a String + +"minor" - Holds the minor version number as a String + +"patch" - Holds the patch version number as a String + +"status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String + +"revision" - Holds the revision (e.g. "custom-build") as a String + +"string" - major + minor + patch + status + revision in a single String + +.. _class_Engine_set_iterations_per_second: + +- void **set_iterations_per_second** **(** :ref:`int` iterations_per_second **)** + +Set the amount of fixed iterations per second (for fixed process and physics). + +.. _class_Engine_set_target_fps: + +- void **set_target_fps** **(** :ref:`int` target_fps **)** + +.. _class_Engine_set_time_scale: + +- void **set_time_scale** **(** :ref:`float` time_scale **)** + + diff --git a/classes/class_environment.rst b/classes/class_environment.rst index cee755732..c571a8a56 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -18,119 +18,781 @@ Brief Description Member Functions ---------------- -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fx_get_param` **(** :ref:`int` param **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fx_set_param` **(** :ref:`int` param, :ref:`Variant` value **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_background` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_background_param` **(** :ref:`int` param **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fx_enabled` **(** :ref:`int` effect **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_background` **(** :ref:`int` bgmode **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_background_param` **(** :ref:`int` param, :ref:`Variant` value **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enable_fx` **(** :ref:`int` effect, :ref:`bool` enabled **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_adjustment_brightness` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_adjustment_color_correction` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_adjustment_contrast` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_adjustment_saturation` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_ambient_light_color` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ambient_light_energy` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ambient_light_skybox_contribution` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_background` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_bg_color` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bg_energy` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_canvas_max_layer` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dof_blur_far_amount` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dof_blur_far_distance` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_dof_blur_far_quality` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dof_blur_far_transition` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dof_blur_near_amount` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dof_blur_near_distance` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_dof_blur_near_quality` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dof_blur_near_transition` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_glow_blend_mode` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_glow_bloom` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_glow_hdr_bleed_scale` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_glow_hdr_bleed_treshold` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_glow_intensity` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_glow_strength` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`CubeMap` | :ref:`get_skybox` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_skybox_scale` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssao_bias` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_ssao_color` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssao_direct_light_affect` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssao_intensity` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssao_intensity2` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssao_radius` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssao_radius2` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssr_accel` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssr_depth_tolerance` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssr_fade` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_ssr_max_steps` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_tonemap_auto_exposure` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tonemap_auto_exposure_grey` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tonemap_auto_exposure_max` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tonemap_auto_exposure_min` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tonemap_auto_exposure_speed` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tonemap_exposure` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tonemap_white` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tonemapper` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_adjustment_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_dof_blur_far_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_dof_blur_near_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_glow_bicubic_upscale_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_glow_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_glow_level_enabled` **(** :ref:`int` idx **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ssao_blur_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ssao_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ssr_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ssr_rough` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ssr_smooth` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_adjustment_brightness` **(** :ref:`float` brightness **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_adjustment_color_correction` **(** :ref:`Object` color_correction **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_adjustment_contrast` **(** :ref:`float` contrast **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_adjustment_enable` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_adjustment_saturation` **(** :ref:`float` saturation **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ambient_light_color` **(** :ref:`Color` color **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ambient_light_energy` **(** :ref:`float` energy **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ambient_light_skybox_contribution` **(** :ref:`float` energy **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_background` **(** :ref:`int` mode **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bg_color` **(** :ref:`Color` color **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bg_energy` **(** :ref:`float` energy **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_canvas_max_layer` **(** :ref:`int` layer **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_far_amount` **(** :ref:`float` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_far_distance` **(** :ref:`float` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_far_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_far_quality` **(** :ref:`int` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_far_transition` **(** :ref:`float` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_near_amount` **(** :ref:`float` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_near_distance` **(** :ref:`float` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_near_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_near_quality` **(** :ref:`int` level **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_near_transition` **(** :ref:`float` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_bicubic_upscale` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_blend_mode` **(** :ref:`int` mode **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_bloom` **(** :ref:`float` amount **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_hdr_bleed_scale` **(** :ref:`float` scale **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_hdr_bleed_treshold` **(** :ref:`float` treshold **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_intensity` **(** :ref:`float` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_level` **(** :ref:`int` idx, :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_strength` **(** :ref:`float` strength **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_skybox` **(** :ref:`CubeMap` skybox **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_skybox_scale` **(** :ref:`float` scale **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_bias` **(** :ref:`float` bias **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_blur` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_color` **(** :ref:`Color` color **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_direct_light_affect` **(** :ref:`float` amount **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_intensity` **(** :ref:`float` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_intensity2` **(** :ref:`float` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_radius` **(** :ref:`float` radius **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_radius2` **(** :ref:`float` radius **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_accel` **(** :ref:`float` accel **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_depth_tolerance` **(** :ref:`float` depth_tolerance **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_fade` **(** :ref:`float` fade **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_max_steps` **(** :ref:`int` max_steps **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_rough` **(** :ref:`bool` rough **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_smooth` **(** :ref:`bool` smooth **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_auto_exposure` **(** :ref:`bool` auto_exposure **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_auto_exposure_grey` **(** :ref:`float` exposure_grey **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_auto_exposure_max` **(** :ref:`float` exposure_max **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_auto_exposure_min` **(** :ref:`float` exposure_min **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_auto_exposure_speed` **(** :ref:`float` exposure_speed **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_exposure` **(** :ref:`float` exposure **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_white` **(** :ref:`float` white **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemapper` **(** :ref:`int` mode **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **adjustment_brightness** +- :ref:`Texture` **adjustment_color_correction** +- :ref:`float` **adjustment_contrast** +- :ref:`bool` **adjustment_enabled** +- :ref:`float` **adjustment_saturation** +- :ref:`Color` **ambient_light_color** +- :ref:`float` **ambient_light_energy** +- :ref:`float` **ambient_light_skybox_contribution** +- :ref:`bool` **auto_expoure_enabled** +- :ref:`float` **auto_expoure_max_luma** +- :ref:`float` **auto_expoure_min_luma** +- :ref:`float` **auto_expoure_scale** +- :ref:`float` **auto_expoure_speed** +- :ref:`int` **background_canvas_max_layer** +- :ref:`Color` **background_color** +- :ref:`float` **background_energy** +- :ref:`int` **background_mode** +- :ref:`SkyBox` **background_skybox** +- :ref:`float` **background_skybox_scale** +- :ref:`float` **dof_blur_far_amount** +- :ref:`float` **dof_blur_far_distance** +- :ref:`bool` **dof_blur_far_enabled** +- :ref:`int` **dof_blur_far_quality** +- :ref:`float` **dof_blur_far_transition** +- :ref:`float` **dof_blur_near_amount** +- :ref:`float` **dof_blur_near_distance** +- :ref:`bool` **dof_blur_near_enabled** +- :ref:`int` **dof_blur_near_quality** +- :ref:`float` **dof_blur_near_transition** +- :ref:`bool` **glow_bicubic_upscale** +- :ref:`int` **glow_blend_mode** +- :ref:`float` **glow_bloom** +- :ref:`bool` **glow_enabled** +- :ref:`float` **glow_hdr_scale** +- :ref:`float` **glow_hdr_treshold** +- :ref:`float` **glow_intensity** +- :ref:`bool` **glow_levels/1** +- :ref:`bool` **glow_levels/2** +- :ref:`bool` **glow_levels/3** +- :ref:`bool` **glow_levels/4** +- :ref:`bool` **glow_levels/5** +- :ref:`bool` **glow_levels/6** +- :ref:`bool` **glow_levels/7** +- :ref:`float` **glow_strength** +- :ref:`float` **ss_reflections_accel** +- :ref:`bool` **ss_reflections_accel_smooth** +- :ref:`float` **ss_reflections_depth_tolerance** +- :ref:`bool` **ss_reflections_enabled** +- :ref:`float` **ss_reflections_fade** +- :ref:`int` **ss_reflections_max_steps** +- :ref:`bool` **ss_reflections_roughness** +- :ref:`float` **ssao_bias** +- :ref:`bool` **ssao_blur** +- :ref:`Color` **ssao_color** +- :ref:`bool` **ssao_enabled** +- :ref:`float` **ssao_intensity** +- :ref:`float` **ssao_intensity2** +- :ref:`float` **ssao_light_affect** +- :ref:`float` **ssao_radius** +- :ref:`float` **ssao_radius2** +- :ref:`float` **tonemap_exposure** +- :ref:`int` **tonemap_mode** +- :ref:`float` **tonemap_white** Numeric Constants ----------------- -- **BG_KEEP** = **0** -- **BG_DEFAULT_COLOR** = **1** -- **BG_COLOR** = **2** -- **BG_TEXTURE** = **3** -- **BG_CUBEMAP** = **4** -- **BG_CANVAS** = **5** -- **BG_MAX** = **6** -- **BG_PARAM_CANVAS_MAX_LAYER** = **0** -- **BG_PARAM_COLOR** = **1** -- **BG_PARAM_TEXTURE** = **2** -- **BG_PARAM_CUBEMAP** = **3** -- **BG_PARAM_ENERGY** = **4** -- **BG_PARAM_GLOW** = **6** -- **BG_PARAM_MAX** = **7** -- **FX_AMBIENT_LIGHT** = **0** -- **FX_FXAA** = **1** -- **FX_GLOW** = **2** -- **FX_DOF_BLUR** = **3** -- **FX_HDR** = **4** -- **FX_FOG** = **5** -- **FX_BCS** = **6** -- **FX_SRGB** = **7** -- **FX_MAX** = **8** -- **FX_BLUR_BLEND_MODE_ADDITIVE** = **0** -- **FX_BLUR_BLEND_MODE_SCREEN** = **1** -- **FX_BLUR_BLEND_MODE_SOFTLIGHT** = **2** -- **FX_HDR_TONE_MAPPER_LINEAR** = **0** -- **FX_HDR_TONE_MAPPER_LOG** = **1** -- **FX_HDR_TONE_MAPPER_REINHARDT** = **2** -- **FX_HDR_TONE_MAPPER_REINHARDT_AUTOWHITE** = **3** -- **FX_PARAM_AMBIENT_LIGHT_COLOR** = **0** -- **FX_PARAM_AMBIENT_LIGHT_ENERGY** = **1** -- **FX_PARAM_GLOW_BLUR_PASSES** = **2** -- **FX_PARAM_GLOW_BLUR_SCALE** = **3** -- **FX_PARAM_GLOW_BLUR_STRENGTH** = **4** -- **FX_PARAM_GLOW_BLUR_BLEND_MODE** = **5** -- **FX_PARAM_GLOW_BLOOM** = **6** -- **FX_PARAM_GLOW_BLOOM_TRESHOLD** = **7** -- **FX_PARAM_DOF_BLUR_PASSES** = **8** -- **FX_PARAM_DOF_BLUR_BEGIN** = **9** -- **FX_PARAM_DOF_BLUR_RANGE** = **10** -- **FX_PARAM_HDR_TONEMAPPER** = **11** -- **FX_PARAM_HDR_EXPOSURE** = **12** -- **FX_PARAM_HDR_WHITE** = **13** -- **FX_PARAM_HDR_GLOW_TRESHOLD** = **14** -- **FX_PARAM_HDR_GLOW_SCALE** = **15** -- **FX_PARAM_HDR_MIN_LUMINANCE** = **16** -- **FX_PARAM_HDR_MAX_LUMINANCE** = **17** -- **FX_PARAM_HDR_EXPOSURE_ADJUST_SPEED** = **18** -- **FX_PARAM_FOG_BEGIN** = **19** -- **FX_PARAM_FOG_ATTENUATION** = **22** -- **FX_PARAM_FOG_BEGIN_COLOR** = **20** -- **FX_PARAM_FOG_END_COLOR** = **21** -- **FX_PARAM_FOG_BG** = **23** -- **FX_PARAM_BCS_BRIGHTNESS** = **24** -- **FX_PARAM_BCS_CONTRAST** = **25** -- **FX_PARAM_BCS_SATURATION** = **26** -- **FX_PARAM_MAX** = **27** +- **BG_KEEP** = **4** +- **BG_CLEAR_COLOR** = **0** +- **BG_COLOR** = **1** +- **BG_SKYBOX** = **2** +- **BG_CANVAS** = **3** +- **BG_MAX** = **5** +- **GLOW_BLEND_MODE_ADDITIVE** = **0** +- **GLOW_BLEND_MODE_SCREEN** = **1** +- **GLOW_BLEND_MODE_SOFTLIGHT** = **2** +- **GLOW_BLEND_MODE_REPLACE** = **3** +- **TONE_MAPPER_LINEAR** = **0** +- **TONE_MAPPER_REINHARDT** = **1** +- **TONE_MAPPER_FILMIC** = **2** +- **TONE_MAPPER_ACES** = **3** +- **DOF_BLUR_QUALITY_LOW** = **0** +- **DOF_BLUR_QUALITY_MEDIUM** = **1** +- **DOF_BLUR_QUALITY_HIGH** = **2** Member Function Description --------------------------- -.. _class_Environment_fx_get_param: +.. _class_Environment_get_adjustment_brightness: -- void **fx_get_param** **(** :ref:`int` param **)** const +- :ref:`float` **get_adjustment_brightness** **(** **)** const -.. _class_Environment_fx_set_param: +.. _class_Environment_get_adjustment_color_correction: -- void **fx_set_param** **(** :ref:`int` param, :ref:`Variant` value **)** +- :ref:`Object` **get_adjustment_color_correction** **(** **)** const + +.. _class_Environment_get_adjustment_contrast: + +- :ref:`float` **get_adjustment_contrast** **(** **)** const + +.. _class_Environment_get_adjustment_saturation: + +- :ref:`float` **get_adjustment_saturation** **(** **)** const + +.. _class_Environment_get_ambient_light_color: + +- :ref:`Color` **get_ambient_light_color** **(** **)** const + +.. _class_Environment_get_ambient_light_energy: + +- :ref:`float` **get_ambient_light_energy** **(** **)** const + +.. _class_Environment_get_ambient_light_skybox_contribution: + +- :ref:`float` **get_ambient_light_skybox_contribution** **(** **)** const .. _class_Environment_get_background: - :ref:`int` **get_background** **(** **)** const -.. _class_Environment_get_background_param: +.. _class_Environment_get_bg_color: -- void **get_background_param** **(** :ref:`int` param **)** const +- :ref:`Color` **get_bg_color** **(** **)** const -.. _class_Environment_is_fx_enabled: +.. _class_Environment_get_bg_energy: -- :ref:`bool` **is_fx_enabled** **(** :ref:`int` effect **)** const +- :ref:`float` **get_bg_energy** **(** **)** const + +.. _class_Environment_get_canvas_max_layer: + +- :ref:`int` **get_canvas_max_layer** **(** **)** const + +.. _class_Environment_get_dof_blur_far_amount: + +- :ref:`float` **get_dof_blur_far_amount** **(** **)** const + +.. _class_Environment_get_dof_blur_far_distance: + +- :ref:`float` **get_dof_blur_far_distance** **(** **)** const + +.. _class_Environment_get_dof_blur_far_quality: + +- :ref:`int` **get_dof_blur_far_quality** **(** **)** const + +.. _class_Environment_get_dof_blur_far_transition: + +- :ref:`float` **get_dof_blur_far_transition** **(** **)** const + +.. _class_Environment_get_dof_blur_near_amount: + +- :ref:`float` **get_dof_blur_near_amount** **(** **)** const + +.. _class_Environment_get_dof_blur_near_distance: + +- :ref:`float` **get_dof_blur_near_distance** **(** **)** const + +.. _class_Environment_get_dof_blur_near_quality: + +- :ref:`int` **get_dof_blur_near_quality** **(** **)** const + +.. _class_Environment_get_dof_blur_near_transition: + +- :ref:`float` **get_dof_blur_near_transition** **(** **)** const + +.. _class_Environment_get_glow_blend_mode: + +- :ref:`int` **get_glow_blend_mode** **(** **)** const + +.. _class_Environment_get_glow_bloom: + +- :ref:`float` **get_glow_bloom** **(** **)** const + +.. _class_Environment_get_glow_hdr_bleed_scale: + +- :ref:`float` **get_glow_hdr_bleed_scale** **(** **)** const + +.. _class_Environment_get_glow_hdr_bleed_treshold: + +- :ref:`float` **get_glow_hdr_bleed_treshold** **(** **)** const + +.. _class_Environment_get_glow_intensity: + +- :ref:`float` **get_glow_intensity** **(** **)** const + +.. _class_Environment_get_glow_strength: + +- :ref:`float` **get_glow_strength** **(** **)** const + +.. _class_Environment_get_skybox: + +- :ref:`CubeMap` **get_skybox** **(** **)** const + +.. _class_Environment_get_skybox_scale: + +- :ref:`float` **get_skybox_scale** **(** **)** const + +.. _class_Environment_get_ssao_bias: + +- :ref:`float` **get_ssao_bias** **(** **)** const + +.. _class_Environment_get_ssao_color: + +- :ref:`Color` **get_ssao_color** **(** **)** const + +.. _class_Environment_get_ssao_direct_light_affect: + +- :ref:`float` **get_ssao_direct_light_affect** **(** **)** const + +.. _class_Environment_get_ssao_intensity: + +- :ref:`float` **get_ssao_intensity** **(** **)** const + +.. _class_Environment_get_ssao_intensity2: + +- :ref:`float` **get_ssao_intensity2** **(** **)** const + +.. _class_Environment_get_ssao_radius: + +- :ref:`float` **get_ssao_radius** **(** **)** const + +.. _class_Environment_get_ssao_radius2: + +- :ref:`float` **get_ssao_radius2** **(** **)** const + +.. _class_Environment_get_ssr_accel: + +- :ref:`float` **get_ssr_accel** **(** **)** const + +.. _class_Environment_get_ssr_depth_tolerance: + +- :ref:`float` **get_ssr_depth_tolerance** **(** **)** const + +.. _class_Environment_get_ssr_fade: + +- :ref:`float` **get_ssr_fade** **(** **)** const + +.. _class_Environment_get_ssr_max_steps: + +- :ref:`int` **get_ssr_max_steps** **(** **)** const + +.. _class_Environment_get_tonemap_auto_exposure: + +- :ref:`bool` **get_tonemap_auto_exposure** **(** **)** const + +.. _class_Environment_get_tonemap_auto_exposure_grey: + +- :ref:`float` **get_tonemap_auto_exposure_grey** **(** **)** const + +.. _class_Environment_get_tonemap_auto_exposure_max: + +- :ref:`float` **get_tonemap_auto_exposure_max** **(** **)** const + +.. _class_Environment_get_tonemap_auto_exposure_min: + +- :ref:`float` **get_tonemap_auto_exposure_min** **(** **)** const + +.. _class_Environment_get_tonemap_auto_exposure_speed: + +- :ref:`float` **get_tonemap_auto_exposure_speed** **(** **)** const + +.. _class_Environment_get_tonemap_exposure: + +- :ref:`float` **get_tonemap_exposure** **(** **)** const + +.. _class_Environment_get_tonemap_white: + +- :ref:`float` **get_tonemap_white** **(** **)** const + +.. _class_Environment_get_tonemapper: + +- :ref:`int` **get_tonemapper** **(** **)** const + +.. _class_Environment_is_adjustment_enabled: + +- :ref:`bool` **is_adjustment_enabled** **(** **)** const + +.. _class_Environment_is_dof_blur_far_enabled: + +- :ref:`bool` **is_dof_blur_far_enabled** **(** **)** const + +.. _class_Environment_is_dof_blur_near_enabled: + +- :ref:`bool` **is_dof_blur_near_enabled** **(** **)** const + +.. _class_Environment_is_glow_bicubic_upscale_enabled: + +- :ref:`bool` **is_glow_bicubic_upscale_enabled** **(** **)** const + +.. _class_Environment_is_glow_enabled: + +- :ref:`bool` **is_glow_enabled** **(** **)** const + +.. _class_Environment_is_glow_level_enabled: + +- :ref:`bool` **is_glow_level_enabled** **(** :ref:`int` idx **)** const + +.. _class_Environment_is_ssao_blur_enabled: + +- :ref:`bool` **is_ssao_blur_enabled** **(** **)** const + +.. _class_Environment_is_ssao_enabled: + +- :ref:`bool` **is_ssao_enabled** **(** **)** const + +.. _class_Environment_is_ssr_enabled: + +- :ref:`bool` **is_ssr_enabled** **(** **)** const + +.. _class_Environment_is_ssr_rough: + +- :ref:`bool` **is_ssr_rough** **(** **)** const + +.. _class_Environment_is_ssr_smooth: + +- :ref:`bool` **is_ssr_smooth** **(** **)** const + +.. _class_Environment_set_adjustment_brightness: + +- void **set_adjustment_brightness** **(** :ref:`float` brightness **)** + +.. _class_Environment_set_adjustment_color_correction: + +- void **set_adjustment_color_correction** **(** :ref:`Object` color_correction **)** + +.. _class_Environment_set_adjustment_contrast: + +- void **set_adjustment_contrast** **(** :ref:`float` contrast **)** + +.. _class_Environment_set_adjustment_enable: + +- void **set_adjustment_enable** **(** :ref:`bool` enabled **)** + +.. _class_Environment_set_adjustment_saturation: + +- void **set_adjustment_saturation** **(** :ref:`float` saturation **)** + +.. _class_Environment_set_ambient_light_color: + +- void **set_ambient_light_color** **(** :ref:`Color` color **)** + +.. _class_Environment_set_ambient_light_energy: + +- void **set_ambient_light_energy** **(** :ref:`float` energy **)** + +.. _class_Environment_set_ambient_light_skybox_contribution: + +- void **set_ambient_light_skybox_contribution** **(** :ref:`float` energy **)** .. _class_Environment_set_background: -- void **set_background** **(** :ref:`int` bgmode **)** +- void **set_background** **(** :ref:`int` mode **)** -.. _class_Environment_set_background_param: +.. _class_Environment_set_bg_color: -- void **set_background_param** **(** :ref:`int` param, :ref:`Variant` value **)** +- void **set_bg_color** **(** :ref:`Color` color **)** -.. _class_Environment_set_enable_fx: +.. _class_Environment_set_bg_energy: -- void **set_enable_fx** **(** :ref:`int` effect, :ref:`bool` enabled **)** +- void **set_bg_energy** **(** :ref:`float` energy **)** + +.. _class_Environment_set_canvas_max_layer: + +- void **set_canvas_max_layer** **(** :ref:`int` layer **)** + +.. _class_Environment_set_dof_blur_far_amount: + +- void **set_dof_blur_far_amount** **(** :ref:`float` intensity **)** + +.. _class_Environment_set_dof_blur_far_distance: + +- void **set_dof_blur_far_distance** **(** :ref:`float` intensity **)** + +.. _class_Environment_set_dof_blur_far_enabled: + +- void **set_dof_blur_far_enabled** **(** :ref:`bool` enabled **)** + +.. _class_Environment_set_dof_blur_far_quality: + +- void **set_dof_blur_far_quality** **(** :ref:`int` intensity **)** + +.. _class_Environment_set_dof_blur_far_transition: + +- void **set_dof_blur_far_transition** **(** :ref:`float` intensity **)** + +.. _class_Environment_set_dof_blur_near_amount: + +- void **set_dof_blur_near_amount** **(** :ref:`float` intensity **)** + +.. _class_Environment_set_dof_blur_near_distance: + +- void **set_dof_blur_near_distance** **(** :ref:`float` intensity **)** + +.. _class_Environment_set_dof_blur_near_enabled: + +- void **set_dof_blur_near_enabled** **(** :ref:`bool` enabled **)** + +.. _class_Environment_set_dof_blur_near_quality: + +- void **set_dof_blur_near_quality** **(** :ref:`int` level **)** + +.. _class_Environment_set_dof_blur_near_transition: + +- void **set_dof_blur_near_transition** **(** :ref:`float` intensity **)** + +.. _class_Environment_set_glow_bicubic_upscale: + +- void **set_glow_bicubic_upscale** **(** :ref:`bool` enabled **)** + +.. _class_Environment_set_glow_blend_mode: + +- void **set_glow_blend_mode** **(** :ref:`int` mode **)** + +.. _class_Environment_set_glow_bloom: + +- void **set_glow_bloom** **(** :ref:`float` amount **)** + +.. _class_Environment_set_glow_enabled: + +- void **set_glow_enabled** **(** :ref:`bool` enabled **)** + +.. _class_Environment_set_glow_hdr_bleed_scale: + +- void **set_glow_hdr_bleed_scale** **(** :ref:`float` scale **)** + +.. _class_Environment_set_glow_hdr_bleed_treshold: + +- void **set_glow_hdr_bleed_treshold** **(** :ref:`float` treshold **)** + +.. _class_Environment_set_glow_intensity: + +- void **set_glow_intensity** **(** :ref:`float` intensity **)** + +.. _class_Environment_set_glow_level: + +- void **set_glow_level** **(** :ref:`int` idx, :ref:`bool` enabled **)** + +.. _class_Environment_set_glow_strength: + +- void **set_glow_strength** **(** :ref:`float` strength **)** + +.. _class_Environment_set_skybox: + +- void **set_skybox** **(** :ref:`CubeMap` skybox **)** + +.. _class_Environment_set_skybox_scale: + +- void **set_skybox_scale** **(** :ref:`float` scale **)** + +.. _class_Environment_set_ssao_bias: + +- void **set_ssao_bias** **(** :ref:`float` bias **)** + +.. _class_Environment_set_ssao_blur: + +- void **set_ssao_blur** **(** :ref:`bool` enabled **)** + +.. _class_Environment_set_ssao_color: + +- void **set_ssao_color** **(** :ref:`Color` color **)** + +.. _class_Environment_set_ssao_direct_light_affect: + +- void **set_ssao_direct_light_affect** **(** :ref:`float` amount **)** + +.. _class_Environment_set_ssao_enabled: + +- void **set_ssao_enabled** **(** :ref:`bool` enabled **)** + +.. _class_Environment_set_ssao_intensity: + +- void **set_ssao_intensity** **(** :ref:`float` intensity **)** + +.. _class_Environment_set_ssao_intensity2: + +- void **set_ssao_intensity2** **(** :ref:`float` intensity **)** + +.. _class_Environment_set_ssao_radius: + +- void **set_ssao_radius** **(** :ref:`float` radius **)** + +.. _class_Environment_set_ssao_radius2: + +- void **set_ssao_radius2** **(** :ref:`float` radius **)** + +.. _class_Environment_set_ssr_accel: + +- void **set_ssr_accel** **(** :ref:`float` accel **)** + +.. _class_Environment_set_ssr_depth_tolerance: + +- void **set_ssr_depth_tolerance** **(** :ref:`float` depth_tolerance **)** + +.. _class_Environment_set_ssr_enabled: + +- void **set_ssr_enabled** **(** :ref:`bool` enabled **)** + +.. _class_Environment_set_ssr_fade: + +- void **set_ssr_fade** **(** :ref:`float` fade **)** + +.. _class_Environment_set_ssr_max_steps: + +- void **set_ssr_max_steps** **(** :ref:`int` max_steps **)** + +.. _class_Environment_set_ssr_rough: + +- void **set_ssr_rough** **(** :ref:`bool` rough **)** + +.. _class_Environment_set_ssr_smooth: + +- void **set_ssr_smooth** **(** :ref:`bool` smooth **)** + +.. _class_Environment_set_tonemap_auto_exposure: + +- void **set_tonemap_auto_exposure** **(** :ref:`bool` auto_exposure **)** + +.. _class_Environment_set_tonemap_auto_exposure_grey: + +- void **set_tonemap_auto_exposure_grey** **(** :ref:`float` exposure_grey **)** + +.. _class_Environment_set_tonemap_auto_exposure_max: + +- void **set_tonemap_auto_exposure_max** **(** :ref:`float` exposure_max **)** + +.. _class_Environment_set_tonemap_auto_exposure_min: + +- void **set_tonemap_auto_exposure_min** **(** :ref:`float` exposure_min **)** + +.. _class_Environment_set_tonemap_auto_exposure_speed: + +- void **set_tonemap_auto_exposure_speed** **(** :ref:`float` exposure_speed **)** + +.. _class_Environment_set_tonemap_exposure: + +- void **set_tonemap_exposure** **(** :ref:`float` exposure **)** + +.. _class_Environment_set_tonemap_white: + +- void **set_tonemap_white** **(** :ref:`float` white **)** + +.. _class_Environment_set_tonemapper: + +- void **set_tonemapper** **(** :ref:`int` mode **)** diff --git a/classes/class_eventplayer.rst b/classes/class_eventplayer.rst deleted file mode 100644 index 175670c01..000000000 --- a/classes/class_eventplayer.rst +++ /dev/null @@ -1,253 +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_EventPlayer: - -EventPlayer -=========== - -**Inherits:** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Class for event stream playback. - -Member Functions ----------------- - -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_channel_last_note_time` **(** :ref:`int` channel **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_channel_volume` **(** :ref:`int` channel **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_length` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_loop_count` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pitch_scale` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pos` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EventStream` | :ref:`get_stream` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_stream_name` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tempo_scale` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume_db` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_autoplay` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_loop` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_paused` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek_pos` **(** :ref:`float` time **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autoplay` **(** :ref:`bool` enabled **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_channel_volume` **(** :ref:`int` channel, :ref:`float` channel_volume **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop` **(** :ref:`bool` enabled **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_paused` **(** :ref:`bool` paused **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pitch_scale` **(** :ref:`float` pitch_scale **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream` **(** :ref:`EventStream` stream **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tempo_scale` **(** :ref:`float` tempo_scale **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume` **(** :ref:`float` volume **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume_db` **(** :ref:`float` db **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Description ------------ - -Class for event stream playback. Event streams are music expressed as a series of events (note on, note off, instrument change...), as opposed to audio streams, which are just audio data. Examples of event-based streams are MIDI files, or MOD music. - -Currently, only MOD, S3M, IT, and XM music is supported. - -Member Function Description ---------------------------- - -.. _class_EventPlayer_get_channel_last_note_time: - -- :ref:`float` **get_channel_last_note_time** **(** :ref:`int` channel **)** const - -Return the time at which the last note of a given channel in the stream plays. - -.. _class_EventPlayer_get_channel_volume: - -- :ref:`float` **get_channel_volume** **(** :ref:`int` channel **)** const - -Return the volume scale for an individual channel of the stream. - -.. _class_EventPlayer_get_length: - -- :ref:`float` **get_length** **(** **)** const - -Return the song length. May be in seconds, but depends on the stream type. - -.. _class_EventPlayer_get_loop_count: - -- :ref:`int` **get_loop_count** **(** **)** const - -Return the number of times the playback has looped. - -.. _class_EventPlayer_get_pitch_scale: - -- :ref:`float` **get_pitch_scale** **(** **)** const - -Return the pitch scale factor for this player. - -.. _class_EventPlayer_get_pos: - -- :ref:`float` **get_pos** **(** **)** const - -Return the playback position. May be in seconds, but depends on the stream type. - -.. _class_EventPlayer_get_stream: - -- :ref:`EventStream` **get_stream** **(** **)** const - -Return the currently assigned stream. - -.. _class_EventPlayer_get_stream_name: - -- :ref:`String` **get_stream_name** **(** **)** const - -Return the name of the currently assigned stream. This is not the file name, but a field inside the file. If no stream is assigned, if returns "". - -.. _class_EventPlayer_get_tempo_scale: - -- :ref:`float` **get_tempo_scale** **(** **)** const - -Return the tempo multiplier. - -.. _class_EventPlayer_get_volume: - -- :ref:`float` **get_volume** **(** **)** const - -Return the playback volume for this player. - -.. _class_EventPlayer_get_volume_db: - -- :ref:`float` **get_volume_db** **(** **)** const - -Return the playback volume for this player, in decibels. - -.. _class_EventPlayer_has_autoplay: - -- :ref:`bool` **has_autoplay** **(** **)** const - -Return whether this player will start playing as soon as it enters the scene tree. - -.. _class_EventPlayer_has_loop: - -- :ref:`bool` **has_loop** **(** **)** const - -Return whether this player will be restart the playback at the end. - -.. _class_EventPlayer_is_paused: - -- :ref:`bool` **is_paused** **(** **)** const - -Return whether the playback is currently paused. - -.. _class_EventPlayer_is_playing: - -- :ref:`bool` **is_playing** **(** **)** const - -Return whether this player is playing. - -.. _class_EventPlayer_play: - -- void **play** **(** **)** - -Play the currently assigned stream. - -.. _class_EventPlayer_seek_pos: - -- void **seek_pos** **(** :ref:`float` time **)** - -Set the playback position. May be in seconds, but depends on the stream type. - -.. _class_EventPlayer_set_autoplay: - -- void **set_autoplay** **(** :ref:`bool` enabled **)** - -Set whether this player will start playing as soon as it enters the scene tree. - -.. _class_EventPlayer_set_channel_volume: - -- void **set_channel_volume** **(** :ref:`int` channel, :ref:`float` channel_volume **)** - -Set the volume scale for an individual channel of the stream, with the same value range as :ref:`set_volume`. The channel number depends on the stream format. For example, MIDIs range from 0 to 15, and MODs from 0 to 63. - -Many stream formats are multichannel, so this allows to affect only a part of the music. - -.. _class_EventPlayer_set_loop: - -- void **set_loop** **(** :ref:`bool` enabled **)** - -Set whether the stream will be restarted at the end. - -.. _class_EventPlayer_set_paused: - -- void **set_paused** **(** :ref:`bool` paused **)** - -Pause stream playback. - -.. _class_EventPlayer_set_pitch_scale: - -- void **set_pitch_scale** **(** :ref:`float` pitch_scale **)** - -Set the pitch multiplier for all sounds coming from this stream. A value of 2.0 shifts all pitches one octave up, and a value of 0.5 shifts pitches one octave down. - -.. _class_EventPlayer_set_stream: - -- void **set_stream** **(** :ref:`EventStream` stream **)** - -Set the :ref:`EventStream` this player will play. - -.. _class_EventPlayer_set_tempo_scale: - -- void **set_tempo_scale** **(** :ref:`float` tempo_scale **)** - -Set the tempo multiplier. This allows to slow down or speed up the music, without affecting its pitch. - -.. _class_EventPlayer_set_volume: - -- void **set_volume** **(** :ref:`float` volume **)** - -Set the playback volume for this player. This is a float between 0.0 (silent) and 1.0 (full volume). Values over 1.0 may amplify sound even more, but may introduce distortion. Negative values may just invert the output waveform, which produces no audible difference. - -The effect of these special values ultimately depends on the low-level implementation of the file format being played. - -.. _class_EventPlayer_set_volume_db: - -- void **set_volume_db** **(** :ref:`float` db **)** - -Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for over amplifying (see :ref:`set_volume`) still apply. - -.. _class_EventPlayer_stop: - -- void **stop** **(** **)** - -Stop playing. - - diff --git a/classes/class_eventstream.rst b/classes/class_eventstream.rst deleted file mode 100644 index cb5eaf787..000000000 --- a/classes/class_eventstream.rst +++ /dev/null @@ -1,26 +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_EventStream: - -EventStream -=========== - -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`EventStreamChibi` - -**Category:** Core - -Brief Description ------------------ - -Base class for all event-based stream drivers. - -Description ------------ - -Base class for all event-based stream drivers. Event streams are music expressed as a series of events (note on, note off, instrument change...), as opposed to audio streams, which are just audio data. Examples of event-based streams are MIDI files, of MOD music. - -This class exposes no methods. - diff --git a/classes/class_eventstreamchibi.rst b/classes/class_eventstreamchibi.rst deleted file mode 100644 index be4d9a7ab..000000000 --- a/classes/class_eventstreamchibi.rst +++ /dev/null @@ -1,32 +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_EventStreamChibi: - -EventStreamChibi -================ - -**Inherits:** :ref:`EventStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Driver for MOD playback. - -Description ------------ - -This driver plays MOD music. MOD music, as all event-based streams, is a music format defined by note events occurring at defined moments, instead of a stream of audio samples. - -Currently, this driver supports the MOD, S3M, IT, and XM formats. - -This class exposes no methods. - -This class can return its playback position in seconds, but does not allow to set it, failing with only a console warning. - -This class can not return its song length, returning 1.0 when queried. - -This class does not limit its volume settings, allowing for overflow/distortion and wave inversion. - diff --git a/classes/class_file.rst b/classes/class_file.rst index 1dcc1bc90..1bfbd3f72 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -18,89 +18,91 @@ Type to handle file reading and writing operations. Member Functions ---------------- -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`eof_reached` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_16` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_32` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_64` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_8` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_as_text` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`get_buffer` **(** :ref:`int` len **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_csv_line` **(** :ref:`String` delim="," **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_double` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_endian_swap` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`get_error` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_float` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_len` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_line` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_md5` **(** :ref:`String` path **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_pascal_string` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_pos` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_real` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_sha256` **(** :ref:`String` path **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_var` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_open` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`open` **(** :ref:`String` path, :ref:`int` flags **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`open_encrypted` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`RawArray` key **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`open_encrypted_with_pass` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`String` pass **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`int` pos **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek_end` **(** :ref:`int` pos=0 **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_endian_swap` **(** :ref:`bool` enable **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_16` **(** :ref:`int` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_32` **(** :ref:`int` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_64` **(** :ref:`int` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_8` **(** :ref:`int` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_buffer` **(** :ref:`RawArray` buffer **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_double` **(** :ref:`float` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_float` **(** :ref:`float` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_line` **(** :ref:`String` line **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_pascal_string` **(** :ref:`String` string **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_real` **(** :ref:`float` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_string` **(** :ref:`String` string **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_var` **(** :ref:`Variant` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`eof_reached` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_16` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_32` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_64` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_8` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_as_text` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_buffer` **(** :ref:`int` len **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_csv_line` **(** :ref:`String` delim="," **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_double` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_endian_swap` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`get_error` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_float` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_len` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_line` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_md5` **(** :ref:`String` path **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_modified_time` **(** :ref:`String` file **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_pascal_string` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_pos` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_real` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_sha256` **(** :ref:`String` path **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_var` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_open` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`open` **(** :ref:`String` path, :ref:`int` flags **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`open_encrypted` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`PoolByteArray` key **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`open_encrypted_with_pass` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`String` pass **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`int` pos **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek_end` **(** :ref:`int` pos=0 **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_endian_swap` **(** :ref:`bool` enable **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_16` **(** :ref:`int` value **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_32` **(** :ref:`int` value **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_64` **(** :ref:`int` value **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_8` **(** :ref:`int` value **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_buffer` **(** :ref:`PoolByteArray` buffer **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_double` **(** :ref:`float` value **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_float` **(** :ref:`float` value **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_line` **(** :ref:`String` line **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_pascal_string` **(** :ref:`String` string **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_real` **(** :ref:`float` value **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_string` **(** :ref:`String` string **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_var` **(** :ref:`Variant` value **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -185,13 +187,13 @@ Get the whole file as a :ref:`String`. .. _class_File_get_buffer: -- :ref:`RawArray` **get_buffer** **(** :ref:`int` len **)** const +- :ref:`PoolByteArray` **get_buffer** **(** :ref:`int` len **)** const -Get next len bytes of the file as a :ref:`RawArray`. +Get next len bytes of the file as a :ref:`PoolByteArray`. .. _class_File_get_csv_line: -- :ref:`StringArray` **get_csv_line** **(** :ref:`String` delim="," **)** const +- :ref:`PoolStringArray` **get_csv_line** **(** :ref:`String` delim="," **)** const Get the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma). @@ -237,6 +239,10 @@ Get the next line of the file as a :ref:`String`. Return a md5 String representing the file at the given path or an empty :ref:`String` on failure. +.. _class_File_get_modified_time: + +- :ref:`int` **get_modified_time** **(** :ref:`String` file **)** const + .. _class_File_get_pascal_string: - :ref:`String` **get_pascal_string** **(** **)** @@ -281,7 +287,7 @@ Open the file for writing or reading, depending on the flags. .. _class_File_open_encrypted: -- :ref:`int` **open_encrypted** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`RawArray` key **)** +- :ref:`int` **open_encrypted** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`PoolByteArray` key **)** Open an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. @@ -307,7 +313,7 @@ Change the file reading/writing cursor to the specified position (in bytes from - void **set_endian_swap** **(** :ref:`bool` enable **)** -Set whether to swap the endianess of the file. Enable this if you're dealing with files written in big endian machines. +Set whether to swap the endianness of the file. Enable this if you're dealing with files written in big endian machines. Note that this is about the file format, not CPU type. This is always reseted to ``false`` whenever you open the file. @@ -337,7 +343,7 @@ Store an integer as 8 bits in the file. .. _class_File_store_buffer: -- void **store_buffer** **(** :ref:`RawArray` buffer **)** +- void **store_buffer** **(** :ref:`PoolByteArray` buffer **)** Store the given array of bytes in the file. diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index ad330bbfd..5bef340b7 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -18,50 +18,58 @@ Dialog for selecting files or directories in the filesystem. Member Functions ---------------- -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_filter` **(** :ref:`String` filter **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_filters` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_access` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_dir` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_file` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_path` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_filters` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invalidate` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_showing_hidden_files` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_access` **(** :ref:`int` access **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_dir` **(** :ref:`String` dir **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_file` **(** :ref:`String` file **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_path` **(** :ref:`String` path **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filters` **(** :ref:`StringArray` filters **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_show_hidden_files` **(** :ref:`bool` show **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_filter` **(** :ref:`String` filter **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_filters` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_access` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_dir` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_file` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_path` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_filters` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mode` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invalidate` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_showing_hidden_files` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_access` **(** :ref:`int` access **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_dir` **(** :ref:`String` dir **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_file` **(** :ref:`String` file **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_path` **(** :ref:`String` path **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_filters` **(** :ref:`PoolStringArray` filters **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mode` **(** :ref:`int` mode **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_show_hidden_files` **(** :ref:`bool` show **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ Signals ------- - **dir_selected** **(** :ref:`String` dir **)** - **file_selected** **(** :ref:`String` path **)** -- **files_selected** **(** :ref:`StringArray` paths **)** +- **files_selected** **(** :ref:`PoolStringArray` paths **)** + +Member Variables +---------------- + +- :ref:`int` **access** +- :ref:`PoolStringArray` **filters** +- :ref:`int` **mode** +- :ref:`bool` **show_hidden_files** Numeric Constants ----------------- @@ -121,7 +129,7 @@ Get the current selected path (directory and file) of the file dialog (empty if .. _class_FileDialog_get_filters: -- :ref:`StringArray` **get_filters** **(** **)** const +- :ref:`PoolStringArray` **get_filters** **(** **)** const .. _class_FileDialog_get_mode: @@ -173,7 +181,7 @@ Set the current selected file path of the file dialog. .. _class_FileDialog_set_filters: -- void **set_filters** **(** :ref:`StringArray` filters **)** +- void **set_filters** **(** :ref:`PoolStringArray` filters **)** .. _class_FileDialog_set_mode: diff --git a/classes/class_fixedspatialmaterial.rst b/classes/class_fixedspatialmaterial.rst deleted file mode 100644 index e7c8b0431..000000000 --- a/classes/class_fixedspatialmaterial.rst +++ /dev/null @@ -1,156 +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_FixedSpatialMaterial: - -FixedSpatialMaterial -==================== - -**Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Simple Material with a fixed parameter set. - -Member Functions ----------------- - -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_fixed_flag` **(** :ref:`int` flag **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_light_shader` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_parameter` **(** :ref:`int` param **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_size` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_texcoord_mode` **(** :ref:`int` param **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` param **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_uv_transform` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fixed_flag` **(** :ref:`int` flag, :ref:`bool` value **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_light_shader` **(** :ref:`int` shader **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_parameter` **(** :ref:`int` param, :ref:`Variant` value **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_size` **(** :ref:`float` size **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texcoord_mode` **(** :ref:`int` param, :ref:`int` mode **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`int` param, :ref:`Texture` texture **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv_transform` **(** :ref:`Transform` transform **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - -Numeric Constants ------------------ - -- **PARAM_DIFFUSE** = **0** --- Diffuse Lighting (light scattered from surface). -- **PARAM_DETAIL** = **1** --- Detail Layer for diffuse lighting. -- **PARAM_SPECULAR** = **2** --- Specular Lighting (light reflected from the surface). -- **PARAM_EMISSION** = **3** --- Emission Lighting (light emitted from the surface). -- **PARAM_SPECULAR_EXP** = **4** --- Specular Exponent (size of the specular dot). -- **PARAM_GLOW** = **5** --- Glow (Visible emitted scattered light). -- **PARAM_NORMAL** = **6** --- Normal Map (irregularity map). -- **PARAM_SHADE_PARAM** = **7** -- **PARAM_MAX** = **8** --- Maximum amount of parameters. -- **TEXCOORD_UV** = **0** --- Read texture coordinates from the UV array. -- **TEXCOORD_UV_TRANSFORM** = **1** --- Read texture coordinates from the UV array and transform them by uv_xform. -- **TEXCOORD_UV2** = **2** --- Read texture coordinates from the UV2 array. -- **TEXCOORD_SPHERE** = **3** -- **FLAG_USE_ALPHA** = **0** -- **FLAG_USE_COLOR_ARRAY** = **1** -- **FLAG_USE_POINT_SIZE** = **2** -- **FLAG_DISCARD_ALPHA** = **3** -- **LIGHT_SHADER_LAMBERT** = **0** -- **LIGHT_SHADER_WRAP** = **1** -- **LIGHT_SHADER_VELVET** = **2** -- **LIGHT_SHADER_TOON** = **3** - -Description ------------ - -FixedSpatialMaterial is a simple type of material :ref:`Resource`, which contains a fixed amount of parameters. It is the only type of material supported in fixed-pipeline devices and APIs. It is also an often a better alternative to :ref:`ShaderMaterial` for most simple use cases. - -Member Function Description ---------------------------- - -.. _class_FixedSpatialMaterial_get_fixed_flag: - -- :ref:`bool` **get_fixed_flag** **(** :ref:`int` flag **)** const - -.. _class_FixedSpatialMaterial_get_light_shader: - -- :ref:`int` **get_light_shader** **(** **)** const - -.. _class_FixedSpatialMaterial_get_parameter: - -- void **get_parameter** **(** :ref:`int` param **)** const - -Return a parameter, parameters are defined in the PARAM\_\* enum. The type of each parameter may change, so it's best to check the enum. - -.. _class_FixedSpatialMaterial_get_point_size: - -- :ref:`float` **get_point_size** **(** **)** const - -.. _class_FixedSpatialMaterial_get_texcoord_mode: - -- :ref:`int` **get_texcoord_mode** **(** :ref:`int` param **)** const - -Return the texture coordinate mode. Each texture param (from the PARAM\_\* enum) has one. It defines how the textures are mapped to the object. - -.. _class_FixedSpatialMaterial_get_texture: - -- :ref:`Texture` **get_texture** **(** :ref:`int` param **)** const - -Return a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see :ref:`set_texcoord_mode`). - -.. _class_FixedSpatialMaterial_get_uv_transform: - -- :ref:`Transform` **get_uv_transform** **(** **)** const - -Returns the special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM. - -.. _class_FixedSpatialMaterial_set_fixed_flag: - -- void **set_fixed_flag** **(** :ref:`int` flag, :ref:`bool` value **)** - -.. _class_FixedSpatialMaterial_set_light_shader: - -- void **set_light_shader** **(** :ref:`int` shader **)** - -.. _class_FixedSpatialMaterial_set_parameter: - -- void **set_parameter** **(** :ref:`int` param, :ref:`Variant` value **)** - -Set a parameter, parameters are defined in the PARAM\_\* enum. The type of each parameter may change, so it's best to check the enum. - -.. _class_FixedSpatialMaterial_set_point_size: - -- void **set_point_size** **(** :ref:`float` size **)** - -.. _class_FixedSpatialMaterial_set_texcoord_mode: - -- void **set_texcoord_mode** **(** :ref:`int` param, :ref:`int` mode **)** - -Set the texture coordinate mode. Each texture param (from the PARAM\_\* enum) has one. It defines how the textures are mapped to the object. - -.. _class_FixedSpatialMaterial_set_texture: - -- void **set_texture** **(** :ref:`int` param, :ref:`Texture` texture **)** - -Set a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see :ref:`set_texcoord_mode`). - -.. _class_FixedSpatialMaterial_set_uv_transform: - -- void **set_uv_transform** **(** :ref:`Transform` transform **)** - -Sets a special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM. - - diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index 8c1b45a9c..403f20592 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -18,18 +18,18 @@ Brief Description Member Functions ---------------- -+----------------------------------+-----------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`get_as_byte_code` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`new` **(** **)** vararg | -+----------------------------------+-----------------------------------------------------------------------------+ ++--------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_as_byte_code` **(** **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`new` **(** **)** vararg | ++--------------------------------------------+-----------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_GDScript_get_as_byte_code: -- :ref:`RawArray` **get_as_byte_code** **(** **)** const +- :ref:`PoolByteArray` **get_as_byte_code** **(** **)** const .. _class_GDScript_new: diff --git a/classes/class_generic6dofjoint.rst b/classes/class_generic6dofjoint.rst index e0ec073d2..7861adbb5 100644 --- a/classes/class_generic6dofjoint.rst +++ b/classes/class_generic6dofjoint.rst @@ -44,6 +44,61 @@ Member Functions | void | :ref:`set_param_z` **(** :ref:`int` param, :ref:`float` value **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **angular_limit_x/damping** +- :ref:`bool` **angular_limit_x/enabled** +- :ref:`float` **angular_limit_x/erp** +- :ref:`float` **angular_limit_x/force_limit** +- :ref:`float` **angular_limit_x/lower_angle** +- :ref:`float` **angular_limit_x/restitution** +- :ref:`float` **angular_limit_x/softness** +- :ref:`float` **angular_limit_x/upper_angle** +- :ref:`float` **angular_limit_y/damping** +- :ref:`bool` **angular_limit_y/enabled** +- :ref:`float` **angular_limit_y/erp** +- :ref:`float` **angular_limit_y/force_limit** +- :ref:`float` **angular_limit_y/lower_angle** +- :ref:`float` **angular_limit_y/restitution** +- :ref:`float` **angular_limit_y/softness** +- :ref:`float` **angular_limit_y/upper_angle** +- :ref:`float` **angular_limit_z/damping** +- :ref:`bool` **angular_limit_z/enabled** +- :ref:`float` **angular_limit_z/erp** +- :ref:`float` **angular_limit_z/force_limit** +- :ref:`float` **angular_limit_z/lower_angle** +- :ref:`float` **angular_limit_z/restitution** +- :ref:`float` **angular_limit_z/softness** +- :ref:`float` **angular_limit_z/upper_angle** +- :ref:`bool` **angular_motor_x/enabled** +- :ref:`float` **angular_motor_x/force_limit** +- :ref:`float` **angular_motor_x/target_velocity** +- :ref:`bool` **angular_motor_y/enabled** +- :ref:`float` **angular_motor_y/force_limit** +- :ref:`float` **angular_motor_y/target_velocity** +- :ref:`bool` **angular_motor_z/enabled** +- :ref:`float` **angular_motor_z/force_limit** +- :ref:`float` **angular_motor_z/target_velocity** +- :ref:`float` **linear_limit_x/damping** +- :ref:`bool` **linear_limit_x/enabled** +- :ref:`float` **linear_limit_x/lower_distance** +- :ref:`float` **linear_limit_x/restitution** +- :ref:`float` **linear_limit_x/softness** +- :ref:`float` **linear_limit_x/upper_distance** +- :ref:`float` **linear_limit_y/damping** +- :ref:`bool` **linear_limit_y/enabled** +- :ref:`float` **linear_limit_y/lower_distance** +- :ref:`float` **linear_limit_y/restitution** +- :ref:`float` **linear_limit_y/softness** +- :ref:`float` **linear_limit_y/upper_distance** +- :ref:`float` **linear_limit_z/damping** +- :ref:`bool` **linear_limit_z/enabled** +- :ref:`float` **linear_limit_z/lower_distance** +- :ref:`float` **linear_limit_z/restitution** +- :ref:`float` **linear_limit_z/softness** +- :ref:`float` **linear_limit_z/upper_distance** + Numeric Constants ----------------- diff --git a/classes/class_geometry.rst b/classes/class_geometry.rst index 75313157a..876911511 100644 --- a/classes/class_geometry.rst +++ b/classes/class_geometry.rst @@ -18,41 +18,47 @@ Brief Description Member Functions ---------------- -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_box_planes` **(** :ref:`Vector3` extents **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_capsule_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`int` axis=2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_cylinder_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` axis=2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3Array` | :ref:`get_closest_points_between_segments` **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`get_closest_points_between_segments_2d` **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_uv84_normal_bit` **(** :ref:`Vector3` normal **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`make_atlas` **(** :ref:`Vector2Array` sizes **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`point_is_inside_triangle` **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`ray_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`segment_intersects_circle` **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_pos, :ref:`float` circle_radius **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3Array` | :ref:`segment_intersects_convex` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3Array` | :ref:`segment_intersects_cylinder` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`segment_intersects_segment_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3Array` | :ref:`segment_intersects_sphere` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` spos, :ref:`float` sradius **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`segment_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`IntArray` | :ref:`triangulate_polygon` **(** :ref:`Vector2Array` polygon **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`build_box_planes` **(** :ref:`Vector3` extents **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`build_capsule_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`int` axis=2 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`build_cylinder_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` axis=2 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point_to_segment_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_to_segment_uncapped` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point_to_segment_uncapped_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_closest_points_between_segments` **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_closest_points_between_segments_2d` **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_uv84_normal_bit` **(** :ref:`Vector3` normal **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`make_atlas` **(** :ref:`PoolVector2Array` sizes **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`point_is_inside_triangle` **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`ray_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`segment_intersects_circle` **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_pos, :ref:`float` circle_radius **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`segment_intersects_convex` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`segment_intersects_cylinder` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`segment_intersects_segment_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`segment_intersects_sphere` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` spos, :ref:`float` sradius **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`segment_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`triangulate_polygon` **(** :ref:`PoolVector2Array` polygon **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- @@ -73,13 +79,25 @@ Member Function Description - :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** +.. _class_Geometry_get_closest_point_to_segment_2d: + +- :ref:`Vector2` **get_closest_point_to_segment_2d** **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** + +.. _class_Geometry_get_closest_point_to_segment_uncapped: + +- :ref:`Vector3` **get_closest_point_to_segment_uncapped** **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** + +.. _class_Geometry_get_closest_point_to_segment_uncapped_2d: + +- :ref:`Vector2` **get_closest_point_to_segment_uncapped_2d** **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** + .. _class_Geometry_get_closest_points_between_segments: -- :ref:`Vector3Array` **get_closest_points_between_segments** **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** +- :ref:`PoolVector3Array` **get_closest_points_between_segments** **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** .. _class_Geometry_get_closest_points_between_segments_2d: -- :ref:`Vector2Array` **get_closest_points_between_segments_2d** **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** +- :ref:`PoolVector2Array` **get_closest_points_between_segments_2d** **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** .. _class_Geometry_get_uv84_normal_bit: @@ -87,7 +105,7 @@ Member Function Description .. _class_Geometry_make_atlas: -- :ref:`Dictionary` **make_atlas** **(** :ref:`Vector2Array` sizes **)** +- :ref:`Dictionary` **make_atlas** **(** :ref:`PoolVector2Array` sizes **)** .. _class_Geometry_point_is_inside_triangle: @@ -103,11 +121,11 @@ Member Function Description .. _class_Geometry_segment_intersects_convex: -- :ref:`Vector3Array` **segment_intersects_convex** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** +- :ref:`PoolVector3Array` **segment_intersects_convex** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** .. _class_Geometry_segment_intersects_cylinder: -- :ref:`Vector3Array` **segment_intersects_cylinder** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** +- :ref:`PoolVector3Array` **segment_intersects_cylinder** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** .. _class_Geometry_segment_intersects_segment_2d: @@ -115,7 +133,7 @@ Member Function Description .. _class_Geometry_segment_intersects_sphere: -- :ref:`Vector3Array` **segment_intersects_sphere** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` spos, :ref:`float` sradius **)** +- :ref:`PoolVector3Array` **segment_intersects_sphere** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` spos, :ref:`float` sradius **)** .. _class_Geometry_segment_intersects_triangle: @@ -123,6 +141,6 @@ Member Function Description .. _class_Geometry_triangulate_polygon: -- :ref:`IntArray` **triangulate_polygon** **(** :ref:`Vector2Array` polygon **)** +- :ref:`PoolIntArray` **triangulate_polygon** **(** :ref:`PoolVector2Array` polygon **)** diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index cb623d230..6963e4973 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -20,47 +20,59 @@ Base node for geometry based visual instances. Member Functions ---------------- -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_baked_light_texture_id` **(** **)** const | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_cast_shadows_setting` **(** **)** const | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_draw_range_begin` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_draw_range_end` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_extra_cull_margin` **(** **)** const | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_flag` **(** :ref:`int` flag **)** const | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lod_max_distance` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lod_max_hysteresis` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lod_min_distance` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lod_min_hysteresis` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_material_override` **(** **)** const | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_baked_light_texture_id` **(** :ref:`int` id **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_cast_shadows_setting` **(** :ref:`int` shadow_casting_setting **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_range_begin` **(** :ref:`float` mode **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_range_end` **(** :ref:`float` mode **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_extra_cull_margin` **(** :ref:`float` margin **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` value **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lod_max_distance` **(** :ref:`float` mode **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lod_max_hysteresis` **(** :ref:`float` mode **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lod_min_distance` **(** :ref:`float` mode **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lod_min_hysteresis` **(** :ref:`float` mode **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_material_override` **(** :ref:`Object` material **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **cast_shadow** +- :ref:`float` **extra_cull_margin** +- :ref:`int` **lod_max_distance** +- :ref:`int` **lod_max_hysteresis** +- :ref:`int` **lod_min_distance** +- :ref:`int` **lod_min_hysteresis** +- :ref:`Material` **material_override** +- :ref:`bool` **use_in_baked_light** +- :ref:`bool` **visible_in_all_rooms** + Numeric Constants ----------------- -- **FLAG_VISIBLE** = **0** -- **FLAG_CAST_SHADOW** = **3** -- **FLAG_RECEIVE_SHADOWS** = **4** -- **FLAG_BILLBOARD** = **1** -- **FLAG_BILLBOARD_FIX_Y** = **2** -- **FLAG_DEPH_SCALE** = **5** -- **FLAG_VISIBLE_IN_ALL_ROOMS** = **6** -- **FLAG_MAX** = **8** +- **FLAG_CAST_SHADOW** = **0** +- **FLAG_VISIBLE_IN_ALL_ROOMS** = **1** +- **FLAG_MAX** = **3** - **SHADOW_CASTING_SETTING_OFF** = **0** - **SHADOW_CASTING_SETTING_ON** = **1** - **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = **2** @@ -74,22 +86,10 @@ Base node for geometry based visual instances. Shares some common functionality Member Function Description --------------------------- -.. _class_GeometryInstance_get_baked_light_texture_id: - -- :ref:`int` **get_baked_light_texture_id** **(** **)** const - .. _class_GeometryInstance_get_cast_shadows_setting: - :ref:`int` **get_cast_shadows_setting** **(** **)** const -.. _class_GeometryInstance_get_draw_range_begin: - -- :ref:`float` **get_draw_range_begin** **(** **)** const - -.. _class_GeometryInstance_get_draw_range_end: - -- :ref:`float` **get_draw_range_end** **(** **)** const - .. _class_GeometryInstance_get_extra_cull_margin: - :ref:`float` **get_extra_cull_margin** **(** **)** const @@ -98,28 +98,32 @@ Member Function Description - :ref:`bool` **get_flag** **(** :ref:`int` flag **)** const +.. _class_GeometryInstance_get_lod_max_distance: + +- :ref:`float` **get_lod_max_distance** **(** **)** const + +.. _class_GeometryInstance_get_lod_max_hysteresis: + +- :ref:`float` **get_lod_max_hysteresis** **(** **)** const + +.. _class_GeometryInstance_get_lod_min_distance: + +- :ref:`float` **get_lod_min_distance** **(** **)** const + +.. _class_GeometryInstance_get_lod_min_hysteresis: + +- :ref:`float` **get_lod_min_hysteresis** **(** **)** const + .. _class_GeometryInstance_get_material_override: - :ref:`Object` **get_material_override** **(** **)** const Return the material override for the whole geometry. -.. _class_GeometryInstance_set_baked_light_texture_id: - -- void **set_baked_light_texture_id** **(** :ref:`int` id **)** - .. _class_GeometryInstance_set_cast_shadows_setting: - void **set_cast_shadows_setting** **(** :ref:`int` shadow_casting_setting **)** -.. _class_GeometryInstance_set_draw_range_begin: - -- void **set_draw_range_begin** **(** :ref:`float` mode **)** - -.. _class_GeometryInstance_set_draw_range_end: - -- void **set_draw_range_end** **(** :ref:`float` mode **)** - .. _class_GeometryInstance_set_extra_cull_margin: - void **set_extra_cull_margin** **(** :ref:`float` margin **)** @@ -128,6 +132,22 @@ Return the material override for the whole geometry. - void **set_flag** **(** :ref:`int` flag, :ref:`bool` value **)** +.. _class_GeometryInstance_set_lod_max_distance: + +- void **set_lod_max_distance** **(** :ref:`float` mode **)** + +.. _class_GeometryInstance_set_lod_max_hysteresis: + +- void **set_lod_max_hysteresis** **(** :ref:`float` mode **)** + +.. _class_GeometryInstance_set_lod_min_distance: + +- void **set_lod_min_distance** **(** :ref:`float` mode **)** + +.. _class_GeometryInstance_set_lod_min_hysteresis: + +- void **set_lod_min_hysteresis** **(** :ref:`float` mode **)** + .. _class_GeometryInstance_set_material_override: - void **set_material_override** **(** :ref:`Object` material **)** diff --git a/classes/class_giprobe.rst b/classes/class_giprobe.rst new file mode 100644 index 000000000..c1201e5e5 --- /dev/null +++ b/classes/class_giprobe.rst @@ -0,0 +1,167 @@ +.. 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_GIProbe: + +GIProbe +======= + +**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bake` **(** :ref:`Object` from_node=NULL, :ref:`bool` create_visual_debug=false **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`debug_bake` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bias` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_dynamic_range` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_energy` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_extents` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_probe_data` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_propagation` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdiv` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_compressed` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_interior` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bias` **(** :ref:`float` max **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_compress` **(** :ref:`bool` enable **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dynamic_range` **(** :ref:`int` max **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_energy` **(** :ref:`float` max **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_extents` **(** :ref:`Vector3` extents **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_interior` **(** :ref:`bool` enable **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_probe_data` **(** :ref:`Object` data **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_propagation` **(** :ref:`float` max **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subdiv` **(** :ref:`int` subdiv **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **bias** +- :ref:`bool` **compress** +- :ref:`GIProbeData` **data** +- :ref:`int` **dynamic_range** +- :ref:`float` **energy** +- :ref:`Vector3` **extents** +- :ref:`bool` **interior** +- :ref:`float` **propagation** +- :ref:`int` **subdiv** + +Numeric Constants +----------------- + +- **SUBDIV_64** = **0** +- **SUBDIV_128** = **1** +- **SUBDIV_256** = **2** +- **SUBDIV_MAX** = **4** + +Member Function Description +--------------------------- + +.. _class_GIProbe_bake: + +- void **bake** **(** :ref:`Object` from_node=NULL, :ref:`bool` create_visual_debug=false **)** + +.. _class_GIProbe_debug_bake: + +- void **debug_bake** **(** **)** + +.. _class_GIProbe_get_bias: + +- :ref:`float` **get_bias** **(** **)** const + +.. _class_GIProbe_get_dynamic_range: + +- :ref:`int` **get_dynamic_range** **(** **)** const + +.. _class_GIProbe_get_energy: + +- :ref:`float` **get_energy** **(** **)** const + +.. _class_GIProbe_get_extents: + +- :ref:`Vector3` **get_extents** **(** **)** const + +.. _class_GIProbe_get_probe_data: + +- :ref:`Object` **get_probe_data** **(** **)** const + +.. _class_GIProbe_get_propagation: + +- :ref:`float` **get_propagation** **(** **)** const + +.. _class_GIProbe_get_subdiv: + +- :ref:`int` **get_subdiv** **(** **)** const + +.. _class_GIProbe_is_compressed: + +- :ref:`bool` **is_compressed** **(** **)** const + +.. _class_GIProbe_is_interior: + +- :ref:`bool` **is_interior** **(** **)** const + +.. _class_GIProbe_set_bias: + +- void **set_bias** **(** :ref:`float` max **)** + +.. _class_GIProbe_set_compress: + +- void **set_compress** **(** :ref:`bool` enable **)** + +.. _class_GIProbe_set_dynamic_range: + +- void **set_dynamic_range** **(** :ref:`int` max **)** + +.. _class_GIProbe_set_energy: + +- void **set_energy** **(** :ref:`float` max **)** + +.. _class_GIProbe_set_extents: + +- void **set_extents** **(** :ref:`Vector3` extents **)** + +.. _class_GIProbe_set_interior: + +- void **set_interior** **(** :ref:`bool` enable **)** + +.. _class_GIProbe_set_probe_data: + +- void **set_probe_data** **(** :ref:`Object` data **)** + +.. _class_GIProbe_set_propagation: + +- void **set_propagation** **(** :ref:`float` max **)** + +.. _class_GIProbe_set_subdiv: + +- void **set_subdiv** **(** :ref:`int` subdiv **)** + + diff --git a/classes/class_giprobedata.rst b/classes/class_giprobedata.rst new file mode 100644 index 000000000..56cb5380b --- /dev/null +++ b/classes/class_giprobedata.rst @@ -0,0 +1,160 @@ +.. 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_GIProbeData: + +GIProbeData +=========== + +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bias` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`get_bounds` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_cell_size` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_dynamic_data` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_dynamic_range` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_energy` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_propagation` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_to_cell_xform` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_compressed` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_interior` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bias` **(** :ref:`float` bias **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bounds` **(** :ref:`Rect3` bounds **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_size` **(** :ref:`float` cell_size **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_compress` **(** :ref:`bool` compress **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dynamic_data` **(** :ref:`PoolIntArray` dynamic_data **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dynamic_range` **(** :ref:`int` dynamic_range **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_energy` **(** :ref:`float` energy **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_interior` **(** :ref:`bool` interior **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_propagation` **(** :ref:`float` propagation **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_to_cell_xform` **(** :ref:`Transform` to_cell_xform **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **bias** +- :ref:`Rect3` **bounds** +- :ref:`float` **cell_size** +- :ref:`bool` **compress** +- :ref:`PoolIntArray` **dynamic_data** +- :ref:`int` **dynamic_range** +- :ref:`float` **energy** +- :ref:`bool` **interior** +- :ref:`float` **propagation** +- :ref:`Transform` **to_cell_xform** + +Member Function Description +--------------------------- + +.. _class_GIProbeData_get_bias: + +- :ref:`float` **get_bias** **(** **)** const + +.. _class_GIProbeData_get_bounds: + +- :ref:`Rect3` **get_bounds** **(** **)** const + +.. _class_GIProbeData_get_cell_size: + +- :ref:`float` **get_cell_size** **(** **)** const + +.. _class_GIProbeData_get_dynamic_data: + +- :ref:`PoolIntArray` **get_dynamic_data** **(** **)** const + +.. _class_GIProbeData_get_dynamic_range: + +- :ref:`int` **get_dynamic_range** **(** **)** const + +.. _class_GIProbeData_get_energy: + +- :ref:`float` **get_energy** **(** **)** const + +.. _class_GIProbeData_get_propagation: + +- :ref:`float` **get_propagation** **(** **)** const + +.. _class_GIProbeData_get_to_cell_xform: + +- :ref:`Transform` **get_to_cell_xform** **(** **)** const + +.. _class_GIProbeData_is_compressed: + +- :ref:`bool` **is_compressed** **(** **)** const + +.. _class_GIProbeData_is_interior: + +- :ref:`bool` **is_interior** **(** **)** const + +.. _class_GIProbeData_set_bias: + +- void **set_bias** **(** :ref:`float` bias **)** + +.. _class_GIProbeData_set_bounds: + +- void **set_bounds** **(** :ref:`Rect3` bounds **)** + +.. _class_GIProbeData_set_cell_size: + +- void **set_cell_size** **(** :ref:`float` cell_size **)** + +.. _class_GIProbeData_set_compress: + +- void **set_compress** **(** :ref:`bool` compress **)** + +.. _class_GIProbeData_set_dynamic_data: + +- void **set_dynamic_data** **(** :ref:`PoolIntArray` dynamic_data **)** + +.. _class_GIProbeData_set_dynamic_range: + +- void **set_dynamic_range** **(** :ref:`int` dynamic_range **)** + +.. _class_GIProbeData_set_energy: + +- void **set_energy** **(** :ref:`float` energy **)** + +.. _class_GIProbeData_set_interior: + +- void **set_interior** **(** :ref:`bool` interior **)** + +.. _class_GIProbeData_set_propagation: + +- void **set_propagation** **(** :ref:`float` propagation **)** + +.. _class_GIProbeData_set_to_cell_xform: + +- void **set_to_cell_xform** **(** :ref:`Transform` to_cell_xform **)** + + diff --git a/classes/class_globals.rst b/classes/class_globalconfig.rst similarity index 53% rename from classes/class_globals.rst rename to classes/class_globalconfig.rst index 241e83e7d..33bb62d50 100644 --- a/classes/class_globals.rst +++ b/classes/class_globalconfig.rst @@ -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_Globals: +.. _class_GlobalConfig: -Globals -======= +GlobalConfig +============ **Inherits:** :ref:`Object` @@ -18,45 +18,47 @@ Contains global variables accessible from everywhere. Member Functions ---------------- -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_property_info` **(** :ref:`Dictionary` hint **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** :ref:`String` name **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_order` **(** :ref:`String` name **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_singleton` **(** :ref:`String` name **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`globalize_path` **(** :ref:`String` path **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** :ref:`String` name **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_singleton` **(** :ref:`String` name **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_persisting` **(** :ref:`String` name **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`load_resource_pack` **(** :ref:`String` pack **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`localize_path` **(** :ref:`String` path **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`save` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`save_custom` **(** :ref:`String` file **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_order` **(** :ref:`String` name, :ref:`int` pos **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_persisting` **(** :ref:`String` name, :ref:`bool` enable **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_property_info` **(** :ref:`Dictionary` hint **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** :ref:`String` name **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_order` **(** :ref:`String` name **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_singleton` **(** :ref:`String` name **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`globalize_path` **(** :ref:`String` path **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has` **(** :ref:`String` name **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_singleton` **(** :ref:`String` name **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`load_resource_pack` **(** :ref:`String` pack **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`localize_path` **(** :ref:`String` path **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`property_get_revert` **(** :ref:`String` name **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save_custom` **(** :ref:`String` file **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_initial_value` **(** :ref:`String` name, :ref:`Variant` value **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_order` **(** :ref:`String` name, :ref:`int` pos **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -Contains global variables accessible from everywhere. Use the normal :ref:`Object` API, such as "Globals.get(variable)", "Globals.set(variable,value)" or "Globals.has(variable)" to access them. Variables stored in engine.cfg are also loaded into globals, making this object very useful for reading custom game configuration options. +Contains global variables accessible from everywhere. Use the normal :ref:`Object` API, such as "Globals.get(variable)", "Globals.set(variable,value)" or "Globals.has(variable)" to access them. Variables stored in godot.cfg are also loaded into globals, making this object very useful for reading custom game configuration options. Member Function Description --------------------------- -.. _class_Globals_add_property_info: +.. _class_GlobalConfig_add_property_info: - void **add_property_info** **(** :ref:`Dictionary` hint **)** @@ -77,72 +79,72 @@ Example: Globals.add_property_info(property_info) -.. _class_Globals_clear: +.. _class_GlobalConfig_clear: - void **clear** **(** :ref:`String` name **)** Clear the whole configuration (not recommended, may break things). -.. _class_Globals_get_order: +.. _class_GlobalConfig_get_order: - :ref:`int` **get_order** **(** :ref:`String` name **)** const Return the order of a configuration value (influences when saved to the config file). -.. _class_Globals_get_singleton: +.. _class_GlobalConfig_get_singleton: - :ref:`Object` **get_singleton** **(** :ref:`String` name **)** const -.. _class_Globals_globalize_path: +.. _class_GlobalConfig_globalize_path: - :ref:`String` **globalize_path** **(** :ref:`String` path **)** const Convert a localized path (res://) to a full native OS path. -.. _class_Globals_has: +.. _class_GlobalConfig_has: - :ref:`bool` **has** **(** :ref:`String` name **)** const Return true if a configuration value is present. -.. _class_Globals_has_singleton: +.. _class_GlobalConfig_has_singleton: - :ref:`bool` **has_singleton** **(** :ref:`String` name **)** const -.. _class_Globals_is_persisting: - -- :ref:`bool` **is_persisting** **(** :ref:`String` name **)** const - -If returns true, this value can be saved to the configuration file. This is useful for editors. - -.. _class_Globals_load_resource_pack: +.. _class_GlobalConfig_load_resource_pack: - :ref:`bool` **load_resource_pack** **(** :ref:`String` pack **)** -.. _class_Globals_localize_path: +.. _class_GlobalConfig_localize_path: - :ref:`String` **localize_path** **(** :ref:`String` path **)** const Convert a path to a localized path (res:// path). -.. _class_Globals_save: +.. _class_GlobalConfig_property_can_revert: + +- :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** + +.. _class_GlobalConfig_property_get_revert: + +- void **property_get_revert** **(** :ref:`String` name **)** + +.. _class_GlobalConfig_save: - :ref:`int` **save** **(** **)** -.. _class_Globals_save_custom: +.. _class_GlobalConfig_save_custom: - :ref:`int` **save_custom** **(** :ref:`String` file **)** -.. _class_Globals_set_order: +.. _class_GlobalConfig_set_initial_value: + +- void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value **)** + +.. _class_GlobalConfig_set_order: - void **set_order** **(** :ref:`String` name, :ref:`int` pos **)** Set the order of a configuration value (influences when saved to the config file). -.. _class_Globals_set_persisting: - -- void **set_persisting** **(** :ref:`String` name, :ref:`bool` enable **)** - -If set to true, this value can be saved to the configuration file. This is useful for editors. - diff --git a/classes/class_gradienttexture.rst b/classes/class_gradienttexture.rst new file mode 100644 index 000000000..2b090c258 --- /dev/null +++ b/classes/class_gradienttexture.rst @@ -0,0 +1,111 @@ +.. 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_GradientTexture: + +GradientTexture +=============== + +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`float` offset, :ref:`Color` color **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** :ref:`int` point **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolColorArray` | :ref:`get_colors` **(** **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_offset` **(** :ref:`int` point **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`get_offsets` **(** **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`interpolate` **(** :ref:`float` offset **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` offset **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`int` point, :ref:`Color` color **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_colors` **(** :ref:`PoolColorArray` colors **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`int` point, :ref:`float` offset **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offsets` **(** :ref:`PoolRealArray` offsets **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_width` **(** :ref:`int` width **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **colors** +- :ref:`float` **offsets** +- :ref:`int` **width** + +Member Function Description +--------------------------- + +.. _class_GradientTexture_add_point: + +- void **add_point** **(** :ref:`float` offset, :ref:`Color` color **)** + +.. _class_GradientTexture_get_color: + +- :ref:`Color` **get_color** **(** :ref:`int` point **)** const + +.. _class_GradientTexture_get_colors: + +- :ref:`PoolColorArray` **get_colors** **(** **)** const + +.. _class_GradientTexture_get_offset: + +- :ref:`float` **get_offset** **(** :ref:`int` point **)** const + +.. _class_GradientTexture_get_offsets: + +- :ref:`PoolRealArray` **get_offsets** **(** **)** const + +.. _class_GradientTexture_get_point_count: + +- :ref:`int` **get_point_count** **(** **)** const + +.. _class_GradientTexture_interpolate: + +- :ref:`Color` **interpolate** **(** :ref:`float` offset **)** + +.. _class_GradientTexture_remove_point: + +- void **remove_point** **(** :ref:`int` offset **)** + +.. _class_GradientTexture_set_color: + +- void **set_color** **(** :ref:`int` point, :ref:`Color` color **)** + +.. _class_GradientTexture_set_colors: + +- void **set_colors** **(** :ref:`PoolColorArray` colors **)** + +.. _class_GradientTexture_set_offset: + +- void **set_offset** **(** :ref:`int` point, :ref:`float` offset **)** + +.. _class_GradientTexture_set_offsets: + +- void **set_offsets** **(** :ref:`PoolRealArray` offsets **)** + +.. _class_GradientTexture_set_width: + +- void **set_width** **(** :ref:`int` width **)** + + diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 32985db8f..cd2b936d9 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -39,8 +39,6 @@ Member Functions +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connection_output_type` **(** :ref:`int` idx **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_modulate` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_offset` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_overlay` **(** **)** const | @@ -61,20 +59,22 @@ Member Functions +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_resizeable` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selected` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_slot_enabled_left` **(** :ref:`int` idx **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_slot_enabled_right` **(** :ref:`int` idx **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_comment` **(** :ref:`bool` comment **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_modulate` **(** :ref:`Color` color **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_overlay` **(** :ref:`int` overlay **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_resizeable` **(** :ref:`bool` resizeable **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_selected` **(** :ref:`bool` selected **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_show_close_button` **(** :ref:`bool` show **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_slot` **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Object` custom_left=NULL, :ref:`Object` custom_right=NULL **)** | @@ -91,6 +91,13 @@ Signals - **raise_request** **(** **)** - **resize_request** **(** :ref:`Vector2` new_minsize **)** +Member Variables +---------------- + +- :ref:`bool` **resizeable** +- :ref:`bool` **show_close** +- :ref:`String` **title** + Numeric Constants ----------------- @@ -166,10 +173,6 @@ Return the position of the output connection 'idx'. Return the type of the output connection 'idx'. -.. _class_GraphNode_get_modulate: - -- :ref:`Color` **get_modulate** **(** **)** const - .. _class_GraphNode_get_offset: - :ref:`Vector2` **get_offset** **(** **)** const @@ -224,6 +227,10 @@ Returns true if the close button is shown. False otherwise. - :ref:`bool` **is_resizeable** **(** **)** const +.. _class_GraphNode_is_selected: + +- :ref:`bool` **is_selected** **(** **)** + .. _class_GraphNode_is_slot_enabled_left: - :ref:`bool` **is_slot_enabled_left** **(** :ref:`int` idx **)** const @@ -240,10 +247,6 @@ Return true if right (output) slot 'idx' is enabled. False otherwise. - void **set_comment** **(** :ref:`bool` comment **)** -.. _class_GraphNode_set_modulate: - -- void **set_modulate** **(** :ref:`Color` color **)** - .. _class_GraphNode_set_offset: - void **set_offset** **(** :ref:`Vector2` offset **)** @@ -258,6 +261,10 @@ Set the offset of the GraphNode. - void **set_resizeable** **(** :ref:`bool` resizeable **)** +.. _class_GraphNode_set_selected: + +- void **set_selected** **(** :ref:`bool` selected **)** + .. _class_GraphNode_set_show_close_button: - void **set_show_close_button** **(** :ref:`bool` show **)** diff --git a/classes/class_gridcontainer.rst b/classes/class_gridcontainer.rst index 101eed77e..019acdd7b 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_columns` **(** :ref:`int` columns **)** | +------------------------+-------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **columns** + Description ----------- diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index b831bb570..1ac1c822c 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -19,7 +19,7 @@ Member Functions ---------------- +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`area_get_bounds` **(** :ref:`int` area **)** const | +| :ref:`Rect3` | :ref:`area_get_bounds` **(** :ref:`int` area **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`area_get_name` **(** :ref:`int` area **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -37,11 +37,9 @@ Member Functions +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_set_portal_disable_distance` **(** :ref:`int` area, :ref:`float` distance **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bake_geometry` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_area` **(** :ref:`int` id, :ref:`AABB` area **)** | +| :ref:`int` | :ref:`create_area` **(** :ref:`int` id, :ref:`Rect3` area **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`erase_area` **(** :ref:`int` area **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -57,20 +55,16 @@ Member Functions +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_center_z` **(** **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_meshes` **(** **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_octant_size` **(** **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`MeshLibrary` | :ref:`get_theme` **(** **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_unused_area_id` **(** **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_baking_enabled` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_baked_light` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`resource_changed` **(** :ref:`Object` resource **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake` **(** :ref:`bool` enable **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_cell_item` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=0 **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_cell_size` **(** :ref:`float` size **)** | @@ -87,8 +81,6 @@ Member Functions +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_theme` **(** :ref:`MeshLibrary` theme **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_baked_light` **(** :ref:`bool` use **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -100,7 +92,7 @@ Member Function Description .. _class_GridMap_area_get_bounds: -- :ref:`AABB` **area_get_bounds** **(** :ref:`int` area **)** const +- :ref:`Rect3` **area_get_bounds** **(** :ref:`int` area **)** const .. _class_GridMap_area_get_name: @@ -134,17 +126,13 @@ Member Function Description - void **area_set_portal_disable_distance** **(** :ref:`int` area, :ref:`float` distance **)** -.. _class_GridMap_bake_geometry: - -- void **bake_geometry** **(** **)** - .. _class_GridMap_clear: - void **clear** **(** **)** .. _class_GridMap_create_area: -- :ref:`int` **create_area** **(** :ref:`int` id, :ref:`AABB` area **)** +- :ref:`int` **create_area** **(** :ref:`int` id, :ref:`Rect3` area **)** .. _class_GridMap_erase_area: @@ -174,6 +162,10 @@ Member Function Description - :ref:`bool` **get_center_z** **(** **)** const +.. _class_GridMap_get_meshes: + +- :ref:`Array` **get_meshes** **(** **)** + .. _class_GridMap_get_octant_size: - :ref:`int` **get_octant_size** **(** **)** const @@ -186,22 +178,10 @@ Member Function Description - :ref:`int` **get_unused_area_id** **(** **)** const -.. _class_GridMap_is_baking_enabled: - -- :ref:`bool` **is_baking_enabled** **(** **)** const - -.. _class_GridMap_is_using_baked_light: - -- :ref:`bool` **is_using_baked_light** **(** **)** const - .. _class_GridMap_resource_changed: - void **resource_changed** **(** :ref:`Object` resource **)** -.. _class_GridMap_set_bake: - -- void **set_bake** **(** :ref:`bool` enable **)** - .. _class_GridMap_set_cell_item: - void **set_cell_item** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=0 **)** @@ -234,8 +214,4 @@ Member Function Description - void **set_theme** **(** :ref:`MeshLibrary` theme **)** -.. _class_GridMap_set_use_baked_light: - -- void **set_use_baked_light** **(** :ref:`bool` use **)** - diff --git a/classes/class_groovejoint2d.rst b/classes/class_groovejoint2d.rst index ced1eb005..043ef8b89 100644 --- a/classes/class_groovejoint2d.rst +++ b/classes/class_groovejoint2d.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_length` **(** :ref:`float` length **)** | +----------------------------+------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **initial_offset** +- :ref:`float` **length** + Description ----------- diff --git a/classes/class_hingejoint.rst b/classes/class_hingejoint.rst index 018b7dcdd..7ca29f478 100644 --- a/classes/class_hingejoint.rst +++ b/classes/class_hingejoint.rst @@ -28,6 +28,20 @@ Member Functions | void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **angular_limit/bias** +- :ref:`bool` **angular_limit/enable** +- :ref:`float` **angular_limit/lower** +- :ref:`float` **angular_limit/relaxation** +- :ref:`float` **angular_limit/softness** +- :ref:`float` **angular_limit/upper** +- :ref:`bool` **motor/enable** +- :ref:`float` **motor/max_impulse** +- :ref:`float` **motor/target_velocity** +- :ref:`float` **params/bias** + Numeric Constants ----------------- diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index 7b970b613..a6e55819f 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -18,49 +18,49 @@ Hyper-text transfer protocol client. Member Functions ---------------- -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`connect` **(** :ref:`String` host, :ref:`int` port, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StreamPeer` | :ref:`get_connection` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_response_body_length` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_response_code` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_response_headers` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_response_headers_as_dictionary` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_status` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_response` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_blocking_mode_enabled` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_response_chunked` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`poll` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`query_string_from_dict` **(** :ref:`Dictionary` fields **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`read_response_body_chunk` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`request` **(** :ref:`int` method, :ref:`String` url, :ref:`StringArray` headers, :ref:`String` body="" **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`request_raw` **(** :ref:`int` method, :ref:`String` url, :ref:`StringArray` headers, :ref:`RawArray` body **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`send_body_data` **(** :ref:`RawArray` body **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`send_body_text` **(** :ref:`String` body **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blocking_mode` **(** :ref:`bool` enabled **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_connection` **(** :ref:`StreamPeer` connection **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_read_chunk_size` **(** :ref:`int` bytes **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StreamPeer` | :ref:`get_connection` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_response_body_length` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_response_code` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_response_headers` **(** **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_response_headers_as_dictionary` **(** **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_status` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_response` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_blocking_mode_enabled` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_response_chunked` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`poll` **(** **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`query_string_from_dict` **(** :ref:`Dictionary` fields **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`read_response_body_chunk` **(** **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`request` **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`request_raw` **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`send_body_data` **(** :ref:`PoolByteArray` body **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`send_body_text` **(** :ref:`String` body **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blocking_mode` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_connection` **(** :ref:`StreamPeer` connection **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_read_chunk_size` **(** :ref:`int` bytes **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -150,9 +150,9 @@ Member Function Description Cloces the current connection, allows for reusal of :ref:`HTTPClient`. -.. _class_HTTPClient_connect: +.. _class_HTTPClient_connect_to_host: -- Error **connect** **(** :ref:`String` host, :ref:`int` port, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** +- Error **connect_to_host** **(** :ref:`String` host, :ref:`int` port, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** Connect to a host. This needs to be done before any requests are sent. @@ -180,7 +180,7 @@ Return the HTTP status code of the response. .. _class_HTTPClient_get_response_headers: -- :ref:`StringArray` **get_response_headers** **(** **)** +- :ref:`PoolStringArray` **get_response_headers** **(** **)** Return the response headers. @@ -238,13 +238,13 @@ Generates a GET/POST application/x-www-form-urlencoded style query string from a .. _class_HTTPClient_read_response_body_chunk: -- :ref:`RawArray` **read_response_body_chunk** **(** **)** +- :ref:`PoolByteArray` **read_response_body_chunk** **(** **)** Reads one chunk from the response. .. _class_HTTPClient_request: -- :ref:`int` **request** **(** :ref:`int` method, :ref:`String` url, :ref:`StringArray` headers, :ref:`String` body="" **)** +- :ref:`int` **request** **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** Sends a request to the connected host. The url is what is normally behind the hostname, i.e. in ``http://somehost.com/index.php``, url would be "index.php". @@ -261,7 +261,7 @@ To create a POST request with query strings to push to the server, do: .. _class_HTTPClient_request_raw: -- :ref:`int` **request_raw** **(** :ref:`int` method, :ref:`String` url, :ref:`StringArray` headers, :ref:`RawArray` body **)** +- :ref:`int` **request_raw** **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** Sends a raw request to the connected host. The url is what is normally behind the hostname, i.e. in ``http://somehost.com/index.php``, url would be "index.php". @@ -271,7 +271,7 @@ Sends body raw, as a byte array, does not encode it in any way. .. _class_HTTPClient_send_body_data: -- :ref:`int` **send_body_data** **(** :ref:`RawArray` body **)** +- :ref:`int` **send_body_data** **(** :ref:`PoolByteArray` body **)** Stub function diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index 89aae49ef..f64a0395b 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -18,38 +18,45 @@ A Node with the ability to send HTTP requests. Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cancel_request` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_body_size` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_body_size_limit` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_download_file` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_http_client_status` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_redirects` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_threads` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`request` **(** :ref:`String` url, :ref:`StringArray` custom_headers=StringArray([]), :ref:`bool` ssl_validate_domain=true, :ref:`int` method=0, :ref:`String` request_data="" **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_body_size_limit` **(** :ref:`int` bytes **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_download_file` **(** :ref:`String` path **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_redirects` **(** :ref:`int` amount **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_threads` **(** :ref:`bool` enable **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cancel_request` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_body_size` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_body_size_limit` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_download_file` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_http_client_status` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_max_redirects` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_threads` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`request` **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray([]), :ref:`bool` ssl_validate_domain=true, :ref:`int` method=0, :ref:`String` request_data="" **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_body_size_limit` **(** :ref:`int` bytes **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_download_file` **(** :ref:`String` path **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_redirects` **(** :ref:`int` amount **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_threads` **(** :ref:`bool` enable **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -- **request_completed** **(** :ref:`int` result, :ref:`int` response_code, :ref:`StringArray` headers, :ref:`RawArray` body **)** +- **request_completed** **(** :ref:`int` result, :ref:`int` response_code, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** + +Member Variables +---------------- + +- :ref:`int` **body_size_limit** +- :ref:`int` **max_redirects** +- :ref:`bool` **use_threads** Numeric Constants ----------------- @@ -127,7 +134,7 @@ Whether this request is using threads. .. _class_HTTPRequest_request: -- :ref:`int` **request** **(** :ref:`String` url, :ref:`StringArray` custom_headers=StringArray([]), :ref:`bool` ssl_validate_domain=true, :ref:`int` method=0, :ref:`String` request_data="" **)** +- :ref:`int` **request** **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray([]), :ref:`bool` ssl_validate_domain=true, :ref:`int` method=0, :ref:`String` request_data="" **)** .. _class_HTTPRequest_set_body_size_limit: diff --git a/classes/class_image.rst b/classes/class_image.rst index 7f3966455..3691df642 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -16,78 +16,87 @@ Image datatype. Member Functions ---------------- -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`Image` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` mipmaps, :ref:`int` format **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blit_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dest=0 **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`brush_transfer` **(** :ref:`Image` src, :ref:`Image` brush, :ref:`Vector2` pos=0 **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`brushed` **(** :ref:`Image` src, :ref:`Image` brush, :ref:`Vector2` pos=0 **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`compressed` **(** :ref:`int` format=0 **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`converted` **(** :ref:`int` format=0 **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`decompressed` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fix_alpha_edges` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`get_data` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_format` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_pixel` **(** :ref:`int` x, :ref:`int` y, :ref:`int` mipmap_level=0 **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_rect` **(** :ref:`Rect2` area=0 **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`load` **(** :ref:`String` path=0 **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_pixel` **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color, :ref:`int` mipmap_level=0 **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`resized` **(** :ref:`int` x, :ref:`int` y, :ref:`int` interpolation=1 **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`save_png` **(** :ref:`String` path=0 **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`Image` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` mipmaps, :ref:`int` format **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blit_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dest=0 **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`compressed` **(** :ref:`int` format=0 **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`converted` **(** :ref:`int` format=0 **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`decompressed` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fix_alpha_edges` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_format` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_height` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_rect` **(** :ref:`Rect2` area=0 **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_width` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`load` **(** :ref:`String` path=0 **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`resized` **(** :ref:`int` x, :ref:`int` y, :ref:`int` interpolation=1 **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save_png` **(** :ref:`String` path=0 **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- -- **COMPRESS_BC** = **0** -- **COMPRESS_PVRTC2** = **1** -- **COMPRESS_PVRTC4** = **2** -- **COMPRESS_ETC** = **3** +- **COMPRESS_16BIT** = **0** +- **COMPRESS_S3TC** = **1** +- **COMPRESS_PVRTC2** = **2** +- **COMPRESS_PVRTC4** = **3** +- **COMPRESS_ETC** = **4** +- **COMPRESS_ETC2** = **5** - **FORMAT_L8** = **0** -- **FORMAT_INTENSITY** = **1** -- **FORMAT_LA8** = **2** -- **FORMAT_RGB8** = **3** -- **FORMAT_RGBA8** = **4** -- **FORMAT_INDEXED** = **5** -- **FORMAT_INDEXED_ALPHA** = **6** -- **FORMAT_YUV_422** = **7** -- **FORMAT_YUV_444** = **8** -- **FORMAT_DXT1** = **9** -- **FORMAT_DXT3** = **10** -- **FORMAT_DXT5** = **11** -- **FORMAT_ATI1** = **12** -- **FORMAT_ATI2** = **13** -- **FORMAT_PVRTC2** = **14** -- **FORMAT_PVRTC2A** = **15** -- **FORMAT_PVRTC4** = **16** -- **FORMAT_PVRTC4A** = **17** -- **FORMAT_ETC** = **18** -- **FORMAT_ATC** = **19** -- **FORMAT_ATC_ALPHA_EXPLICIT** = **20** -- **FORMAT_ATC_ALPHA_INTERPOLATED** = **21** -- **FORMAT_CUSTOM** = **22** +- **FORMAT_LA8** = **1** +- **FORMAT_R8** = **2** +- **FORMAT_RG8** = **3** +- **FORMAT_RGB8** = **4** +- **FORMAT_RGBA8** = **5** +- **FORMAT_RGB565** = **6** +- **FORMAT_RGBA4444** = **7** +- **FORMAT_RGBA5551** = **17** +- **FORMAT_RF** = **9** +- **FORMAT_RGF** = **10** +- **FORMAT_RGBF** = **11** +- **FORMAT_RGBAF** = **12** +- **FORMAT_RH** = **13** +- **FORMAT_RGH** = **14** +- **FORMAT_RGBH** = **15** +- **FORMAT_RGBAH** = **16** +- **FORMAT_DXT1** = **17** +- **FORMAT_DXT3** = **18** +- **FORMAT_DXT5** = **19** +- **FORMAT_ATI1** = **20** +- **FORMAT_ATI2** = **21** +- **FORMAT_BPTC_RGBA** = **22** +- **FORMAT_BPTC_RGBF** = **23** +- **FORMAT_BPTC_RGBFU** = **24** +- **FORMAT_PVRTC2** = **25** +- **FORMAT_PVRTC2A** = **26** +- **FORMAT_PVRTC4** = **27** +- **FORMAT_PVRTC4A** = **28** +- **FORMAT_ETC** = **29** +- **FORMAT_ETC2_R11** = **30** +- **FORMAT_ETC2_R11S** = **31** +- **FORMAT_ETC2_RG11** = **32** +- **FORMAT_ETC2_RG11S** = **33** +- **FORMAT_ETC2_RGB8** = **34** +- **FORMAT_ETC2_RGBA8** = **35** +- **FORMAT_ETC2_RGB8A1** = **36** +- **FORMAT_MAX** = **37** - **INTERPOLATE_NEAREST** = **0** - **INTERPOLATE_BILINEAR** = **1** - **INTERPOLATE_CUBIC** = **2** @@ -112,18 +121,6 @@ Create an empty image of a specific size and format. Copy a "src_rect" :ref:`Rect2` from "src" :ref:`Image` to this :ref:`Image` on coordinates "dest". -.. _class_Image_brush_transfer: - -- void **brush_transfer** **(** :ref:`Image` src, :ref:`Image` brush, :ref:`Vector2` pos=0 **)** - -Transfer data from "src" to this :ref:`Image` using a "brush" as a mask/brush on coordinates "pos". - -.. _class_Image_brushed: - -- :ref:`Image` **brushed** **(** :ref:`Image` src, :ref:`Image` brush, :ref:`Vector2` pos=0 **)** - -Return a new :ref:`Image` from this :ref:`Image` that is created by brushhing see :ref:`brush_transfer`. - .. _class_Image_compressed: - :ref:`Image` **compressed** **(** :ref:`int` format=0 **)** @@ -154,7 +151,7 @@ Return whether this :ref:`Image` is empty(no data). .. _class_Image_get_data: -- :ref:`RawArray` **get_data** **(** **)** +- :ref:`PoolByteArray` **get_data** **(** **)** Return the raw data of the :ref:`Image`. @@ -170,12 +167,6 @@ Return the format of the :ref:`Image`, one of :ref:`Image`. -.. _class_Image_get_pixel: - -- :ref:`Color` **get_pixel** **(** :ref:`int` x, :ref:`int` y, :ref:`int` mipmap_level=0 **)** - -Return the color of the pixel in the :ref:`Image` on coordinates "x,y" on mipmap level "mipmap_level". - .. _class_Image_get_rect: - :ref:`Image` **get_rect** **(** :ref:`Rect2` area=0 **)** @@ -200,12 +191,6 @@ Return the width of the :ref:`Image`. Load an :ref:`Image`. -.. _class_Image_put_pixel: - -- void **put_pixel** **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color, :ref:`int` mipmap_level=0 **)** - -Put a pixel of "color" on coordinates "x,y" on mipmap level "mipmap_level". - .. _class_Image_resized: - :ref:`Image` **resized** **(** :ref:`int` x, :ref:`int` y, :ref:`int` interpolation=1 **)** diff --git a/classes/class_imageskybox.rst b/classes/class_imageskybox.rst new file mode 100644 index 000000000..1fd25ca5f --- /dev/null +++ b/classes/class_imageskybox.rst @@ -0,0 +1,59 @@ +.. 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_ImageSkyBox: + +ImageSkyBox +=========== + +**Inherits:** :ref:`SkyBox` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_image_path` **(** :ref:`int` image **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_image_path` **(** :ref:`int` image, :ref:`String` path **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`String` **image_path_negative_x** +- :ref:`String` **image_path_negative_y** +- :ref:`String` **image_path_negative_z** +- :ref:`String` **image_path_positive_x** +- :ref:`String` **image_path_positive_y** +- :ref:`String` **image_path_positive_z** + +Numeric Constants +----------------- + +- **IMAGE_PATH_NEGATIVE_X** = **0** +- **IMAGE_PATH_POSITIVE_X** = **1** +- **IMAGE_PATH_NEGATIVE_Y** = **2** +- **IMAGE_PATH_POSITIVE_Y** = **3** +- **IMAGE_PATH_NEGATIVE_Z** = **4** +- **IMAGE_PATH_POSITIVE_Z** = **5** +- **IMAGE_PATH_MAX** = **6** + +Member Function Description +--------------------------- + +.. _class_ImageSkyBox_get_image_path: + +- :ref:`String` **get_image_path** **(** :ref:`int` image **)** const + +.. _class_ImageSkyBox_set_image_path: + +- void **set_image_path** **(** :ref:`int` image, :ref:`String` path **)** + + diff --git a/classes/class_input.rst b/classes/class_input.rst index e6f33e345..d70360414 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -29,7 +29,9 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_accelerometer` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_connected_joysticks` **(** **)** | +| :ref:`Array` | :ref:`get_connected_joypads` **(** **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -51,14 +53,14 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_joy_vibration_strength` **(** :ref:`int` device **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_last_mouse_speed` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_mouse_button_mask` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_mouse_mode` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_mouse_speed` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_action_just_pressed` **(** :ref:`String` action **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_action_just_released` **(** :ref:`String` action **)** const | @@ -73,6 +75,8 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`int` button **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`parse_input_event` **(** :ref:`InputEvent` event **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_joy_mapping` **(** :ref:`String` guid **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_custom_mouse_cursor` **(** :ref:`Texture` image, :ref:`Vector2` hotspot=Vector2(0, 0) **)** | @@ -97,11 +101,12 @@ Numeric Constants - **MOUSE_MODE_VISIBLE** = **0** --- Makes the mouse cursor visible if it is hidden. - **MOUSE_MODE_HIDDEN** = **1** --- Makes the mouse cursor hidden if it is visible. - **MOUSE_MODE_CAPTURED** = **2** --- Captures the mouse. The mouse will be hidden and unable to leave the game window. But it will still register movement and mouse button presses. +- **MOUSE_MODE_CONFINED** = **3** Description ----------- -A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joysticks, and input actions. +A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joypads, and input actions. Member Function Description --------------------------- @@ -130,11 +135,15 @@ Add a new mapping entry (in SDL2 format) to the mapping database. Optionally upd If the device has an accelerometer, this will return the movement. -.. _class_Input_get_connected_joysticks: +.. _class_Input_get_connected_joypads: -- :ref:`Array` **get_connected_joysticks** **(** **)** +- :ref:`Array` **get_connected_joypads** **(** **)** -Returns an :ref:`Array` containing the device IDs of all currently connected joysticks. +Returns an :ref:`Array` containing the device IDs of all currently connected joypads. + +.. _class_Input_get_gravity: + +- :ref:`Vector3` **get_gravity** **(** **)** const .. _class_Input_get_gyroscope: @@ -146,7 +155,7 @@ If the device has a gyroscope, this will return the rate of rotation in rad/s ar - :ref:`float` **get_joy_axis** **(** :ref:`int` device, :ref:`int` axis **)** const -Returns the current value of the joystick axis at given index (see JOY\_\* constants in :ref:`@Global Scope`) +Returns the current value of the joypad axis at given index (see JOY\_\* constants in :ref:`@Global Scope`) .. _class_Input_get_joy_axis_index_from_string: @@ -174,7 +183,7 @@ Returns a SDL2 compatible device guid on platforms that use gamepad remapping. R - :ref:`String` **get_joy_name** **(** :ref:`int` device **)** -Returns the name of the joystick at the specified device index +Returns the name of the joypad at the specified device index .. _class_Input_get_joy_vibration_duration: @@ -186,7 +195,13 @@ Returns the duration of the current vibration effect in seconds. - :ref:`Vector2` **get_joy_vibration_strength** **(** :ref:`int` device **)** -Returns the strength of the joystick vibration: x is the strength of the weak motor, and y is the strength of the strong motor. +Returns the strength of the joypad vibration: x is the strength of the weak motor, and y is the strength of the strong motor. + +.. _class_Input_get_last_mouse_speed: + +- :ref:`Vector2` **get_last_mouse_speed** **(** **)** const + +Returns the mouse speed for the last time the cursor was moved, and this until the next frame where the mouse moves. This means that even if the mouse is not moving, this function will still return the value of the last motion. .. _class_Input_get_magnetometer: @@ -206,12 +221,6 @@ Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the Return the mouse mode. See the constants for more information. -.. _class_Input_get_mouse_speed: - -- :ref:`Vector2` **get_mouse_speed** **(** **)** const - -Returns the mouse speed for the last time the cursor was moved, and this until the next frame where the mouse moves. This means that even if the mouse is not moving, this function will still return the value of the last motion. - .. _class_Input_is_action_just_pressed: - :ref:`bool` **is_action_just_pressed** **(** :ref:`String` action **)** const @@ -230,13 +239,13 @@ Returns true or false depending on whether the action event is pressed. Actions - :ref:`bool` **is_joy_button_pressed** **(** :ref:`int` device, :ref:`int` button **)** const -Returns if the joystick button at the given index is currently pressed. (see JOY\_\* constants in :ref:`@Global Scope`) +Returns if the joypad button at the given index is currently pressed. (see JOY\_\* constants in :ref:`@Global Scope`) .. _class_Input_is_joy_known: - :ref:`bool` **is_joy_known** **(** :ref:`int` device **)** -Returns if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in the JOY\_\* constants (see :ref:`@Global Scope`). Unknown joysticks are not expected to match these constants, but you can still retrieve events from them. +Returns if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in the JOY\_\* constants (see :ref:`@Global Scope`). Unknown joypads are not expected to match these constants, but you can still retrieve events from them. .. _class_Input_is_key_pressed: @@ -250,6 +259,10 @@ Returns true or false depending on whether the key is pressed or not. You can pa Returns true or false depending on whether mouse button is pressed or not. You can pass BUTTON\_\*, which are pre-defined constants listed in :ref:`@Global Scope`. +.. _class_Input_parse_input_event: + +- void **parse_input_event** **(** :ref:`InputEvent` event **)** + .. _class_Input_remove_joy_mapping: - void **remove_joy_mapping** **(** :ref:`String` guid **)** @@ -272,7 +285,7 @@ Set the mouse mode. See the constants for more information. - void **start_joy_vibration** **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** -Starts to vibrate the joystick. Joysticks usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely). +Starts to vibrate the joypad. Joypads usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely). Note that not every hardware is compatible with long effect durations, it is recommended to restart an effect if in need to play it for more than a few seconds. @@ -280,7 +293,7 @@ Note that not every hardware is compatible with long effect durations, it is rec - void **stop_joy_vibration** **(** :ref:`int` device **)** -Stops the vibration of the joystick. +Stops the vibration of the joypad. .. _class_Input_warp_mouse_pos: diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index e1057e772..9901beba6 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -44,8 +44,8 @@ Numeric Constants - **KEY** = **1** --- Key event. - **MOUSE_MOTION** = **2** --- Mouse motion event. - **MOUSE_BUTTON** = **3** --- Mouse button event. -- **JOYSTICK_MOTION** = **4** --- Joystick motion event. -- **JOYSTICK_BUTTON** = **5** --- Joystick button event. +- **JOYPAD_MOTION** = **4** --- Joypad motion event. +- **JOYPAD_BUTTON** = **5** --- Joypad button event. - **SCREEN_TOUCH** = **6** --- Screen touch event. - **SCREEN_DRAG** = **7** --- Screen drag event. - **ACTION** = **8** --- Pre-defined action event (see :ref:`InputMap`). diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index adc453fae..2c1881b84 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -44,8 +44,8 @@ Numeric Constants - **KEY** = **1** --- Key event. - **MOUSE_MOTION** = **2** --- Mouse motion event. - **MOUSE_BUTTON** = **3** --- Mouse button event. -- **JOYSTICK_MOTION** = **4** --- Joystick motion event. -- **JOYSTICK_BUTTON** = **5** --- Joystick button event. +- **JOYPAD_MOTION** = **4** --- Joypad motion event. +- **JOYPAD_BUTTON** = **5** --- Joypad button event. - **SCREEN_TOUCH** = **6** --- Screen touch event. - **SCREEN_DRAG** = **7** --- Screen drag event. - **ACTION** = **8** --- Pre-defined action event (see :ref:`InputMap`). diff --git a/classes/class_inputeventjoystickbutton.rst b/classes/class_inputeventjoypadbutton.rst similarity index 63% rename from classes/class_inputeventjoystickbutton.rst rename to classes/class_inputeventjoypadbutton.rst index 25c4d478d..111eddf1e 100644 --- a/classes/class_inputeventjoystickbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -1,42 +1,42 @@ .. 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_InputEventJoystickButton: +.. _class_InputEventJoypadButton: -InputEventJoystickButton -======================== +InputEventJoypadButton +====================== **Category:** Built-In Types Brief Description ----------------- -Built-in input event type for joystick button events. +Built-in input event type for joypad button events. Member Functions ---------------- -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_echo` **(** **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_action` **(** :ref:`String` action, :ref:`bool` pressed **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_echo` **(** **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pressed` **(** **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_action` **(** :ref:`String` action, :ref:`bool` pressed **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- - :ref:`int` **ID** - Event identifier, positive integer increased at each new event. -- :ref:`int` **button_index** - Joystick button identifier, one of the JOY_BUTTON_* constants in [@Global Scope]. +- :ref:`int` **button_index** - Joypad button identifier, one of the JOY_BUTTON_* constants in [@Global Scope]. - :ref:`int` **device** - Device identifier. -- :ref:`bool` **pressed** - Pressed state of the joystick button. +- :ref:`bool` **pressed** - Pressed state of the joypad button. - :ref:`float` **pressure** - Intensity of the button pressure, ranges from 0 to 1.0. - :ref:`int` **type** - Type of event (one of the [InputEvent] constants). @@ -47,8 +47,8 @@ Numeric Constants - **KEY** = **1** --- Key event. - **MOUSE_MOTION** = **2** --- Mouse motion event. - **MOUSE_BUTTON** = **3** --- Mouse button event. -- **JOYSTICK_MOTION** = **4** --- Joystick motion event. -- **JOYSTICK_BUTTON** = **5** --- Joystick button event. +- **JOYPAD_MOTION** = **4** --- Joypad motion event. +- **JOYPAD_BUTTON** = **5** --- Joypad button event. - **SCREEN_TOUCH** = **6** --- Screen touch event. - **SCREEN_DRAG** = **7** --- Screen drag event. - **ACTION** = **8** --- Pre-defined action event (see :ref:`InputMap`). @@ -56,42 +56,42 @@ Numeric Constants Description ----------- -Input event type for joystick button events that extends the global :ref:`InputEvent` type. +Input event type for joypad button events that extends the global :ref:`InputEvent` type. Member Function Description --------------------------- -.. _class_InputEventJoystickButton_is_action: +.. _class_InputEventJoypadButton_is_action: - :ref:`bool` **is_action** **(** :ref:`String` action **)** Return if this input event matches a pre-defined action. -.. _class_InputEventJoystickButton_is_action_pressed: +.. _class_InputEventJoypadButton_is_action_pressed: - :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** Return whether the given action is being pressed. -.. _class_InputEventJoystickButton_is_action_released: +.. _class_InputEventJoypadButton_is_action_released: - :ref:`bool` **is_action_released** **(** :ref:`String` action **)** Return whether the given action is released (i.e. not pressed). -.. _class_InputEventJoystickButton_is_echo: +.. _class_InputEventJoypadButton_is_echo: - :ref:`bool` **is_echo** **(** **)** Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type). -.. _class_InputEventJoystickButton_is_pressed: +.. _class_InputEventJoypadButton_is_pressed: - :ref:`bool` **is_pressed** **(** **)** Return if this input event is pressed. -.. _class_InputEventJoystickButton_set_as_action: +.. _class_InputEventJoypadButton_set_as_action: - void **set_as_action** **(** :ref:`String` action, :ref:`bool` pressed **)** diff --git a/classes/class_inputeventjoystickmotion.rst b/classes/class_inputeventjoypadmotion.rst similarity index 63% rename from classes/class_inputeventjoystickmotion.rst rename to classes/class_inputeventjoypadmotion.rst index d140c7c1b..f2e9e73b3 100644 --- a/classes/class_inputeventjoystickmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -1,40 +1,40 @@ .. 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_InputEventJoystickMotion: +.. _class_InputEventJoypadMotion: -InputEventJoystickMotion -======================== +InputEventJoypadMotion +====================== **Category:** Built-In Types Brief Description ----------------- -Built-in input event type for joystick motion/axis events. +Built-in input event type for joypad motion/axis events. Member Functions ---------------- -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_echo` **(** **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_action` **(** :ref:`String` action, :ref:`bool` pressed **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_echo` **(** **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pressed` **(** **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_action` **(** :ref:`String` action, :ref:`bool` pressed **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- - :ref:`int` **ID** - Event identifier, positive integer increased at each new event. -- :ref:`int` **axis** - Joystick axis identifier, one of the JOY_AXIS_* constants in [@Global Scope]. +- :ref:`int` **axis** - Joypad axis identifier, one of the JOY_AXIS_* constants in [@Global Scope]. - :ref:`int` **device** - Device identifier. - :ref:`int` **type** - Type of event (one of the [InputEvent] constants). - :ref:`float` **value** - Position of the axis, ranging from -1.0 to 1.0. A value of 0 means that the axis is in its neutral position. @@ -46,8 +46,8 @@ Numeric Constants - **KEY** = **1** --- Key event. - **MOUSE_MOTION** = **2** --- Mouse motion event. - **MOUSE_BUTTON** = **3** --- Mouse button event. -- **JOYSTICK_MOTION** = **4** --- Joystick motion event. -- **JOYSTICK_BUTTON** = **5** --- Joystick button event. +- **JOYPAD_MOTION** = **4** --- Joypad motion event. +- **JOYPAD_BUTTON** = **5** --- Joypad button event. - **SCREEN_TOUCH** = **6** --- Screen touch event. - **SCREEN_DRAG** = **7** --- Screen drag event. - **ACTION** = **8** --- Pre-defined action event (see :ref:`InputMap`). @@ -55,40 +55,40 @@ Numeric Constants Description ----------- -Input event type for joystick motion/axis events that extends the global :ref:`InputEvent` type. +Input event type for joypad motion/axis events that extends the global :ref:`InputEvent` type. Member Function Description --------------------------- -.. _class_InputEventJoystickMotion_is_action: +.. _class_InputEventJoypadMotion_is_action: - :ref:`bool` **is_action** **(** :ref:`String` action **)** -.. _class_InputEventJoystickMotion_is_action_pressed: +.. _class_InputEventJoypadMotion_is_action_pressed: - :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** Return whether the given action is being pressed. -.. _class_InputEventJoystickMotion_is_action_released: +.. _class_InputEventJoypadMotion_is_action_released: - :ref:`bool` **is_action_released** **(** :ref:`String` action **)** Return whether the given action is released (i.e. not pressed). -.. _class_InputEventJoystickMotion_is_echo: +.. _class_InputEventJoypadMotion_is_echo: - :ref:`bool` **is_echo** **(** **)** Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type). -.. _class_InputEventJoystickMotion_is_pressed: +.. _class_InputEventJoypadMotion_is_pressed: - :ref:`bool` **is_pressed** **(** **)** Return if this input event is pressed. -.. _class_InputEventJoystickMotion_set_as_action: +.. _class_InputEventJoypadMotion_set_as_action: - void **set_as_action** **(** :ref:`String` action, :ref:`bool` pressed **)** diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index dd8c222d5..db3676b33 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -52,8 +52,8 @@ Numeric Constants - **KEY** = **1** --- Key event. - **MOUSE_MOTION** = **2** --- Mouse motion event. - **MOUSE_BUTTON** = **3** --- Mouse button event. -- **JOYSTICK_MOTION** = **4** --- Joystick motion event. -- **JOYSTICK_BUTTON** = **5** --- Joystick button event. +- **JOYPAD_MOTION** = **4** --- Joypad motion event. +- **JOYPAD_BUTTON** = **5** --- Joypad button event. - **SCREEN_TOUCH** = **6** --- Screen touch event. - **SCREEN_DRAG** = **7** --- Screen drag event. - **ACTION** = **8** --- Pre-defined action event (see :ref:`InputMap`). diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index a76282001..5a8e4b80f 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -41,15 +41,15 @@ Member Variables - :ref:`int` **device** - Device identifier. - :ref:`bool` **doubleclick** - Whether the event is a double-click. - :ref:`Vector2` **global_pos** - Global position of the mouse click. -- :ref:`int` **global_x** - Global X coordinate of the mouse click. -- :ref:`int` **global_y** - Global Y coordinate of the mouse click. +- :ref:`float` **global_x** - Global X coordinate of the mouse click. +- :ref:`float` **global_y** - Global Y coordinate of the mouse click. - :ref:`bool` **meta** - State of the Meta modifier. - :ref:`Vector2` **pos** - Local position of the mouse click. - :ref:`bool` **pressed** - Pressed state of the mouse button. - :ref:`bool` **shift** - State of the Shift modifier. - :ref:`int` **type** - Type of event (one of the [InputEvent] constants). -- :ref:`int` **x** - Local X coordinate of the mouse click. -- :ref:`int` **y** - Local Y coordinate of the mouse click. +- :ref:`float` **x** - Local X coordinate of the mouse click. +- :ref:`float` **y** - Local Y coordinate of the mouse click. Numeric Constants ----------------- @@ -58,8 +58,8 @@ Numeric Constants - **KEY** = **1** --- Key event. - **MOUSE_MOTION** = **2** --- Mouse motion event. - **MOUSE_BUTTON** = **3** --- Mouse button event. -- **JOYSTICK_MOTION** = **4** --- Joystick motion event. -- **JOYSTICK_BUTTON** = **5** --- Joystick button event. +- **JOYPAD_MOTION** = **4** --- Joypad motion event. +- **JOYPAD_BUTTON** = **5** --- Joypad button event. - **SCREEN_TOUCH** = **6** --- Screen touch event. - **SCREEN_DRAG** = **7** --- Screen drag event. - **ACTION** = **8** --- Pre-defined action event (see :ref:`InputMap`). diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index 8f60683f5..68952ca88 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -39,20 +39,20 @@ Member Variables - :ref:`bool` **control** - State of the Ctrl modifier. - :ref:`int` **device** - Device identifier. - :ref:`Vector2` **global_pos** - Global position of the mouse pointer. -- :ref:`int` **global_x** - Global X coordinate of the mouse pointer. -- :ref:`int` **global_y** - Global Y coordinate of the mouse pointer. +- :ref:`float` **global_x** - Global X coordinate of the mouse pointer. +- :ref:`float` **global_y** - Global Y coordinate of the mouse pointer. - :ref:`bool` **meta** - State of the Meta modifier. - :ref:`Vector2` **pos** - Local position of the mouse pointer. - :ref:`Vector2` **relative_pos** - Position of the mouse pointer relative to the previous mouse position. -- :ref:`int` **relative_x** - X coordinate of the mouse pointer relative to the previous mouse position. -- :ref:`int` **relative_y** - Y coordinate of the mouse pointer relative to the previous mouse position. +- :ref:`float` **relative_x** - X coordinate of the mouse pointer relative to the previous mouse position. +- :ref:`float` **relative_y** - Y coordinate of the mouse pointer relative to the previous mouse position. - :ref:`bool` **shift** - State of the Shift modifier. - :ref:`Vector2` **speed** - Speed of the mouse pointer. - :ref:`float` **speed_x** - Speed of the mouse pointer on the X axis. - :ref:`float` **speed_y** - Speed of the mouse pointer on the Y axis. - :ref:`int` **type** - Type of event (one of the [InputEvent] constants). -- :ref:`int` **x** - Local X coordinate of the mouse pointer. -- :ref:`int` **y** - Local Y coordinate of the mouse pointer. +- :ref:`float` **x** - Local X coordinate of the mouse pointer. +- :ref:`float` **y** - Local Y coordinate of the mouse pointer. Numeric Constants ----------------- @@ -61,8 +61,8 @@ Numeric Constants - **KEY** = **1** --- Key event. - **MOUSE_MOTION** = **2** --- Mouse motion event. - **MOUSE_BUTTON** = **3** --- Mouse button event. -- **JOYSTICK_MOTION** = **4** --- Joystick motion event. -- **JOYSTICK_BUTTON** = **5** --- Joystick button event. +- **JOYPAD_MOTION** = **4** --- Joypad motion event. +- **JOYPAD_BUTTON** = **5** --- Joypad button event. - **SCREEN_TOUCH** = **6** --- Screen touch event. - **SCREEN_DRAG** = **7** --- Screen drag event. - **ACTION** = **8** --- Pre-defined action event (see :ref:`InputMap`). diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index 2c1380064..1b6256985 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -54,8 +54,8 @@ Numeric Constants - **KEY** = **1** --- Key event. - **MOUSE_MOTION** = **2** --- Mouse motion event. - **MOUSE_BUTTON** = **3** --- Mouse button event. -- **JOYSTICK_MOTION** = **4** --- Joystick motion event. -- **JOYSTICK_BUTTON** = **5** --- Joystick button event. +- **JOYPAD_MOTION** = **4** --- Joypad motion event. +- **JOYPAD_BUTTON** = **5** --- Joypad button event. - **SCREEN_TOUCH** = **6** --- Screen touch event. - **SCREEN_DRAG** = **7** --- Screen drag event. - **ACTION** = **8** --- Pre-defined action event (see :ref:`InputMap`). diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index ada1d227d..f77619400 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -49,8 +49,8 @@ Numeric Constants - **KEY** = **1** --- Key event. - **MOUSE_MOTION** = **2** --- Mouse motion event. - **MOUSE_BUTTON** = **3** --- Mouse button event. -- **JOYSTICK_MOTION** = **4** --- Joystick motion event. -- **JOYSTICK_BUTTON** = **5** --- Joystick button event. +- **JOYPAD_MOTION** = **4** --- Joypad motion event. +- **JOYPAD_BUTTON** = **5** --- Joypad button event. - **SCREEN_TOUCH** = **6** --- Screen touch event. - **SCREEN_DRAG** = **7** --- Screen drag event. - **ACTION** = **8** --- Pre-defined action event (see :ref:`InputMap`). diff --git a/classes/class_instanceplaceholder.rst b/classes/class_instanceplaceholder.rst index a9c8be230..035ebed46 100644 --- a/classes/class_instanceplaceholder.rst +++ b/classes/class_instanceplaceholder.rst @@ -18,11 +18,13 @@ Placeholder for the root :ref:`Node` of a :ref:`PackedScene` | :ref:`get_instance_path` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`replace_by_instance` **(** :ref:`PackedScene` custom_scene=NULL **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_instance_path` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_stored_values` **(** :ref:`bool` with_order=false **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`replace_by_instance` **(** :ref:`PackedScene` custom_scene=NULL **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -40,6 +42,10 @@ Member Function Description Retrieve the path to the :ref:`PackedScene` resource file that is loaded by default when calling :ref:`replace_by_instance`. +.. _class_InstancePlaceholder_get_stored_values: + +- :ref:`Dictionary` **get_stored_values** **(** :ref:`bool` with_order=false **)** + .. _class_InstancePlaceholder_replace_by_instance: - void **replace_by_instance** **(** :ref:`PackedScene` custom_scene=NULL **)** diff --git a/classes/class_intarray.rst b/classes/class_intarray.rst deleted file mode 100644 index 79041598d..000000000 --- a/classes/class_intarray.rst +++ /dev/null @@ -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_IntArray: - -IntArray -======== - -**Category:** Built-In Types - -Brief Description ------------------ - -Integer Array. - -Member Functions ----------------- - -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`IntArray` | :ref:`IntArray` **(** :ref:`Array` from **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`int` integer **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`IntArray` array **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` integer **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`int` integer **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` integer **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ - -Description ------------ - -Integer Array. Array of integers. Can only contain integers. Optimized for memory usage, can't fragment the memory. - -Member Function Description ---------------------------- - -.. _class_IntArray_IntArray: - -- :ref:`IntArray` **IntArray** **(** :ref:`Array` from **)** - -Create from a generic array. - -.. _class_IntArray_append: - -- void **append** **(** :ref:`int` integer **)** - -Append an element at the end of the array (alias of :ref:`push_back`). - -.. _class_IntArray_append_array: - -- void **append_array** **(** :ref:`IntArray` array **)** - -Append an :ref:`IntArray` at the end of this array. - -.. _class_IntArray_insert: - -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`int` integer **)** - -Insert a new int at a given position in the array. The position must be valid, or at the end of the array (pos==size()). - -.. _class_IntArray_invert: - -- void **invert** **(** **)** - -Reverse the order of the elements in the array (so first element will now be the last). - -.. _class_IntArray_push_back: - -- void **push_back** **(** :ref:`int` integer **)** - -Append a value to the array. - -.. _class_IntArray_remove: - -- void **remove** **(** :ref:`int` idx **)** - -Remove an element from the array by index. - -.. _class_IntArray_resize: - -- void **resize** **(** :ref:`int` idx **)** - -Set the size of the :ref:`IntArray`. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. - -.. _class_IntArray_set: - -- void **set** **(** :ref:`int` idx, :ref:`int` integer **)** - -Change the int at the given index. - -.. _class_IntArray_size: - -- :ref:`int` **size** **(** **)** - -Return the array size. - - diff --git a/classes/class_interpolatedcamera.rst b/classes/class_interpolatedcamera.rst index b94fc7b41..908477c0d 100644 --- a/classes/class_interpolatedcamera.rst +++ b/classes/class_interpolatedcamera.rst @@ -34,6 +34,13 @@ Member Functions | void | :ref:`set_target_path` **(** :ref:`NodePath` target_path **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`bool` **enabled** +- :ref:`float` **speed** +- :ref:`NodePath` **target** + Member Function Description --------------------------- diff --git a/classes/class_inversekinematics.rst b/classes/class_inversekinematics.rst deleted file mode 100644 index 20e461b06..000000000 --- a/classes/class_inversekinematics.rst +++ /dev/null @@ -1,86 +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_InverseKinematics: - -InverseKinematics -================= - -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - -Member Functions ----------------- - -+------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bone_name` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_chain_size` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_iterations` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_precision` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_speed` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_name` **(** :ref:`String` ik_bone **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_chain_size` **(** :ref:`int` chain_size **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_iterations` **(** :ref:`int` iterations **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_precision` **(** :ref:`float` precision **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_speed` **(** :ref:`float` speed **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------+ - -Member Function Description ---------------------------- - -.. _class_InverseKinematics_get_bone_name: - -- :ref:`String` **get_bone_name** **(** **)** const - -.. _class_InverseKinematics_get_chain_size: - -- :ref:`int` **get_chain_size** **(** **)** const - -.. _class_InverseKinematics_get_iterations: - -- :ref:`int` **get_iterations** **(** **)** const - -.. _class_InverseKinematics_get_precision: - -- :ref:`float` **get_precision** **(** **)** const - -.. _class_InverseKinematics_get_speed: - -- :ref:`float` **get_speed** **(** **)** const - -.. _class_InverseKinematics_set_bone_name: - -- void **set_bone_name** **(** :ref:`String` ik_bone **)** - -.. _class_InverseKinematics_set_chain_size: - -- void **set_chain_size** **(** :ref:`int` chain_size **)** - -.. _class_InverseKinematics_set_iterations: - -- void **set_iterations** **(** :ref:`int` iterations **)** - -.. _class_InverseKinematics_set_precision: - -- void **set_precision** **(** :ref:`float` precision **)** - -.. _class_InverseKinematics_set_speed: - -- void **set_speed** **(** :ref:`float` speed **)** - - diff --git a/classes/class_ip.rst b/classes/class_ip.rst index 601f267f7..579657851 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -20,19 +20,21 @@ IP Protocol support functions. Member Functions ---------------- -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_resolve_item` **(** :ref:`int` id **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_local_addresses` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_resolve_item_address` **(** :ref:`int` id **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_resolve_item_status` **(** :ref:`int` id **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`resolve_hostname` **(** :ref:`String` host, :ref:`int` ip_type=IP.TYPE_ANY **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`resolve_hostname_queue_item` **(** :ref:`String` host, :ref:`int` ip_type=IP.TYPE_ANY **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_cache` **(** :ref:`String` arg0="" **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_resolve_item` **(** :ref:`int` id **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_local_addresses` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_resolve_item_address` **(** :ref:`int` id **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_resolve_item_status` **(** :ref:`int` id **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`resolve_hostname` **(** :ref:`String` host, :ref:`int` ip_type=3 **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`resolve_hostname_queue_item` **(** :ref:`String` host, :ref:`int` ip_type=3 **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -43,6 +45,10 @@ Numeric Constants - **RESOLVER_STATUS_ERROR** = **3** - **RESOLVER_MAX_QUERIES** = **32** - **RESOLVER_INVALID_ID** = **-1** +- **TYPE_NONE** = **0** +- **TYPE_IPV4** = **1** +- **TYPE_IPV6** = **2** +- **TYPE_ANY** = **3** Description ----------- @@ -52,6 +58,10 @@ IP contains some support functions for the IPv4 protocol. TCP/IP support is in d Member Function Description --------------------------- +.. _class_IP_clear_cache: + +- void **clear_cache** **(** :ref:`String` arg0="" **)** + .. _class_IP_erase_resolve_item: - void **erase_resolve_item** **(** :ref:`int` id **)** @@ -76,13 +86,13 @@ Return the status of hostname queued for resolving, given its queue ID. Returned .. _class_IP_resolve_hostname: -- :ref:`String` **resolve_hostname** **(** :ref:`String` host, :ref:`int` ip_type=IP.TYPE_ANY **)** +- :ref:`String` **resolve_hostname** **(** :ref:`String` host, :ref:`int` ip_type=3 **)** Resolve a given hostname, blocking. Resolved hostname is returned as an IPv4 or IPv6 depending on "ip_type". .. _class_IP_resolve_hostname_queue_item: -- :ref:`int` **resolve_hostname_queue_item** **(** :ref:`String` host, :ref:`int` ip_type=IP.TYPE_ANY **)** +- :ref:`int` **resolve_hostname_queue_item** **(** :ref:`String` host, :ref:`int` ip_type=3 **)** Create a queue item for resolving a given hostname to an IPv4 or IPv6 depending on "ip_type". The queue ID is returned, or RESOLVER_INVALID_ID on error. diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 49455aaba..b25ae0faa 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -18,105 +18,105 @@ Control that provides a list of selectable items (and/or icons) in a single colu Member Functions ---------------- -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_item` **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` text, :ref:`Texture` icon=NULL, :ref:`bool` selectable=true **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`ensure_current_is_visible` **(** **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_allow_rmb_select` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_fixed_column_width` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_fixed_icon_size` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_icon_mode` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_icon_scale` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_at_pos` **(** :ref:`Vector2` pos, :ref:`bool` exact=false **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_count` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_item_custom_bg_color` **(** :ref:`int` idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_icon_region` **(** :ref:`int` idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_columns` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_text_lines` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_select_mode` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`IntArray` | :ref:`get_selected_items` **(** **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_v_scroll` **(** **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_selectable` **(** :ref:`int` idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_tooltip_enabled` **(** :ref:`int` idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`is_same_column_width` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_item` **(** :ref:`int` idx **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` idx, :ref:`bool` single=true **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_allow_rmb_select` **(** :ref:`bool` allow **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fixed_column_width` **(** :ref:`int` width **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fixed_icon_size` **(** :ref:`Vector2` size **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_mode` **(** :ref:`int` mode **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_scale` **(** :ref:`float` scale **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_custom_bg_color` **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon_region` **(** :ref:`int` idx, :ref:`Rect2` rect **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_selectable` **(** :ref:`int` idx, :ref:`bool` selectable **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_tooltip_enabled` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_columns` **(** :ref:`int` amount **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_text_lines` **(** :ref:`int` lines **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_same_column_width` **(** :ref:`bool` enable **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_select_mode` **(** :ref:`int` mode **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort_items_by_text` **(** **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unselect` **(** :ref:`int` idx **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_item` **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_item` **(** :ref:`String` text, :ref:`Texture` icon=NULL, :ref:`bool` selectable=true **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`ensure_current_is_visible` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_allow_rmb_select` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_fixed_column_width` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_fixed_icon_size` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_icon_mode` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_icon_scale` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_at_pos` **(** :ref:`Vector2` pos, :ref:`bool` exact=false **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_count` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_item_custom_bg_color` **(** :ref:`int` idx **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_icon_region` **(** :ref:`int` idx **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_max_columns` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_max_text_lines` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_select_mode` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_selected_items` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_v_scroll` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_selectable` **(** :ref:`int` idx **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_tooltip_enabled` **(** :ref:`int` idx **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`is_same_column_width` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` idx **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_item` **(** :ref:`int` idx **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` idx, :ref:`bool` single=true **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_allow_rmb_select` **(** :ref:`bool` allow **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fixed_column_width` **(** :ref:`int` width **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fixed_icon_size` **(** :ref:`Vector2` size **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon_mode` **(** :ref:`int` mode **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon_scale` **(** :ref:`float` scale **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_custom_bg_color` **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon_region` **(** :ref:`int` idx, :ref:`Rect2` rect **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_selectable` **(** :ref:`int` idx, :ref:`bool` selectable **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_tooltip_enabled` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_columns` **(** :ref:`int` amount **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_text_lines` **(** :ref:`int` lines **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_same_column_width` **(** :ref:`bool` enable **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_select_mode` **(** :ref:`int` mode **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort_items_by_text` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unselect` **(** :ref:`int` idx **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -256,7 +256,7 @@ Return total number of lines currently in use by the list. .. _class_ItemList_get_selected_items: -- :ref:`IntArray` **get_selected_items** **(** **)** +- :ref:`PoolIntArray` **get_selected_items** **(** **)** Returns the list of selected indexes. diff --git a/classes/class_joint.rst b/classes/class_joint.rst index 3d0f96a8f..8b4181460 100644 --- a/classes/class_joint.rst +++ b/classes/class_joint.rst @@ -38,6 +38,14 @@ Member Functions | void | :ref:`set_solver_priority` **(** :ref:`int` priority **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`bool` **collision/exclude_nodes** +- :ref:`NodePath` **nodes/node_a** +- :ref:`NodePath` **nodes/node_b** +- :ref:`int` **solver/priority** + Member Function Description --------------------------- diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index 5aa13b822..bf8a86bff 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -38,6 +38,14 @@ Member Functions | void | :ref:`set_node_b` **(** :ref:`NodePath` node **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **bias** +- :ref:`bool` **disable_collision** +- :ref:`NodePath` **node_a** +- :ref:`NodePath` **node_b** + Description ----------- diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index 18481aaf8..018743aab 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -29,7 +29,7 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_teleport_to` **(** :ref:`Vector3` position **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider` **(** **)** const | +| :ref:`Variant` | :ref:`get_collider` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collider_shape` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ @@ -58,6 +58,15 @@ Member Functions | void | :ref:`set_collision_margin` **(** :ref:`float` pixels **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`bool` **collide_with/character** +- :ref:`bool` **collide_with/kinematic** +- :ref:`bool` **collide_with/rigid** +- :ref:`bool` **collide_with/static** +- :ref:`float` **collision/margin** + Description ----------- @@ -102,7 +111,7 @@ Returns whether the KinematicBody can be teleported to the destination given as .. _class_KinematicBody_get_collider: -- :ref:`Object` **get_collider** **(** **)** const +- :ref:`Variant` **get_collider** **(** **)** const Return the body that collided with this one. diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index 28bf0b06e..3af3bad87 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -18,45 +18,50 @@ Kinematic body 2D node. Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_collider_metadata` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collider_velocity` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_collision_margin` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_pos` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_move_and_slide_colliders` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_travel` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_colliding` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_move_and_slide_on_ceiling` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_move_and_slide_on_floor` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_move_and_slide_on_wall` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`move` **(** :ref:`Vector2` rel_vec **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2(0, 0), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4 **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`move_to` **(** :ref:`Vector2` position **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`revert_motion` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_margin` **(** :ref:`float` pixels **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_move` **(** :ref:`Matrix32` from, :ref:`Vector2` rel_vec **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_collider` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_collider_metadata` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collider_velocity` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_collision_margin` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_pos` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_move_and_slide_colliders` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_travel` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_colliding` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_move_and_slide_on_ceiling` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_move_and_slide_on_floor` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_move_and_slide_on_wall` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`move` **(** :ref:`Vector2` rel_vec **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2(0, 0), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`move_to` **(** :ref:`Vector2` position **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`revert_motion` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_margin` **(** :ref:`float` pixels **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **collision/margin** Description ----------- @@ -72,7 +77,7 @@ Member Function Description .. _class_KinematicBody2D_get_collider: -- :ref:`Object` **get_collider** **(** **)** const +- :ref:`Variant` **get_collider** **(** **)** const Return the body that collided with this one. @@ -148,7 +153,7 @@ Move the body in the given direction, stopping if there is an obstacle. The retu .. _class_KinematicBody2D_move_and_slide: -- :ref:`Vector2` **move_and_slide** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2(0, 0), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4 **)** +- :ref:`Vector2` **move_and_slide** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2(0, 0), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** .. _class_KinematicBody2D_move_to: @@ -156,6 +161,8 @@ Move the body in the given direction, stopping if there is an obstacle. The retu Move the body to the given position. This is not a teleport, and the body will stop if there is an obstacle. The returned vector is how much movement was remaining before being stopped. +``floor_max_angle`` is in radians (default is pi/4), and filters which obstacles should be considered as floors/cellings instead of walls. + .. _class_KinematicBody2D_revert_motion: - void **revert_motion** **(** **)** @@ -170,7 +177,7 @@ Set the collision margin for this object. A collision margin is an amount (in pi .. _class_KinematicBody2D_test_move: -- :ref:`bool` **test_move** **(** :ref:`Matrix32` from, :ref:`Vector2` rel_vec **)** +- :ref:`bool` **test_move** **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec **)** Return true if there would be a collision if the body moved from the given point in the given direction. diff --git a/classes/class_label.rst b/classes/class_label.rst index 441054e37..3461e4c9f 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -68,6 +68,19 @@ Member Functions | void | :ref:`set_visible_characters` **(** :ref:`int` amount **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **align** +- :ref:`bool` **autowrap** +- :ref:`bool` **clip_text** +- :ref:`int` **lines_skipped** +- :ref:`int` **max_lines_visible** +- :ref:`float` **percent_visible** +- :ref:`String` **text** +- :ref:`bool` **uppercase** +- :ref:`int` **valign** + Numeric Constants ----------------- diff --git a/classes/class_largetexture.rst b/classes/class_largetexture.rst index b8724ad2a..a1498afbd 100644 --- a/classes/class_largetexture.rst +++ b/classes/class_largetexture.rst @@ -36,6 +36,11 @@ Member Functions | void | :ref:`set_size` **(** :ref:`Vector2` size **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Array` **_data** + Description ----------- diff --git a/classes/class_light.rst b/classes/class_light.rst index 8de9896b4..fc45449f4 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -20,56 +20,69 @@ Provides a base class for different kinds of light nodes. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bake_mode` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`int` color **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_operator` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_parameter` **(** :ref:`int` variable **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_projector` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_project_shadows` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editor_only` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabled` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_mode` **(** :ref:`int` bake_mode **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`int` color, :ref:`Color` value **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editor_only` **(** :ref:`bool` editor_only **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_operator` **(** :ref:`int` operator **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_parameter` **(** :ref:`int` variable, :ref:`float` value **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_project_shadows` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_projector` **(** :ref:`Texture` projector **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cull_mask` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_shadow_color` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_shadow` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editor_only` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_negative` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`Color` color **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cull_mask` **(** :ref:`int` cull_mask **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editor_only` **(** :ref:`bool` editor_only **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_negative` **(** :ref:`bool` enabled **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow` **(** :ref:`bool` enabled **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_color` **(** :ref:`Color` shadow_color **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`bool` **editor_only** +- :ref:`Color` **light_color** +- :ref:`int` **light_cull_mask** +- :ref:`float` **light_energy** +- :ref:`bool` **light_negative** +- :ref:`float` **light_specular** +- :ref:`float` **shadow_bias** +- :ref:`Color` **shadow_color** +- :ref:`float` **shadow_contact** +- :ref:`bool` **shadow_enabled** +- :ref:`float` **shadow_max_distance** Numeric Constants ----------------- -- **PARAM_RADIUS** = **2** -- **PARAM_ENERGY** = **3** -- **PARAM_ATTENUATION** = **4** -- **PARAM_SPOT_ANGLE** = **1** -- **PARAM_SPOT_ATTENUATION** = **0** -- **PARAM_SHADOW_DARKENING** = **5** -- **PARAM_SHADOW_Z_OFFSET** = **6** -- **COLOR_DIFFUSE** = **0** -- **COLOR_SPECULAR** = **1** -- **BAKE_MODE_DISABLED** = **0** -- **BAKE_MODE_INDIRECT** = **1** -- **BAKE_MODE_INDIRECT_AND_SHADOWS** = **2** -- **BAKE_MODE_FULL** = **3** +- **PARAM_ENERGY** = **0** +- **PARAM_SPECULAR** = **1** +- **PARAM_RANGE** = **2** +- **PARAM_ATTENUATION** = **3** +- **PARAM_SPOT_ANGLE** = **4** +- **PARAM_SPOT_ATTENUATION** = **5** +- **PARAM_CONTACT_SHADOW_SIZE** = **6** +- **PARAM_SHADOW_MAX_DISTANCE** = **7** +- **PARAM_SHADOW_SPLIT_1_OFFSET** = **8** +- **PARAM_SHADOW_SPLIT_2_OFFSET** = **9** +- **PARAM_SHADOW_SPLIT_3_OFFSET** = **10** +- **PARAM_SHADOW_NORMAL_BIAS** = **11** +- **PARAM_SHADOW_BIAS** = **12** +- **PARAM_SHADOW_BIAS_SPLIT_SCALE** = **13** +- **PARAM_MAX** = **14** Description ----------- @@ -79,68 +92,60 @@ Light is the abstract base class for light nodes, so it shouldn't be used direct Member Function Description --------------------------- -.. _class_Light_get_bake_mode: - -- :ref:`int` **get_bake_mode** **(** **)** const - .. _class_Light_get_color: -- :ref:`Color` **get_color** **(** :ref:`int` color **)** const +- :ref:`Color` **get_color** **(** **)** const -.. _class_Light_get_operator: +.. _class_Light_get_cull_mask: -- :ref:`int` **get_operator** **(** **)** const +- :ref:`int` **get_cull_mask** **(** **)** const -.. _class_Light_get_parameter: +.. _class_Light_get_param: -- :ref:`float` **get_parameter** **(** :ref:`int` variable **)** const +- :ref:`float` **get_param** **(** :ref:`int` param **)** const -.. _class_Light_get_projector: +.. _class_Light_get_shadow_color: -- :ref:`Texture` **get_projector** **(** **)** const +- :ref:`Color` **get_shadow_color** **(** **)** const -.. _class_Light_has_project_shadows: +.. _class_Light_has_shadow: -- :ref:`bool` **has_project_shadows** **(** **)** const +- :ref:`bool` **has_shadow** **(** **)** const .. _class_Light_is_editor_only: - :ref:`bool` **is_editor_only** **(** **)** const -.. _class_Light_is_enabled: +.. _class_Light_is_negative: -- :ref:`bool` **is_enabled** **(** **)** const - -.. _class_Light_set_bake_mode: - -- void **set_bake_mode** **(** :ref:`int` bake_mode **)** +- :ref:`bool` **is_negative** **(** **)** const .. _class_Light_set_color: -- void **set_color** **(** :ref:`int` color, :ref:`Color` value **)** +- void **set_color** **(** :ref:`Color` color **)** + +.. _class_Light_set_cull_mask: + +- void **set_cull_mask** **(** :ref:`int` cull_mask **)** .. _class_Light_set_editor_only: - void **set_editor_only** **(** :ref:`bool` editor_only **)** -.. _class_Light_set_enabled: +.. _class_Light_set_negative: -- void **set_enabled** **(** :ref:`bool` enabled **)** +- void **set_negative** **(** :ref:`bool` enabled **)** -.. _class_Light_set_operator: +.. _class_Light_set_param: -- void **set_operator** **(** :ref:`int` operator **)** +- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** -.. _class_Light_set_parameter: +.. _class_Light_set_shadow: -- void **set_parameter** **(** :ref:`int` variable, :ref:`float` value **)** +- void **set_shadow** **(** :ref:`bool` enabled **)** -.. _class_Light_set_project_shadows: +.. _class_Light_set_shadow_color: -- void **set_project_shadows** **(** :ref:`bool` enable **)** - -.. _class_Light_set_projector: - -- void **set_projector** **(** :ref:`Texture` projector **)** +- void **set_shadow_color** **(** :ref:`Color` shadow_color **)** diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index c331297f9..9ccb9ae6f 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -18,85 +18,117 @@ Node that casts light in a 2D environment. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_energy` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_height` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_mask` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_shadow_mask` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_range_max` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_range_min` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_buffer_size` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_shadow_color` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_shadow_esm_multiplier` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_texture` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_texture_offset` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_texture_scale` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_z_range_max` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_z_range_min` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shadow_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_energy` **(** :ref:`float` energy **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_height` **(** :ref:`float` height **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_mask` **(** :ref:`int` item_mask **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shadow_mask` **(** :ref:`int` item_shadow_mask **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_range_max` **(** :ref:`int` layer **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_range_min` **(** :ref:`int` layer **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_buffer_size` **(** :ref:`int` size **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_color` **(** :ref:`Color` shadow_color **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_esm_multiplier` **(** :ref:`float` multiplier **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Object` texture **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_offset` **(** :ref:`Vector2` texture_offset **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_scale` **(** :ref:`float` texture_scale **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_z_range_max` **(** :ref:`int` z **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_z_range_min` **(** :ref:`int` z **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_energy` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_height` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_cull_mask` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_shadow_cull_mask` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_layer_range_max` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_layer_range_min` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mode` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_buffer_size` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_shadow_color` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_filter` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_shadow_gradient_length` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_texture` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_texture_offset` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_texture_scale` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_z_range_max` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_z_range_min` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editor_only` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_enabled` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shadow_enabled` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`Color` color **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editor_only` **(** :ref:`bool` editor_only **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_energy` **(** :ref:`float` energy **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_height` **(** :ref:`float` height **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_cull_mask` **(** :ref:`int` item_cull_mask **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_shadow_cull_mask` **(** :ref:`int` item_shadow_cull_mask **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_layer_range_max` **(** :ref:`int` layer **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_layer_range_min` **(** :ref:`int` layer **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mode` **(** :ref:`int` mode **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_buffer_size` **(** :ref:`int` size **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_color` **(** :ref:`Color` shadow_color **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_filter` **(** :ref:`int` filter **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_gradient_length` **(** :ref:`float` multiplier **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Object` texture **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture_offset` **(** :ref:`Vector2` texture_offset **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture_scale` **(** :ref:`float` texture_scale **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_z_range_max` **(** :ref:`int` z **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_z_range_min` **(** :ref:`int` z **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Color` **color** +- :ref:`bool` **editor_only** +- :ref:`bool` **enabled** +- :ref:`float` **energy** +- :ref:`int` **mode** +- :ref:`Vector2` **offset** +- :ref:`float` **range_height** +- :ref:`int` **range_item_cull_mask** +- :ref:`int` **range_layer_max** +- :ref:`int` **range_layer_min** +- :ref:`int` **range_z_max** +- :ref:`int` **range_z_min** +- :ref:`float` **scale** +- :ref:`int` **shadow_buffer_size** +- :ref:`Color` **shadow_color** +- :ref:`bool` **shadow_enabled** +- :ref:`float` **shadow_filter** +- :ref:`float` **shadow_gradient_length** +- :ref:`int` **shadow_item_cull_mask** +- :ref:`Texture` **texture** Numeric Constants ----------------- - **MODE_ADD** = **0** --- Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behaviour of a light. -- **MODE_SUB** = **1** --- Substract the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect. +- **MODE_SUB** = **1** --- Subtract the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect. - **MODE_MIX** = **2** --- Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation. - **MODE_MASK** = **3** --- The light texture of the Light2D is used as a mask, hiding or revealing parts of the screen underneath depending on the value of each pixel of the light (mask) texture. @@ -126,17 +158,13 @@ Return the energy value of the Light2D. Return the height of the Light2D. Used with 2D normalmapping. -.. _class_Light2D_get_item_mask: +.. _class_Light2D_get_item_cull_mask: -- :ref:`int` **get_item_mask** **(** **)** const +- :ref:`int` **get_item_cull_mask** **(** **)** const -Return the item mask of the Light2D. +.. _class_Light2D_get_item_shadow_cull_mask: -.. _class_Light2D_get_item_shadow_mask: - -- :ref:`int` **get_item_shadow_mask** **(** **)** const - -Return the item shadow mask of the Light2D. +- :ref:`int` **get_item_shadow_cull_mask** **(** **)** const .. _class_Light2D_get_layer_range_max: @@ -168,11 +196,13 @@ Return the shadow buffer size. Return the color of casted shadows for this Light2D. -.. _class_Light2D_get_shadow_esm_multiplier: +.. _class_Light2D_get_shadow_filter: -- :ref:`float` **get_shadow_esm_multiplier** **(** **)** const +- :ref:`int` **get_shadow_filter** **(** **)** const -Return the Exponential Shadow Multiplier (ESM) value of the Light2D. +.. _class_Light2D_get_shadow_gradient_length: + +- :ref:`float` **get_shadow_gradient_length** **(** **)** const .. _class_Light2D_get_texture: @@ -204,6 +234,10 @@ Get the maximum Z value that objects of the scene can be in order to be affected Get the minimum Z value that objects of the scene have to be in order to be affected by the Light2D. +.. _class_Light2D_is_editor_only: + +- :ref:`bool` **is_editor_only** **(** **)** const + .. _class_Light2D_is_enabled: - :ref:`bool` **is_enabled** **(** **)** const @@ -222,6 +256,10 @@ Return true if shadow casting is enabled for this Light2D, else return false. Set the color of the Light2D. +.. _class_Light2D_set_editor_only: + +- void **set_editor_only** **(** :ref:`bool` editor_only **)** + .. _class_Light2D_set_enabled: - void **set_enabled** **(** :ref:`bool` enabled **)** @@ -240,15 +278,15 @@ Set the energy value of the Light2D. The bigger the value, the stronger the ligh Set the height of the Light2D. Used with 2D normalmapping. -.. _class_Light2D_set_item_mask: +.. _class_Light2D_set_item_cull_mask: -- void **set_item_mask** **(** :ref:`int` item_mask **)** +- void **set_item_cull_mask** **(** :ref:`int` item_cull_mask **)** Set the item mask of the Light2D to 'item_mask' value. -.. _class_Light2D_set_item_shadow_mask: +.. _class_Light2D_set_item_shadow_cull_mask: -- void **set_item_shadow_mask** **(** :ref:`int` item_shadow_mask **)** +- void **set_item_shadow_cull_mask** **(** :ref:`int` item_shadow_cull_mask **)** Set the item shadow mask to 'item_shadow_mask' value. @@ -288,11 +326,13 @@ Set the color of casted shadows for this Light2D. Enable or disable shadows casting from this Light2D according to the 'enabled' parameter. -.. _class_Light2D_set_shadow_esm_multiplier: +.. _class_Light2D_set_shadow_filter: -- void **set_shadow_esm_multiplier** **(** :ref:`float` multiplier **)** +- void **set_shadow_filter** **(** :ref:`int` filter **)** -Set the Exponential Shadow Multiplier (ESM) value of the Light2D. +.. _class_Light2D_set_shadow_gradient_length: + +- void **set_shadow_gradient_length** **(** :ref:`float` multiplier **)** .. _class_Light2D_set_texture: diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index fb227cde9..9b9d17710 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_occluder_polygon` **(** :ref:`OccluderPolygon2D` polygon **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **light_mask** +- :ref:`OccluderPolygon2D` **occluder** + Description ----------- diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst new file mode 100644 index 000000000..0e706ae09 --- /dev/null +++ b/classes/class_line2d.rst @@ -0,0 +1,215 @@ +.. 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_Line2D: + +Line2D +====== + +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector2` pos **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_begin_cap_mode` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_default_color` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_end_cap_mode` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_gradient` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joint_mode` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_pos` **(** :ref:`int` i **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_points` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_round_precision` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sharp_limit` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_texture` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_texture_mode` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_width` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` i **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_begin_cap_mode` **(** :ref:`int` mode **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_color` **(** :ref:`Color` color **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_end_cap_mode` **(** :ref:`int` mode **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gradient` **(** :ref:`Object` color **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_joint_mode` **(** :ref:`int` mode **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_pos` **(** :ref:`int` i, :ref:`Vector2` pos **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_points` **(** :ref:`PoolVector2Array` points **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_round_precision` **(** :ref:`int` precision **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sharp_limit` **(** :ref:`float` limit **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Object` texture **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture_mode` **(** :ref:`int` mode **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_width` **(** :ref:`float` width **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`int` **begin_cap_mode** +- :ref:`Color` **default_color** +- :ref:`int` **end_cap_mode** +- :ref:`ColorRamp` **gradient** +- :ref:`int` **joint_mode** +- :ref:`PoolVector2Array` **points** +- :ref:`int` **round_precision** +- :ref:`float` **sharp_limit** +- :ref:`Texture` **texture** +- :ref:`int` **texture_mode** +- :ref:`float` **width** + +Numeric Constants +----------------- + +- **LINE_JOINT_SHARP** = **0** +- **LINE_JOINT_BEVEL** = **1** +- **LINE_JOINT_ROUND** = **2** +- **LINE_CAP_NONE** = **0** +- **LINE_CAP_BOX** = **1** +- **LINE_CAP_ROUND** = **2** +- **LINE_TEXTURE_NONE** = **0** +- **LINE_TEXTURE_TILE** = **1** + +Member Function Description +--------------------------- + +.. _class_Line2D_add_point: + +- void **add_point** **(** :ref:`Vector2` pos **)** + +.. _class_Line2D_get_begin_cap_mode: + +- :ref:`int` **get_begin_cap_mode** **(** **)** const + +.. _class_Line2D_get_default_color: + +- :ref:`Color` **get_default_color** **(** **)** const + +.. _class_Line2D_get_end_cap_mode: + +- :ref:`int` **get_end_cap_mode** **(** **)** const + +.. _class_Line2D_get_gradient: + +- :ref:`Object` **get_gradient** **(** **)** const + +.. _class_Line2D_get_joint_mode: + +- :ref:`int` **get_joint_mode** **(** **)** const + +.. _class_Line2D_get_point_count: + +- :ref:`int` **get_point_count** **(** **)** const + +.. _class_Line2D_get_point_pos: + +- :ref:`Vector2` **get_point_pos** **(** :ref:`int` i **)** const + +.. _class_Line2D_get_points: + +- :ref:`PoolVector2Array` **get_points** **(** **)** const + +.. _class_Line2D_get_round_precision: + +- :ref:`int` **get_round_precision** **(** **)** const + +.. _class_Line2D_get_sharp_limit: + +- :ref:`float` **get_sharp_limit** **(** **)** const + +.. _class_Line2D_get_texture: + +- :ref:`Object` **get_texture** **(** **)** const + +.. _class_Line2D_get_texture_mode: + +- :ref:`int` **get_texture_mode** **(** **)** const + +.. _class_Line2D_get_width: + +- :ref:`float` **get_width** **(** **)** const + +.. _class_Line2D_remove_point: + +- void **remove_point** **(** :ref:`int` i **)** + +.. _class_Line2D_set_begin_cap_mode: + +- void **set_begin_cap_mode** **(** :ref:`int` mode **)** + +.. _class_Line2D_set_default_color: + +- void **set_default_color** **(** :ref:`Color` color **)** + +.. _class_Line2D_set_end_cap_mode: + +- void **set_end_cap_mode** **(** :ref:`int` mode **)** + +.. _class_Line2D_set_gradient: + +- void **set_gradient** **(** :ref:`Object` color **)** + +.. _class_Line2D_set_joint_mode: + +- void **set_joint_mode** **(** :ref:`int` mode **)** + +.. _class_Line2D_set_point_pos: + +- void **set_point_pos** **(** :ref:`int` i, :ref:`Vector2` pos **)** + +.. _class_Line2D_set_points: + +- void **set_points** **(** :ref:`PoolVector2Array` points **)** + +.. _class_Line2D_set_round_precision: + +- void **set_round_precision** **(** :ref:`int` precision **)** + +.. _class_Line2D_set_sharp_limit: + +- void **set_sharp_limit** **(** :ref:`float` limit **)** + +.. _class_Line2D_set_texture: + +- void **set_texture** **(** :ref:`Object` texture **)** + +.. _class_Line2D_set_texture_mode: + +- void **set_texture_mode** **(** :ref:`int` mode **)** + +.. _class_Line2D_set_width: + +- void **set_width** **(** :ref:`float` width **)** + + diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index be91ab12f..dc1890b86 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -82,6 +82,21 @@ Signals - **text_changed** **(** :ref:`String` text **)** - **text_entered** **(** :ref:`String` text **)** +Member Variables +---------------- + +- :ref:`int` **align** +- :ref:`bool` **caret_blink** +- :ref:`float` **caret_blink_speed** +- :ref:`bool` **editable** +- :ref:`bool` **expand_to_len** +- :ref:`int` **focus_mode** +- :ref:`int` **max_length** +- :ref:`float` **placeholder_alpha** +- :ref:`String` **placeholder_text** +- :ref:`bool` **secret** +- :ref:`String` **text** + Numeric Constants ----------------- diff --git a/classes/class_lineshape2d.rst b/classes/class_lineshape2d.rst index 1525dda42..7dd69a605 100644 --- a/classes/class_lineshape2d.rst +++ b/classes/class_lineshape2d.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_normal` **(** :ref:`Vector2` normal **)** | +--------------------------------+----------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **d** +- :ref:`Vector2` **normal** + Description ----------- diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index 34caf5fe6..e1b36e3e2 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_underline_mode` **(** :ref:`int` underline_mode **)** | +------------------------------+-------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`String` **text** +- :ref:`int` **underline** + Numeric Constants ----------------- diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index 9bb28e168..d6ae04c2b 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -20,42 +20,42 @@ Main loop is the abstract main loop base class. Member Functions ---------------- -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_drop_files` **(** :ref:`StringArray` files, :ref:`int` screen **)** virtual | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_finalize` **(** **)** virtual | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_idle` **(** :ref:`float` delta **)** virtual | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_initialize` **(** **)** virtual | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input_event` **(** :ref:`InputEvent` ev **)** virtual | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input_text` **(** :ref:`String` text **)** virtual | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_iteration` **(** :ref:`float` delta **)** virtual | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`finish` **(** **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`idle` **(** :ref:`float` delta **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`init` **(** **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input_event` **(** :ref:`InputEvent` ev **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input_text` **(** :ref:`String` text **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`iteration` **(** :ref:`float` delta **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_drop_files` **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** virtual | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_finalize` **(** **)** virtual | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_idle` **(** :ref:`float` delta **)** virtual | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_initialize` **(** **)** virtual | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input_event` **(** :ref:`InputEvent` ev **)** virtual | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input_text` **(** :ref:`String` text **)** virtual | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_iteration` **(** :ref:`float` delta **)** virtual | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`finish` **(** **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`idle` **(** :ref:`float` delta **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`init` **(** **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`input_event` **(** :ref:`InputEvent` ev **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`input_text` **(** :ref:`String` text **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`iteration` **(** :ref:`float` delta **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- -- **NOTIFICATION_WM_MOUSE_ENTER** = **3** -- **NOTIFICATION_WM_MOUSE_EXIT** = **4** -- **NOTIFICATION_WM_FOCUS_IN** = **5** -- **NOTIFICATION_WM_FOCUS_OUT** = **6** -- **NOTIFICATION_WM_QUIT_REQUEST** = **7** +- **NOTIFICATION_WM_MOUSE_ENTER** = **2** +- **NOTIFICATION_WM_MOUSE_EXIT** = **3** +- **NOTIFICATION_WM_FOCUS_IN** = **4** +- **NOTIFICATION_WM_FOCUS_OUT** = **5** +- **NOTIFICATION_WM_QUIT_REQUEST** = **6** - **NOTIFICATION_WM_UNFOCUS_REQUEST** = **8** - **NOTIFICATION_OS_MEMORY_WARNING** = **9** @@ -69,7 +69,7 @@ Member Function Description .. _class_MainLoop__drop_files: -- void **_drop_files** **(** :ref:`StringArray` files, :ref:`int` screen **)** virtual +- void **_drop_files** **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** virtual .. _class_MainLoop__finalize: diff --git a/classes/class_marshalls.rst b/classes/class_marshalls.rst index 32c20320e..29cfb467e 100644 --- a/classes/class_marshalls.rst +++ b/classes/class_marshalls.rst @@ -18,26 +18,26 @@ Brief Description Member Functions ---------------- -+----------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`base64_to_raw` **(** :ref:`String` base64_str **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`base64_to_utf8` **(** :ref:`String` base64_str **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`base64_to_variant` **(** :ref:`String` base64_str **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`raw_to_base64` **(** :ref:`RawArray` array **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`utf8_to_base64` **(** :ref:`String` utf8_str **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`variant_to_base64` **(** :ref:`Variant` variant **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`base64_to_raw` **(** :ref:`String` base64_str **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`base64_to_utf8` **(** :ref:`String` base64_str **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`base64_to_variant` **(** :ref:`String` base64_str **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`raw_to_base64` **(** :ref:`PoolByteArray` array **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`utf8_to_base64` **(** :ref:`String` utf8_str **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`variant_to_base64` **(** :ref:`Variant` variant **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_Marshalls_base64_to_raw: -- :ref:`RawArray` **base64_to_raw** **(** :ref:`String` base64_str **)** +- :ref:`PoolByteArray` **base64_to_raw** **(** :ref:`String` base64_str **)** .. _class_Marshalls_base64_to_utf8: @@ -49,7 +49,7 @@ Member Function Description .. _class_Marshalls_raw_to_base64: -- :ref:`String` **raw_to_base64** **(** :ref:`RawArray` array **)** +- :ref:`String` **raw_to_base64** **(** :ref:`PoolByteArray` array **)** .. _class_Marshalls_utf8_to_base64: diff --git a/classes/class_material.rst b/classes/class_material.rst index e2e57beb7..20c3f9fe9 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -8,7 +8,7 @@ Material **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`ShaderMaterial`, :ref:`FixedSpatialMaterial` +**Inherited By:** :ref:`ParticlesMaterial`, :ref:`ShaderMaterial`, :ref:`SpatialMaterial` **Category:** Core @@ -17,98 +17,8 @@ Brief Description Abstract base :ref:`Resource` for coloring and shading geometry. -Member Functions ----------------- - -+----------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_mode` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_depth_draw_mode` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag` **(** :ref:`int` flag **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_line_width` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_mode` **(** :ref:`int` mode **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_depth_draw_mode` **(** :ref:`int` mode **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` enable **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_line_width` **(** :ref:`float` width **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------+ - -Numeric Constants ------------------ - -- **FLAG_VISIBLE** = **0** --- Geometry is visible when this flag is enabled (default). -- **FLAG_DOUBLE_SIDED** = **1** --- Both front facing and back facing triangles are rendered when this flag is enabled. -- **FLAG_INVERT_FACES** = **2** --- Front facing and back facing order is swapped when this flag is enabled. -- **FLAG_UNSHADED** = **3** --- Shading (lighting) is disabled when this flag is enabled. -- **FLAG_ONTOP** = **4** -- **FLAG_LIGHTMAP_ON_UV2** = **5** -- **FLAG_COLOR_ARRAY_SRGB** = **6** -- **FLAG_MAX** = **7** --- Maximum amount of flags. -- **DEPTH_DRAW_ALWAYS** = **0** -- **DEPTH_DRAW_OPAQUE_ONLY** = **1** -- **DEPTH_DRAW_OPAQUE_PRE_PASS_ALPHA** = **2** -- **DEPTH_DRAW_NEVER** = **3** -- **BLEND_MODE_MIX** = **0** --- Use the regular alpha blending equation (source and dest colors are faded) (default). -- **BLEND_MODE_ADD** = **1** --- Use additive blending equation, often used for particle effects such as fire or light decals. -- **BLEND_MODE_SUB** = **2** --- Use subtractive blending equation, often used for some smoke effects or types of glass. -- **BLEND_MODE_MUL** = **3** -- **BLEND_MODE_PREMULT_ALPHA** = **4** - Description ----------- Material is a base :ref:`Resource` used for coloring and shading geometry. All materials inherit from it and almost all :ref:`VisualInstance` derived nodes carry a Material. A few flags and parameters are shared between all material types and are configured here. -Member Function Description ---------------------------- - -.. _class_Material_get_blend_mode: - -- :ref:`int` **get_blend_mode** **(** **)** const - -Return blend mode for the material, which can be one of BLEND_MODE_MIX (default), BLEND_MODE_ADD, BLEND_MODE_SUB. Keep in mind that only BLEND_MODE_MIX ensures that the material *may* be opaque, any other blend mode will render with alpha blending enabled in raster-based :ref:`VisualServer` implementations. - -.. _class_Material_get_depth_draw_mode: - -- :ref:`int` **get_depth_draw_mode** **(** **)** const - -.. _class_Material_get_flag: - -- :ref:`bool` **get_flag** **(** :ref:`int` flag **)** const - -Return a :ref:`Material` flag, which toggles on or off a behavior when rendering. See enumeration FLAG\_\* for a list. - -.. _class_Material_get_line_width: - -- :ref:`float` **get_line_width** **(** **)** const - -Return the line width for geometry drawn with FLAG_WIREFRAME enabled, or LINE primitives. Note that not all hardware or VisualServer backends support this (like DirectX). - -.. _class_Material_set_blend_mode: - -- void **set_blend_mode** **(** :ref:`int` mode **)** - -Set blend mode for the material, which can be one of BLEND_MODE_MIX (default), BLEND_MODE_ADD, BLEND_MODE_SUB. Keep in mind that only BLEND_MODE_MIX ensures that the material *may* be opaque, any other blend mode will render with alpha blending enabled in raster-based :ref:`VisualServer` implementations. - -.. _class_Material_set_depth_draw_mode: - -- void **set_depth_draw_mode** **(** :ref:`int` mode **)** - -.. _class_Material_set_flag: - -- void **set_flag** **(** :ref:`int` flag, :ref:`bool` enable **)** - -Set a :ref:`Material` flag, which toggles on or off a behavior when rendering. See enumeration FLAG\_\* for a list. - -.. _class_Material_set_line_width: - -- void **set_line_width** **(** :ref:`float` width **)** - -Set the line width for geometry drawn with FLAG_WIREFRAME enabled, or LINE primitives. Note that not all hardware or VisualServer backends support this (like DirectX). - - diff --git a/classes/class_materialshadergraph.rst b/classes/class_materialshadergraph.rst deleted file mode 100644 index 0bd79d8a8..000000000 --- a/classes/class_materialshadergraph.rst +++ /dev/null @@ -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_MaterialShaderGraph: - -MaterialShaderGraph -=================== - -**Inherits:** :ref:`ShaderGraph` **<** :ref:`Shader` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_matrix32.rst b/classes/class_matrix32.rst deleted file mode 100644 index ebe9c5808..000000000 --- a/classes/class_matrix32.rst +++ /dev/null @@ -1,138 +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_Matrix32: - -Matrix32 -======== - -**Category:** Built-In Types - -Brief Description ------------------ - -3x2 Matrix for 2D transforms. - -Member Functions ----------------- - -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`Matrix32` **(** :ref:`Transform` from **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`Matrix32` **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`Matrix32` **(** :ref:`float` rot, :ref:`Vector2` pos **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`affine_inverse` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`basis_xform` **(** var v **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`basis_xform_inv` **(** var v **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_origin` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scale` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`interpolate_with` **(** :ref:`Matrix32` m, :ref:`float` c **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`inverse` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`orthonormalized` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`rotated` **(** :ref:`float` phi **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`scaled` **(** :ref:`Vector2` scale **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`translated` **(** :ref:`Vector2` offset **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`xform` **(** var v **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`xform_inv` **(** var v **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Member Variables ----------------- - -- :ref:`Vector2` **o** -- :ref:`Vector2` **x** -- :ref:`Vector2` **y** - -Description ------------ - -3x2 Matrix for 2D transforms. - -Member Function Description ---------------------------- - -.. _class_Matrix32_Matrix32: - -- :ref:`Matrix32` **Matrix32** **(** :ref:`Transform` from **)** - -.. _class_Matrix32_Matrix32: - -- :ref:`Matrix32` **Matrix32** **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** - -.. _class_Matrix32_Matrix32: - -- :ref:`Matrix32` **Matrix32** **(** :ref:`float` rot, :ref:`Vector2` pos **)** - -.. _class_Matrix32_affine_inverse: - -- :ref:`Matrix32` **affine_inverse** **(** **)** - -.. _class_Matrix32_basis_xform: - -- :ref:`Matrix32` **basis_xform** **(** var v **)** - -.. _class_Matrix32_basis_xform_inv: - -- :ref:`Matrix32` **basis_xform_inv** **(** var v **)** - -.. _class_Matrix32_get_origin: - -- :ref:`Vector2` **get_origin** **(** **)** - -.. _class_Matrix32_get_rotation: - -- :ref:`float` **get_rotation** **(** **)** - -.. _class_Matrix32_get_scale: - -- :ref:`Vector2` **get_scale** **(** **)** - -.. _class_Matrix32_interpolate_with: - -- :ref:`Matrix32` **interpolate_with** **(** :ref:`Matrix32` m, :ref:`float` c **)** - -.. _class_Matrix32_inverse: - -- :ref:`Matrix32` **inverse** **(** **)** - -.. _class_Matrix32_orthonormalized: - -- :ref:`Matrix32` **orthonormalized** **(** **)** - -.. _class_Matrix32_rotated: - -- :ref:`Matrix32` **rotated** **(** :ref:`float` phi **)** - -.. _class_Matrix32_scaled: - -- :ref:`Matrix32` **scaled** **(** :ref:`Vector2` scale **)** - -.. _class_Matrix32_translated: - -- :ref:`Matrix32` **translated** **(** :ref:`Vector2` offset **)** - -.. _class_Matrix32_xform: - -- :ref:`Matrix32` **xform** **(** var v **)** - -.. _class_Matrix32_xform_inv: - -- :ref:`Matrix32` **xform_inv** **(** var v **)** - - diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index b0bb07426..82c9969e6 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -27,6 +27,11 @@ Signals - **about_to_show** **(** **)** +Member Variables +---------------- + +- :ref:`Array` **items** + Description ----------- diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index 68d78de0e..ed9d4db85 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -8,6 +8,8 @@ Mesh **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`QuadMesh` + **Category:** Core Brief Description @@ -18,49 +20,49 @@ A :ref:`Resource` that contains vertex-array based geometry. Member Functions ---------------- -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_morph_target` **(** :ref:`String` name **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_surface` **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` morph_arrays=Array(), :ref:`bool` alphasort=false **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`center_geometry` **(** **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_morph_targets` **(** **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_custom_aabb` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_morph_target_count` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_morph_target_mode` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_morph_target_name` **(** :ref:`int` index **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_surface_count` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`regen_normalmaps` **(** **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_aabb` **(** :ref:`AABB` aabb **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_morph_target_mode` **(** :ref:`int` mode **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_remove` **(** :ref:`int` surf_idx **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_blend_shape` **(** :ref:`String` name **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_surface_from_arrays` **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=Array(), :ref:`int` compress_flags=97792 **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`center_geometry` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_blend_shapes` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_shape_count` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_shape_mode` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`get_custom_aabb` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_surface_count` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`regen_normalmaps` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_shape_mode` **(** :ref:`int` mode **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_aabb` **(** :ref:`Rect3` aabb **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_remove` **(** :ref:`int` surf_idx **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -101,43 +103,43 @@ Mesh is a type of :ref:`Resource` that contains vertex-array bas Member Function Description --------------------------- -.. _class_Mesh_add_morph_target: +.. _class_Mesh_add_blend_shape: -- void **add_morph_target** **(** :ref:`String` name **)** +- void **add_blend_shape** **(** :ref:`String` name **)** -.. _class_Mesh_add_surface: +.. _class_Mesh_add_surface_from_arrays: -- void **add_surface** **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` morph_arrays=Array(), :ref:`bool` alphasort=false **)** +- void **add_surface_from_arrays** **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=Array(), :ref:`int` compress_flags=97792 **)** Create a new surface (:ref:`get_surface_count` that will become surf_idx for this. Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. (As a note, when using indices, it is recommended to only use just points, lines or triangles). -The format of a surface determines which arrays it will allocate and hold, so "format" is a combination of ARRAY_FORMAT\_\* mask constants ORed together. ARRAY_FORMAT_VERTEX must be always present. "array_len" determines the amount of vertices in the array (not primitives!). if ARRAY_FORMAT_INDEX is in the format mask, then it means that an index array will be allocated and "index_array_len" must be passed. +(might be obsolete) The format of a surface determines which arrays it will allocate and hold, so "format" is a combination of ARRAY_FORMAT\_\* mask constants ORed together. ARRAY_FORMAT_VERTEX must be always present. "array_len" determines the amount of vertices in the array (not primitives!). if ARRAY_FORMAT_INDEX is in the format mask, then it means that an index array will be allocated and "index_array_len" must be passed .. _class_Mesh_center_geometry: - void **center_geometry** **(** **)** -.. _class_Mesh_clear_morph_targets: +.. _class_Mesh_clear_blend_shapes: -- void **clear_morph_targets** **(** **)** +- void **clear_blend_shapes** **(** **)** + +.. _class_Mesh_get_blend_shape_count: + +- :ref:`int` **get_blend_shape_count** **(** **)** const + +.. _class_Mesh_get_blend_shape_mode: + +- :ref:`int` **get_blend_shape_mode** **(** **)** const + +.. _class_Mesh_get_blend_shape_name: + +- :ref:`String` **get_blend_shape_name** **(** :ref:`int` index **)** const .. _class_Mesh_get_custom_aabb: -- :ref:`AABB` **get_custom_aabb** **(** **)** const - -.. _class_Mesh_get_morph_target_count: - -- :ref:`int` **get_morph_target_count** **(** **)** const - -.. _class_Mesh_get_morph_target_mode: - -- :ref:`int` **get_morph_target_mode** **(** **)** const - -.. _class_Mesh_get_morph_target_name: - -- :ref:`String` **get_morph_target_name** **(** :ref:`int` index **)** const +- :ref:`Rect3` **get_custom_aabb** **(** **)** const .. _class_Mesh_get_surface_count: @@ -149,13 +151,13 @@ Return the amount of surfaces that the :ref:`Mesh` holds. - void **regen_normalmaps** **(** **)** +.. _class_Mesh_set_blend_shape_mode: + +- void **set_blend_shape_mode** **(** :ref:`int` mode **)** + .. _class_Mesh_set_custom_aabb: -- void **set_custom_aabb** **(** :ref:`AABB` aabb **)** - -.. _class_Mesh_set_morph_target_mode: - -- void **set_morph_target_mode** **(** :ref:`int` mode **)** +- void **set_custom_aabb** **(** :ref:`Rect3` aabb **)** .. _class_Mesh_surface_get_array_index_len: diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index 69e9a2e4f..590b6811f 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -18,83 +18,83 @@ Brief Description Member Functions ---------------- -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`commit_to_surface` **(** :ref:`Object` mesh **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_from_surface` **(** :ref:`Object` mesh, :ref:`int` surface **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_edge_count` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`IntArray` | :ref:`get_edge_faces` **(** :ref:`int` idx **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_edge_meta` **(** :ref:`int` idx **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_edge_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_face_count` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_face_edge` **(** :ref:`int` idx, :ref:`int` edge **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_face_meta` **(** :ref:`int` idx **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_face_normal` **(** :ref:`int` idx **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_face_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_format` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_material` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_vertex` **(** :ref:`int` idx **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`IntArray` | :ref:`get_vertex_bones` **(** :ref:`int` idx **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_vertex_color` **(** :ref:`int` idx **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_vertex_count` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`IntArray` | :ref:`get_vertex_edges` **(** :ref:`int` idx **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`IntArray` | :ref:`get_vertex_faces` **(** :ref:`int` idx **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_vertex_meta` **(** :ref:`int` idx **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_vertex_normal` **(** :ref:`int` idx **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`get_vertex_tangent` **(** :ref:`int` idx **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_vertex_uv` **(** :ref:`int` idx **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_vertex_uv2` **(** :ref:`int` idx **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RealArray` | :ref:`get_vertex_weights` **(** :ref:`int` idx **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_edge_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_face_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex` **(** :ref:`int` idx, :ref:`Vector3` vertex **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_bones` **(** :ref:`int` idx, :ref:`IntArray` bones **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_color` **(** :ref:`int` idx, :ref:`Color` color **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_normal` **(** :ref:`int` idx, :ref:`Vector3` normal **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_tangent` **(** :ref:`int` idx, :ref:`Plane` tangent **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_uv` **(** :ref:`int` idx, :ref:`Vector2` uv **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_uv2` **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_weights` **(** :ref:`int` idx, :ref:`RealArray` weights **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`commit_to_surface` **(** :ref:`Object` mesh **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_from_surface` **(** :ref:`Object` mesh, :ref:`int` surface **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_edge_count` **(** **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_edge_faces` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_edge_meta` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_edge_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_face_count` **(** **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_face_edge` **(** :ref:`int` idx, :ref:`int` edge **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_face_meta` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_face_normal` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_face_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_format` **(** **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_material` **(** **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_vertex` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_vertex_bones` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_vertex_color` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_vertex_count` **(** **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_vertex_edges` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_vertex_faces` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_vertex_meta` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_vertex_normal` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`get_vertex_tangent` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_vertex_uv` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_vertex_uv2` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`get_vertex_weights` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_edge_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_face_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material` **(** :ref:`Material` material **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex` **(** :ref:`int` idx, :ref:`Vector3` vertex **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_bones` **(** :ref:`int` idx, :ref:`PoolIntArray` bones **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_color` **(** :ref:`int` idx, :ref:`Color` color **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_normal` **(** :ref:`int` idx, :ref:`Vector3` normal **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_tangent` **(** :ref:`int` idx, :ref:`Plane` tangent **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_uv` **(** :ref:`int` idx, :ref:`Vector2` uv **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_uv2` **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_weights` **(** :ref:`int` idx, :ref:`PoolRealArray` weights **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- @@ -117,7 +117,7 @@ Member Function Description .. _class_MeshDataTool_get_edge_faces: -- :ref:`IntArray` **get_edge_faces** **(** :ref:`int` idx **)** const +- :ref:`PoolIntArray` **get_edge_faces** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_edge_meta: @@ -161,7 +161,7 @@ Member Function Description .. _class_MeshDataTool_get_vertex_bones: -- :ref:`IntArray` **get_vertex_bones** **(** :ref:`int` idx **)** const +- :ref:`PoolIntArray` **get_vertex_bones** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_color: @@ -173,11 +173,11 @@ Member Function Description .. _class_MeshDataTool_get_vertex_edges: -- :ref:`IntArray` **get_vertex_edges** **(** :ref:`int` idx **)** const +- :ref:`PoolIntArray` **get_vertex_edges** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_faces: -- :ref:`IntArray` **get_vertex_faces** **(** :ref:`int` idx **)** const +- :ref:`PoolIntArray` **get_vertex_faces** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_meta: @@ -201,7 +201,7 @@ Member Function Description .. _class_MeshDataTool_get_vertex_weights: -- :ref:`RealArray` **get_vertex_weights** **(** :ref:`int` idx **)** const +- :ref:`PoolRealArray` **get_vertex_weights** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_set_edge_meta: @@ -221,7 +221,7 @@ Member Function Description .. _class_MeshDataTool_set_vertex_bones: -- void **set_vertex_bones** **(** :ref:`int` idx, :ref:`IntArray` bones **)** +- void **set_vertex_bones** **(** :ref:`int` idx, :ref:`PoolIntArray` bones **)** .. _class_MeshDataTool_set_vertex_color: @@ -249,6 +249,6 @@ Member Function Description .. _class_MeshDataTool_set_vertex_weights: -- void **set_vertex_weights** **(** :ref:`int` idx, :ref:`RealArray` weights **)** +- void **set_vertex_weights** **(** :ref:`int` idx, :ref:`PoolRealArray` weights **)** diff --git a/classes/class_meshinstance.rst b/classes/class_meshinstance.rst index 0cd5d696c..9de14ba9e 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -23,8 +23,6 @@ Member Functions +----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_trimesh_collision` **(** **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :ref:`Mesh` | :ref:`get_mesh` **(** **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :ref:`NodePath` | :ref:`get_skeleton_path` **(** **)** | @@ -34,6 +32,12 @@ Member Functions | void | :ref:`set_skeleton_path` **(** :ref:`NodePath` skeleton_path **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Mesh` **mesh** +- :ref:`NodePath` **skeleton** + Description ----------- @@ -52,12 +56,6 @@ Member Function Description This helper creates a :ref:`StaticBody` child :ref:`Node` using the mesh geometry as collision. It's mainly used for testing. -.. _class_MeshInstance_get_aabb: - -- :ref:`AABB` **get_aabb** **(** **)** const - -Return the AABB of the mesh, in local coordinates. - .. _class_MeshInstance_get_mesh: - :ref:`Mesh` **get_mesh** **(** **)** const diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index 176466e5a..657ee1f36 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -23,7 +23,7 @@ Member Functions +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_item` **(** :ref:`int` id **)** | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`IntArray` | :ref:`get_item_list` **(** **)** const | +| :ref:`PoolIntArray` | :ref:`get_item_list` **(** **)** const | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Mesh` | :ref:`get_item_mesh` **(** :ref:`int` id **)** const | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -68,7 +68,7 @@ Create a new item in the library, supplied an id. .. _class_MeshLibrary_get_item_list: -- :ref:`IntArray` **get_item_list** **(** **)** const +- :ref:`PoolIntArray` **get_item_list** **(** **)** const Return the list of items. diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index e4ac19ced..5095884ed 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -19,9 +19,9 @@ Member Functions ---------------- +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`generate_aabb` **(** **)** | +| :ref:`Rect3` | :ref:`get_aabb` **(** **)** const | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | +| :ref:`int` | :ref:`get_color_format` **(** **)** const | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_instance_color` **(** :ref:`int` instance **)** const | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -31,7 +31,9 @@ Member Functions +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Mesh` | :ref:`get_mesh` **(** **)** const | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_aabb` **(** :ref:`AABB` visibility_aabb **)** | +| :ref:`int` | :ref:`get_transform_format` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color_format` **(** :ref:`int` format **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_instance_color` **(** :ref:`int` instance, :ref:`Color` color **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -41,6 +43,27 @@ Member Functions +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_mesh` **(** :ref:`Mesh` mesh **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform_format` **(** :ref:`int` format **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`PoolColorArray` **color_array** +- :ref:`int` **color_format** +- :ref:`int` **instance_count** +- :ref:`Mesh` **mesh** +- :ref:`PoolVector3Array` **transform_array** +- :ref:`int` **transform_format** + +Numeric Constants +----------------- + +- **TRANSFORM_2D** = **0** +- **TRANSFORM_3D** = **1** +- **COLOR_NONE** = **0** +- **COLOR_8BIT** = **1** +- **COLOR_FLOAT** = **2** Description ----------- @@ -51,22 +74,20 @@ For this case a MultiMesh becomes very useful, as it can draw thousands of insta As a drawback, if the instances are too far away of each other, performance may be reduced as every single instance will always rendered (they are spatially indexed as one, for the whole object). -Since instances may have any behavior, the AABB used for visibility must be provided by the user, or generated with :ref:`generate_aabb`. +Since instances may have any behavior, the Rect3 used for visibility must be provided by the user, or generated with :ref:`generate_aabb`. Member Function Description --------------------------- -.. _class_MultiMesh_generate_aabb: - -- void **generate_aabb** **(** **)** - -Generate a new visibility AABB, using mesh AABB and instance transforms. Since instance information is stored in the :ref:`VisualServer`, this function is VERY SLOW and must NOT be used often. - .. _class_MultiMesh_get_aabb: -- :ref:`AABB` **get_aabb** **(** **)** const +- :ref:`Rect3` **get_aabb** **(** **)** const -Return the visibility AABB. +Return the visibility Rect3. + +.. _class_MultiMesh_get_color_format: + +- :ref:`int` **get_color_format** **(** **)** const .. _class_MultiMesh_get_instance_color: @@ -92,11 +113,13 @@ Return the transform of a specific instance. Return the :ref:`Mesh` resource drawn as multiple instances. -.. _class_MultiMesh_set_aabb: +.. _class_MultiMesh_get_transform_format: -- void **set_aabb** **(** :ref:`AABB` visibility_aabb **)** +- :ref:`int` **get_transform_format** **(** **)** const -Set the visibility AABB. If not provided, MultiMesh will not be visible. +.. _class_MultiMesh_set_color_format: + +- void **set_color_format** **(** :ref:`int` format **)** .. _class_MultiMesh_set_instance_color: @@ -122,4 +145,8 @@ Set the transform for a specific instance. Set the :ref:`Mesh` resource to be drawn in multiple instances. +.. _class_MultiMesh_set_transform_format: + +- void **set_transform_format** **(** :ref:`int` format **)** + diff --git a/classes/class_multimeshinstance.rst b/classes/class_multimeshinstance.rst index ac2847ef9..ae1600c69 100644 --- a/classes/class_multimeshinstance.rst +++ b/classes/class_multimeshinstance.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_multimesh` **(** :ref:`Object` multimesh **)** | +------------------------------+-----------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`MultiMesh` **multimesh** + Description ----------- diff --git a/classes/class_navigation.rst b/classes/class_navigation.rst index 5186cdc42..62fd8c76a 100644 --- a/classes/class_navigation.rst +++ b/classes/class_navigation.rst @@ -18,27 +18,32 @@ Brief Description Member Functions ---------------- -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_normal` **(** :ref:`Vector3` to_point **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector3` to_point **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3Array` | :ref:`get_simple_path` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_up_vector` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`navmesh_create` **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=NULL **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navmesh_remove` **(** :ref:`int` id **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navmesh_set_transform` **(** :ref:`int` id, :ref:`Transform` xform **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_up_vector` **(** :ref:`Vector3` up **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_normal` **(** :ref:`Vector3` to_point **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector3` to_point **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_simple_path` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_up_vector` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`navmesh_create` **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=NULL **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`navmesh_remove` **(** :ref:`int` id **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`navmesh_set_transform` **(** :ref:`int` id, :ref:`Transform` xform **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_up_vector` **(** :ref:`Vector3` up **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Vector3` **up_vector** Member Function Description --------------------------- @@ -61,7 +66,7 @@ Member Function Description .. _class_Navigation_get_simple_path: -- :ref:`Vector3Array` **get_simple_path** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** +- :ref:`PoolVector3Array` **get_simple_path** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** .. _class_Navigation_get_up_vector: diff --git a/classes/class_navigation2d.rst b/classes/class_navigation2d.rst index 494fbffce..0792f7d83 100644 --- a/classes/class_navigation2d.rst +++ b/classes/class_navigation2d.rst @@ -18,19 +18,19 @@ Brief Description Member Functions ---------------- -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` to_point **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector2` to_point **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`get_simple_path` **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`navpoly_create` **(** :ref:`NavigationPolygon` mesh, :ref:`Matrix32` xform, :ref:`Object` owner=NULL **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navpoly_remove` **(** :ref:`int` id **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navpoly_set_transform` **(** :ref:`int` id, :ref:`Matrix32` xform **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` to_point **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector2` to_point **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_simple_path` **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`navpoly_create` **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=NULL **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`navpoly_remove` **(** :ref:`int` id **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`navpoly_set_transform` **(** :ref:`int` id, :ref:`Transform2D` xform **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- @@ -45,11 +45,11 @@ Member Function Description .. _class_Navigation2D_get_simple_path: -- :ref:`Vector2Array` **get_simple_path** **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** +- :ref:`PoolVector2Array` **get_simple_path** **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** .. _class_Navigation2D_navpoly_create: -- :ref:`int` **navpoly_create** **(** :ref:`NavigationPolygon` mesh, :ref:`Matrix32` xform, :ref:`Object` owner=NULL **)** +- :ref:`int` **navpoly_create** **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=NULL **)** .. _class_Navigation2D_navpoly_remove: @@ -57,6 +57,6 @@ Member Function Description .. _class_Navigation2D_navpoly_set_transform: -- void **navpoly_set_transform** **(** :ref:`int` id, :ref:`Matrix32` xform **)** +- void **navpoly_set_transform** **(** :ref:`int` id, :ref:`Transform2D` xform **)** diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index c3e5e4ac8..ffdabe48a 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -18,26 +18,32 @@ Brief Description Member Functions ---------------- -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_polygon` **(** :ref:`IntArray` polygon **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_polygons` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`IntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3Array` | :ref:`get_vertices` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertices` **(** :ref:`Vector3Array` vertices **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_polygons` **(** **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_vertices` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertices` **(** :ref:`PoolVector3Array` vertices **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Array` **polygons** +- :ref:`PoolVector3Array` **vertices** Member Function Description --------------------------- .. _class_NavigationMesh_add_polygon: -- void **add_polygon** **(** :ref:`IntArray` polygon **)** +- void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** .. _class_NavigationMesh_clear_polygons: @@ -45,7 +51,7 @@ Member Function Description .. _class_NavigationMesh_get_polygon: -- :ref:`IntArray` **get_polygon** **(** :ref:`int` idx **)** +- :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** .. _class_NavigationMesh_get_polygon_count: @@ -53,10 +59,10 @@ Member Function Description .. _class_NavigationMesh_get_vertices: -- :ref:`Vector3Array` **get_vertices** **(** **)** const +- :ref:`PoolVector3Array` **get_vertices** **(** **)** const .. _class_NavigationMesh_set_vertices: -- void **set_vertices** **(** :ref:`Vector3Array` vertices **)** +- void **set_vertices** **(** :ref:`PoolVector3Array` vertices **)** diff --git a/classes/class_navigationmeshinstance.rst b/classes/class_navigationmeshinstance.rst index f7db6cdfb..578fe04b2 100644 --- a/classes/class_navigationmeshinstance.rst +++ b/classes/class_navigationmeshinstance.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_navigation_mesh` **(** :ref:`Object` navmesh **)** | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`bool` **enabled** +- :ref:`NavigationMesh` **navmesh** + Member Function Description --------------------------- diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index efd79bbda..d55dcee05 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -18,50 +18,57 @@ Brief Description Member Functions ---------------- -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_outline` **(** :ref:`Vector2Array` outline **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_outline_at_index` **(** :ref:`Vector2Array` outline, :ref:`int` index **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_polygon` **(** :ref:`IntArray` polygon **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_outlines` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_polygons` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`get_outline` **(** :ref:`int` idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_outline_count` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`IntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`get_vertices` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_polygons_from_outlines` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_outline` **(** :ref:`int` idx **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_outline` **(** :ref:`int` idx, :ref:`Vector2Array` outline **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertices` **(** :ref:`Vector2Array` vertices **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_outline` **(** :ref:`PoolVector2Array` outline **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_outline_at_index` **(** :ref:`PoolVector2Array` outline, :ref:`int` index **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_outlines` **(** **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_polygons` **(** **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_outline` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_outline_count` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_vertices` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_polygons_from_outlines` **(** **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_outline` **(** :ref:`int` idx **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_outline` **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertices` **(** :ref:`PoolVector2Array` vertices **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Array` **outlines** +- :ref:`Array` **polygons** +- :ref:`PoolVector3Array` **vertices** Member Function Description --------------------------- .. _class_NavigationPolygon_add_outline: -- void **add_outline** **(** :ref:`Vector2Array` outline **)** +- void **add_outline** **(** :ref:`PoolVector2Array` outline **)** .. _class_NavigationPolygon_add_outline_at_index: -- void **add_outline_at_index** **(** :ref:`Vector2Array` outline, :ref:`int` index **)** +- void **add_outline_at_index** **(** :ref:`PoolVector2Array` outline, :ref:`int` index **)** .. _class_NavigationPolygon_add_polygon: -- void **add_polygon** **(** :ref:`IntArray` polygon **)** +- void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** .. _class_NavigationPolygon_clear_outlines: @@ -73,7 +80,7 @@ Member Function Description .. _class_NavigationPolygon_get_outline: -- :ref:`Vector2Array` **get_outline** **(** :ref:`int` idx **)** const +- :ref:`PoolVector2Array` **get_outline** **(** :ref:`int` idx **)** const .. _class_NavigationPolygon_get_outline_count: @@ -81,7 +88,7 @@ Member Function Description .. _class_NavigationPolygon_get_polygon: -- :ref:`IntArray` **get_polygon** **(** :ref:`int` idx **)** +- :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** .. _class_NavigationPolygon_get_polygon_count: @@ -89,7 +96,7 @@ Member Function Description .. _class_NavigationPolygon_get_vertices: -- :ref:`Vector2Array` **get_vertices** **(** **)** const +- :ref:`PoolVector2Array` **get_vertices** **(** **)** const .. _class_NavigationPolygon_make_polygons_from_outlines: @@ -101,10 +108,10 @@ Member Function Description .. _class_NavigationPolygon_set_outline: -- void **set_outline** **(** :ref:`int` idx, :ref:`Vector2Array` outline **)** +- void **set_outline** **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** .. _class_NavigationPolygon_set_vertices: -- void **set_vertices** **(** :ref:`Vector2Array` vertices **)** +- void **set_vertices** **(** :ref:`PoolVector2Array` vertices **)** diff --git a/classes/class_navigationpolygoninstance.rst b/classes/class_navigationpolygoninstance.rst index 20e2d026a..e8ae09f72 100644 --- a/classes/class_navigationpolygoninstance.rst +++ b/classes/class_navigationpolygoninstance.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_navigation_polygon` **(** :ref:`NavigationPolygon` navpoly **)** | +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`bool` **enabled** +- :ref:`NavigationPolygon` **navpoly** + Member Function Description --------------------------- diff --git a/classes/class_nil.rst b/classes/class_nil.rst index c5f8ba806..6081f9dd0 100644 --- a/classes/class_nil.rst +++ b/classes/class_nil.rst @@ -16,94 +16,94 @@ Brief Description Member Functions ---------------- -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`ColorArray` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Vector3Array` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Vector2Array` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`StringArray` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`RealArray` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`IntArray` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`RawArray` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Array` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Dictionary` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`InputEvent` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Object` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`RID` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`NodePath` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Image` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Color` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Transform` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Matrix3` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`AABB` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Quat` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Plane` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Matrix32` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Vector3` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Rect2` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Vector2` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`String` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`float` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`int` from **)** | -+-------+--------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`bool` from **)** | -+-------+--------------------------------------------------------------------------------------+ ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolColorArray` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolVector3Array` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolVector2Array` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolStringArray` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolRealArray` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolIntArray` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolByteArray` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Array` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Dictionary` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`InputEvent` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Object` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`RID` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`NodePath` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Image` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Color` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Transform` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Basis` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Rect3` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Quat` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Plane` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Transform2D` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Vector3` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Rect2` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Vector2` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`String` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`float` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`int` from **)** | ++-------+----------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`bool` from **)** | ++-------+----------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_Nil_Nil: -- void **Nil** **(** :ref:`ColorArray` from **)** +- void **Nil** **(** :ref:`PoolColorArray` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Vector3Array` from **)** +- void **Nil** **(** :ref:`PoolVector3Array` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Vector2Array` from **)** +- void **Nil** **(** :ref:`PoolVector2Array` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`StringArray` from **)** +- void **Nil** **(** :ref:`PoolStringArray` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`RealArray` from **)** +- void **Nil** **(** :ref:`PoolRealArray` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`IntArray` from **)** +- void **Nil** **(** :ref:`PoolIntArray` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`RawArray` from **)** +- void **Nil** **(** :ref:`PoolByteArray` from **)** .. _class_Nil_Nil: @@ -143,11 +143,11 @@ Member Function Description .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Matrix3` from **)** +- void **Nil** **(** :ref:`Basis` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`AABB` from **)** +- void **Nil** **(** :ref:`Rect3` from **)** .. _class_Nil_Nil: @@ -159,7 +159,7 @@ Member Function Description .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Matrix32` from **)** +- void **Nil** **(** :ref:`Transform2D` from **)** .. _class_Nil_Nil: diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst new file mode 100644 index 000000000..db80dc2a2 --- /dev/null +++ b/classes/class_ninepatchrect.rst @@ -0,0 +1,90 @@ +.. 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_NinePatchRect: + +NinePatchRect +============= + +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_draw_center` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_patch_margin` **(** :ref:`int` margin **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_texture` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_center` **(** :ref:`bool` draw_center **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_patch_margin` **(** :ref:`int` margin, :ref:`int` value **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_region_rect` **(** :ref:`Rect2` rect **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Object` texture **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +- **texture_changed** **(** **)** + +Member Variables +---------------- + +- :ref:`bool` **draw_center** +- :ref:`int` **patch_margin_bottom** +- :ref:`int` **patch_margin_left** +- :ref:`int` **patch_margin_right** +- :ref:`int` **patch_margin_top** +- :ref:`Rect2` **region_rect** +- :ref:`Texture` **texture** + +Member Function Description +--------------------------- + +.. _class_NinePatchRect_get_draw_center: + +- :ref:`bool` **get_draw_center** **(** **)** const + +.. _class_NinePatchRect_get_patch_margin: + +- :ref:`int` **get_patch_margin** **(** :ref:`int` margin **)** const + +.. _class_NinePatchRect_get_region_rect: + +- :ref:`Rect2` **get_region_rect** **(** **)** const + +.. _class_NinePatchRect_get_texture: + +- :ref:`Object` **get_texture** **(** **)** const + +.. _class_NinePatchRect_set_draw_center: + +- void **set_draw_center** **(** :ref:`bool` draw_center **)** + +.. _class_NinePatchRect_set_patch_margin: + +- void **set_patch_margin** **(** :ref:`int` margin, :ref:`int` value **)** + +.. _class_NinePatchRect_set_region_rect: + +- void **set_region_rect** **(** :ref:`Rect2` rect **)** + +.. _class_NinePatchRect_set_texture: + +- void **set_texture** **(** :ref:`Object` texture **)** + + diff --git a/classes/class_node.rst b/classes/class_node.rst index 9f97cbc2d..eb457e2e4 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -8,7 +8,7 @@ Node **Inherits:** :ref:`Object` -**Inherited By:** :ref:`Viewport`, :ref:`Timer`, :ref:`CanvasLayer`, :ref:`EventPlayer`, :ref:`SoundRoomParams`, :ref:`Tween`, :ref:`Spatial`, :ref:`AnimationPlayer`, :ref:`EditorFileSystem`, :ref:`EditorPlugin`, :ref:`ResourcePreloader`, :ref:`AnimationTreePlayer`, :ref:`SamplePlayer`, :ref:`InstancePlaceholder`, :ref:`HTTPRequest`, :ref:`StreamPlayer`, :ref:`EditorResourcePreview`, :ref:`CanvasItem` +**Inherited By:** :ref:`Viewport`, :ref:`Timer`, :ref:`CanvasLayer`, :ref:`Tween`, :ref:`Spatial`, :ref:`AnimationPlayer`, :ref:`EditorFileSystem`, :ref:`EditorPlugin`, :ref:`ResourcePreloader`, :ref:`AnimationTreePlayer`, :ref:`InstancePlaceholder`, :ref:`HTTPRequest`, :ref:`EditorResourcePreview`, :ref:`CanvasItem`, :ref:`AudioPlayer` **Category:** Core @@ -43,7 +43,7 @@ Member Functions +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_process` **(** **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`duplicate` **(** :ref:`bool` use_instancing=false **)** const | +| :ref:`Node` | :ref:`duplicate` **(** :ref:`int` flags=15 **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -99,6 +99,8 @@ Member Functions +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_fixed_processing` **(** **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fixed_processing_internal` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_in_group` **(** :ref:`String` group **)** const | @@ -111,6 +113,8 @@ Member Functions +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_processing_input` **(** **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_internal` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** const | @@ -135,6 +139,8 @@ Member Functions +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`request_ready` **(** **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rpc` **(** :ref:`String` method **)** vararg | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rpc_config` **(** :ref:`String` method, :ref:`int` mode **)** | @@ -161,6 +167,8 @@ Member Functions +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_fixed_process` **(** :ref:`bool` enable **)** | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fixed_process_internal` **(** :ref:`bool` enable **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_name` **(** :ref:`String` name **)** | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_network_mode` **(** :ref:`int` mode **)** | @@ -173,6 +181,8 @@ Member Functions +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_process_input` **(** :ref:`bool` enable **)** | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_internal` **(** :ref:`bool` enable **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_process_unhandled_input` **(** :ref:`bool` enable **)** | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_process_unhandled_key_input` **(** :ref:`bool` enable **)** | @@ -183,9 +193,16 @@ Member Functions Signals ------- -- **enter_tree** **(** **)** -- **exit_tree** **(** **)** - **renamed** **(** **)** +- **tree_entered** **(** **)** +- **tree_exited** **(** **)** + +Member Variables +---------------- + +- :ref:`NodePath` **_import_path** +- :ref:`bool` **editor/display_folded** +- :ref:`int` **pause_mode** Numeric Constants ----------------- @@ -204,6 +221,9 @@ Numeric Constants - **NOTIFICATION_DRAG_BEGIN** = **21** - **NOTIFICATION_DRAG_END** = **22** - **NOTIFICATION_PATH_CHANGED** = **23** +- **NOTIFICATION_TRANSLATION_CHANGED** = **24** +- **NOTIFICATION_INTERNAL_PROCESS** = **25** +- **NOTIFICATION_INTERNAL_FIXED_PROCESS** = **26** - **NETWORK_MODE_INHERIT** = **0** - **NETWORK_MODE_MASTER** = **1** - **NETWORK_MODE_SLAVE** = **2** @@ -215,6 +235,10 @@ Numeric Constants - **PAUSE_MODE_INHERIT** = **0** - **PAUSE_MODE_STOP** = **1** - **PAUSE_MODE_PROCESS** = **2** +- **DUPLICATE_SIGNALS** = **1** +- **DUPLICATE_GROUPS** = **2** +- **DUPLICATE_SCRIPTS** = **4** +- **DUPLICATE_USE_INSTANCING** = **8** Description ----------- @@ -332,9 +356,11 @@ Return true if the node can process, i.e. whether its pause mode allows processi .. _class_Node_duplicate: -- :ref:`Node` **duplicate** **(** :ref:`bool` use_instancing=false **)** const +- :ref:`Node` **duplicate** **(** :ref:`int` flags=15 **)** const -Duplicate the node, returning a new :ref:`Node`. If ``use_instancing`` is true, the duplicated node will be a new instance of the original :ref:`PackedScene`, if not it will be an independent node. The duplicated node has the same group assignments and signals as the original one. +Duplicate the node, returning a new :ref:`Node`. + +You can fine-tune the behavior using the ``flags``, which are based on the DUPLICATE\_\* constants. .. _class_Node_find_node: @@ -502,6 +528,10 @@ Return *true* if the "node" argument is a direct or indirect child of the curren Return true if fixed processing is enabled (see :ref:`set_fixed_process`). +.. _class_Node_is_fixed_processing_internal: + +- :ref:`bool` **is_fixed_processing_internal** **(** **)** const + .. _class_Node_is_greater_than: - :ref:`bool` **is_greater_than** **(** :ref:`Node` node **)** const @@ -532,6 +562,10 @@ Return whether processing is enabled in the current node (see :ref:`set_process< Return true if the node is processing input (see :ref:`set_process_input`). +.. _class_Node_is_processing_internal: + +- :ref:`bool` **is_processing_internal** **(** **)** const + .. _class_Node_is_processing_unhandled_input: - :ref:`bool` **is_processing_unhandled_input** **(** **)** const @@ -598,6 +632,10 @@ Remove a node from a group. Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost. +.. _class_Node_request_ready: + +- void **request_ready** **(** **)** + .. _class_Node_rpc: - void **rpc** **(** :ref:`String` method **)** vararg @@ -674,6 +712,10 @@ A node can contain a filename. This filename should not be changed by the user, Enables or disables node fixed framerate processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS at a fixed (usually 60 fps, check :ref:`OS` to change that) interval (and the :ref:`_fixed_process` callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling :ref:`get_fixed_process_delta_time`. +.. _class_Node_set_fixed_process_internal: + +- void **set_fixed_process_internal** **(** :ref:`bool` enable **)** + .. _class_Node_set_name: - void **set_name** **(** :ref:`String` name **)** @@ -708,6 +750,10 @@ Enables or disables node processing. When a node is being processed, it will rec Enable input processing for node. This is not required for GUI controls! It hooks up the node to receive all input (see :ref:`_input`). +.. _class_Node_set_process_internal: + +- void **set_process_internal** **(** :ref:`bool` enable **)** + .. _class_Node_set_process_unhandled_input: - void **set_process_unhandled_input** **(** :ref:`bool` enable **)** diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 48088c741..53844fd8c 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -8,7 +8,7 @@ Node2D **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`RemoteTransform2D`, :ref:`Joint2D`, :ref:`ParticleAttractor2D`, :ref:`CollisionObject2D`, :ref:`VisibilityNotifier2D`, :ref:`TileMap`, :ref:`Navigation2D`, :ref:`CollisionPolygon2D`, :ref:`TouchScreenButton`, :ref:`Particles2D`, :ref:`AnimatedSprite`, :ref:`Light2D`, :ref:`SoundPlayer2D`, :ref:`ViewportSprite`, :ref:`Path2D`, :ref:`Sprite`, :ref:`RayCast2D`, :ref:`CollisionShape2D`, :ref:`NavigationPolygonInstance`, :ref:`PathFollow2D`, :ref:`ParallaxLayer`, :ref:`Polygon2D`, :ref:`Position2D`, :ref:`LightOccluder2D`, :ref:`BackBufferCopy`, :ref:`CanvasModulate`, :ref:`YSort`, :ref:`Camera2D` +**Inherited By:** :ref:`RemoteTransform2D`, :ref:`Joint2D`, :ref:`ParticleAttractor2D`, :ref:`ParallaxLayer`, :ref:`Line2D`, :ref:`VisibilityNotifier2D`, :ref:`Navigation2D`, :ref:`CollisionPolygon2D`, :ref:`TouchScreenButton`, :ref:`Particles2D`, :ref:`AnimatedSprite`, :ref:`Light2D`, :ref:`Path2D`, :ref:`Sprite`, :ref:`RayCast2D`, :ref:`CollisionShape2D`, :ref:`NavigationPolygonInstance`, :ref:`PathFollow2D`, :ref:`Polygon2D`, :ref:`Position2D`, :ref:`LightOccluder2D`, :ref:`CollisionObject2D`, :ref:`BackBufferCopy`, :ref:`CanvasModulate`, :ref:`YSort`, :ref:`TileMap`, :ref:`Camera2D` **Category:** Core @@ -20,76 +20,92 @@ Base node for 2D system. Member Functions ---------------- -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_set_pivot` **(** :ref:`Vector2` pivot **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_angle_to` **(** :ref:`Vector2` point **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_pos` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_global_rot` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_global_rotd` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_scale` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_pos` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`get_relative_transform_to_parent` **(** :ref:`Object` parent **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rot` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotd` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_z` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_translate` **(** :ref:`Vector2` offset **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_z_relative` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`look_at` **(** :ref:`Vector2` point **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_local_x` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_local_y` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rotate` **(** :ref:`float` radians **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scale` **(** :ref:`Vector2` ratio **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_pos` **(** :ref:`Vector2` pos **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_rot` **(** :ref:`float` radians **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_rotd` **(** :ref:`float` degrees **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_scale` **(** :ref:`Vector2` scale **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_transform` **(** :ref:`Matrix32` xform **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pos` **(** :ref:`Vector2` pos **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rot` **(** :ref:`float` radians **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotd` **(** :ref:`float` degrees **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Matrix32` xform **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_z` **(** :ref:`int` z **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_z_as_relative` **(** :ref:`bool` enable **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`translate` **(** :ref:`Vector2` offset **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_set_pivot` **(** :ref:`Vector2` pivot **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_angle_to` **(** :ref:`Vector2` point **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_position` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_global_rotation` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_global_rotation_in_degrees` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_scale` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_position` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_relative_transform_to_parent` **(** :ref:`Object` parent **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation_in_degrees` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_z` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_translate` **(** :ref:`Vector2` offset **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_z_relative` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`look_at` **(** :ref:`Vector2` point **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_local_x` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_local_y` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rotate` **(** :ref:`float` radians **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scale` **(** :ref:`Vector2` ratio **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_position` **(** :ref:`Vector2` pos **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_rotation` **(** :ref:`float` radians **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_rotation_in_degrees` **(** :ref:`float` degrees **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_scale` **(** :ref:`Vector2` scale **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_transform` **(** :ref:`Transform2D` xform **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_position` **(** :ref:`Vector2` pos **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation_in_degrees` **(** :ref:`float` degrees **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform` **(** :ref:`Transform2D` xform **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_z` **(** :ref:`int` z **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_z_as_relative` **(** :ref:`bool` enable **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`translate` **(** :ref:`Vector2` offset **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **global_position** +- :ref:`float` **global_rotation** +- :ref:`float` **global_rotation_deg** +- :ref:`float` **global_scale** +- :ref:`Transform2D` **global_transform** +- :ref:`Vector2` **position** +- :ref:`float` **rotation** +- :ref:`float` **rotation_deg** +- :ref:`Vector2` **scale** +- :ref:`Transform2D` **transform** +- :ref:`int` **z** +- :ref:`bool` **z_as_relative** Description ----------- -Base node for 2D system. Node2D contains a position, rotation and scale, which is used to position and animate. It can alternatively be used with a custom 2D transform (:ref:`Matrix32`). A tree of Node2Ds allows complex hierarchies for animation and positioning. +Base node for 2D system. Node2D contains a position, rotation and scale, which is used to position and animate. It can alternatively be used with a custom 2D transform (:ref:`Transform2D`). A tree of Node2Ds allows complex hierarchies for animation and positioning. Member Function Description --------------------------- @@ -106,21 +122,21 @@ Set the pivot position of the 2D node to 'pivot' value. This method is implement Return the rotation angle in radians needed for the 2d node to point at 'point' position. -.. _class_Node2D_get_global_pos: +.. _class_Node2D_get_global_position: -- :ref:`Vector2` **get_global_pos** **(** **)** const +- :ref:`Vector2` **get_global_position** **(** **)** const Return the global position of the 2D node. -.. _class_Node2D_get_global_rot: +.. _class_Node2D_get_global_rotation: -- :ref:`float` **get_global_rot** **(** **)** const +- :ref:`float` **get_global_rotation** **(** **)** const Return the global rotation in radians of the 2D node. -.. _class_Node2D_get_global_rotd: +.. _class_Node2D_get_global_rotation_in_degrees: -- :ref:`float` **get_global_rotd** **(** **)** const +- :ref:`float` **get_global_rotation_in_degrees** **(** **)** const Return the global rotation in degrees of the 2D node. @@ -130,27 +146,29 @@ Return the global rotation in degrees of the 2D node. Return the global scale of the 2D node. -.. _class_Node2D_get_pos: +.. _class_Node2D_get_position: -- :ref:`Vector2` **get_pos** **(** **)** const +- :ref:`Vector2` **get_position** **(** **)** const Return the position of the 2D node. .. _class_Node2D_get_relative_transform_to_parent: -- :ref:`Matrix32` **get_relative_transform_to_parent** **(** :ref:`Object` parent **)** const +- :ref:`Transform2D` **get_relative_transform_to_parent** **(** :ref:`Object` parent **)** const -Return the transform :ref:`Matrix32` calculated relatively to the parent of this 2D node. +Return the transform :ref:`Transform2D` calculated relatively to the parent of this 2D node. -.. _class_Node2D_get_rot: +.. _class_Node2D_get_rotation: -- :ref:`float` **get_rot** **(** **)** const +- :ref:`float` **get_rotation** **(** **)** const -Return the rotation of the 2D node. +Return the rotation in radians of the 2D node. -.. _class_Node2D_get_rotd: +.. _class_Node2D_get_rotation_in_degrees: -- :ref:`float` **get_rotd** **(** **)** const +- :ref:`float` **get_rotation_in_degrees** **(** **)** const + +Return the rotation in degrees of the 2D node. .. _class_Node2D_get_scale: @@ -206,23 +224,23 @@ Apply a 'radians' rotation to the 2D node, starting from its current rotation. Apply the 'ratio' scale to the 2D node, according to its current scale value. -.. _class_Node2D_set_global_pos: +.. _class_Node2D_set_global_position: -- void **set_global_pos** **(** :ref:`Vector2` pos **)** +- void **set_global_position** **(** :ref:`Vector2` pos **)** -Set the global position of the 2D node to 'pos'. +Set the global position of the 2D node. -.. _class_Node2D_set_global_rot: +.. _class_Node2D_set_global_rotation: -- void **set_global_rot** **(** :ref:`float` radians **)** +- void **set_global_rotation** **(** :ref:`float` radians **)** -Set the global rotation in radians of the 2D node. +Set the global rotation in radians of the 2D node -.. _class_Node2D_set_global_rotd: +.. _class_Node2D_set_global_rotation_in_degrees: -- void **set_global_rotd** **(** :ref:`float` degrees **)** +- void **set_global_rotation_in_degrees** **(** :ref:`float` degrees **)** -Set the global rotation in degrees of the 2D node. +Set the global rotation in degrees of the 2D node .. _class_Node2D_set_global_scale: @@ -232,27 +250,27 @@ Set the global scale of the 2D node. .. _class_Node2D_set_global_transform: -- void **set_global_transform** **(** :ref:`Matrix32` xform **)** +- void **set_global_transform** **(** :ref:`Transform2D` xform **)** -Set the global transform :ref:`Matrix32` of the 2D node. +Set the global transform :ref:`Transform2D` of the 2D node. -.. _class_Node2D_set_pos: +.. _class_Node2D_set_position: -- void **set_pos** **(** :ref:`Vector2` pos **)** +- void **set_position** **(** :ref:`Vector2` pos **)** Set the position of the 2D node. -.. _class_Node2D_set_rot: +.. _class_Node2D_set_rotation: -- void **set_rot** **(** :ref:`float` radians **)** +- void **set_rotation** **(** :ref:`float` radians **)** -Set the rotation of the 2D node. +Set the rotation in radians of the 2D node. -.. _class_Node2D_set_rotd: +.. _class_Node2D_set_rotation_in_degrees: -- void **set_rotd** **(** :ref:`float` degrees **)** +- void **set_rotation_in_degrees** **(** :ref:`float` degrees **)** -Set the rotation of the 2D node. +Set the rotation in degrees of the 2D node. .. _class_Node2D_set_scale: @@ -262,9 +280,9 @@ Set the scale of the 2D node. .. _class_Node2D_set_transform: -- void **set_transform** **(** :ref:`Matrix32` xform **)** +- void **set_transform** **(** :ref:`Transform2D` xform **)** -Set the local transform :ref:`Matrix32` of the 2D node. +Set the local transform :ref:`Transform2D` of the 2D node. .. _class_Node2D_set_z: diff --git a/classes/class_object.rst b/classes/class_object.rst index dd2ca611d..9d4551e17 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -6,7 +6,7 @@ Object ====== -**Inherited By:** :ref:`Reference`, :ref:`Physics2DServer`, :ref:`Input`, :ref:`SpatialSound2DServer`, :ref:`Node`, :ref:`Geometry`, :ref:`TreeItem`, :ref:`PhysicsDirectSpaceState`, :ref:`Physics2DDirectSpaceState`, :ref:`MainLoop`, :ref:`InputMap`, :ref:`UndoRedo`, :ref:`PhysicsServer`, :ref:`ResourceSaver`, :ref:`Performance`, :ref:`PathRemap`, :ref:`ResourceLoader`, :ref:`AudioServer`, :ref:`SpatialSoundServer`, :ref:`VisualServer`, :ref:`IP`, :ref:`OS`, :ref:`Globals`, :ref:`PhysicsDirectBodyState`, :ref:`EditorSelection`, :ref:`Physics2DDirectBodyState`, :ref:`TranslationServer`, :ref:`EditorFileSystemDirectory` +**Inherited By:** :ref:`Reference`, :ref:`Physics2DServer`, :ref:`PhysicsDirectBodyState`, :ref:`Input`, :ref:`Node`, :ref:`Geometry`, :ref:`TreeItem`, :ref:`PhysicsDirectSpaceState`, :ref:`Engine`, :ref:`Physics2DDirectSpaceState`, :ref:`MainLoop`, :ref:`InputMap`, :ref:`UndoRedo`, :ref:`PhysicsServer`, :ref:`ResourceSaver`, :ref:`Performance`, :ref:`ResourceLoader`, :ref:`AudioServer`, :ref:`VisualServer`, :ref:`IP`, :ref:`ClassDB`, :ref:`OS`, :ref:`GlobalConfig`, :ref:`EditorSelection`, :ref:`Physics2DDirectBodyState`, :ref:`TranslationServer`, :ref:`EditorFileSystemDirectory` **Category:** Core @@ -18,87 +18,87 @@ Base class for all non built-in types. Member Functions ---------------- -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`XL_MESSAGE` **(** :ref:`String` message **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_get` **(** :ref:`String` property **)** virtual | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_init` **(** **)** virtual | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_notification` **(** :ref:`int` what **)** virtual | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_set` **(** :ref:`String` property, :ref:`Variant` value **)** virtual | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=Array() **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call` **(** :ref:`String` method **)** vararg | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`call_deferred` **(** :ref:`String` method **)** vararg | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`callv` **(** :ref:`String` method, :ref:`Array` arg_array **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_translate_messages` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`connect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=Array(), :ref:`int` flags=0 **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`emit_signal` **(** :ref:`String` signal **)** vararg | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free` **(** **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get` **(** :ref:`String` property **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_instance_ID` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_meta` **(** :ref:`String` name **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_meta_list` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_method_list` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_property_list` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Script` | :ref:`get_script` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_list` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_type` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_method` **(** :ref:`String` method **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`String` signal **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_blocking_signals` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_type` **(** :ref:`String` type **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notification` **(** :ref:`int` what, :ref:`bool` reversed=false **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`property_list_changed_notify` **(** **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`String` property, :ref:`Variant` value **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_block_signals` **(** :ref:`bool` enable **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_message_translation` **(** :ref:`bool` enable **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_meta` **(** :ref:`String` name, :ref:`Variant` value **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_script` **(** :ref:`Script` script **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tr` **(** :ref:`String` message **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`XL_MESSAGE` **(** :ref:`String` message **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_get` **(** :ref:`String` property **)** virtual | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_init` **(** **)** virtual | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_notification` **(** :ref:`int` what **)** virtual | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_set` **(** :ref:`String` property, :ref:`Variant` value **)** virtual | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=Array() **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call` **(** :ref:`String` method **)** vararg | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`call_deferred` **(** :ref:`String` method **)** vararg | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`callv` **(** :ref:`String` method, :ref:`Array` arg_array **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_translate_messages` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`connect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=Array(), :ref:`int` flags=0 **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`emit_signal` **(** :ref:`String` signal **)** vararg | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get` **(** :ref:`String` property **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_class` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_instance_ID` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_meta` **(** :ref:`String` name **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_meta_list` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_method_list` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_property_list` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Script` | :ref:`get_script` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_signal_list` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_method` **(** :ref:`String` method **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`String` signal **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_blocking_signals` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class` **(** :ref:`String` type **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`notification` **(** :ref:`int` what, :ref:`bool` reversed=false **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`property_list_changed_notify` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_block_signals` **(** :ref:`bool` enable **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_message_translation` **(** :ref:`bool` enable **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_meta` **(** :ref:`String` name, :ref:`Variant` value **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_script` **(** :ref:`Script` script **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`tr` **(** :ref:`String` message **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -210,10 +210,16 @@ Disconnect a signal from a method. .. _class_Object_get: -- void **get** **(** :ref:`String` property **)** const +- :ref:`Variant` **get** **(** :ref:`String` property **)** const Get a property from the object. +.. _class_Object_get_class: + +- :ref:`String` **get_class** **(** **)** const + +Return the class of the object as a string. + .. _class_Object_get_instance_ID: - :ref:`int` **get_instance_ID** **(** **)** const @@ -228,7 +234,7 @@ Return a metadata from the object. .. _class_Object_get_meta_list: -- :ref:`StringArray` **get_meta_list** **(** **)** const +- :ref:`PoolStringArray` **get_meta_list** **(** **)** const Return the list of metadata in the object. @@ -258,12 +264,6 @@ Return the object script (or null if it doesn't have one). Return the list of signals as an array of dictionaries. -.. _class_Object_get_type: - -- :ref:`String` **get_type** **(** **)** const - -Return the type of the object as a string. - .. _class_Object_has_meta: - :ref:`bool` **has_meta** **(** :ref:`String` name **)** const @@ -284,6 +284,12 @@ Return true if a metadata is found with the requested name. Return true if signal emission blocking is enabled. +.. _class_Object_is_class: + +- :ref:`bool` **is_class** **(** :ref:`String` type **)** const + +Check the class of the object against a string (including inheritance). + .. _class_Object_is_connected: - :ref:`bool` **is_connected** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const @@ -294,12 +300,6 @@ Return true if a connection exists for a given signal and target/method. - :ref:`bool` **is_queued_for_deletion** **(** **)** const -.. _class_Object_is_type: - -- :ref:`bool` **is_type** **(** :ref:`String` type **)** const - -Check the type of the object against a string (including inheritance). - .. _class_Object_notification: - void **notification** **(** :ref:`int` what, :ref:`bool` reversed=false **)** diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index 76ffd1c24..f6b89c7e7 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -18,19 +18,26 @@ Brief Description Member Functions ---------------- -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cull_mode` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`get_polygon` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_closed` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_closed` **(** :ref:`bool` closed **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cull_mode` **(** :ref:`int` cull_mode **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_polygon` **(** :ref:`Vector2Array` polygon **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cull_mode` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_polygon` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_closed` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_closed` **(** :ref:`bool` closed **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cull_mode` **(** :ref:`int` cull_mode **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`bool` **closed** +- :ref:`int` **cull_mode** +- :ref:`PoolVector2Array` **polygon** Numeric Constants ----------------- @@ -48,7 +55,7 @@ Member Function Description .. _class_OccluderPolygon2D_get_polygon: -- :ref:`Vector2Array` **get_polygon** **(** **)** const +- :ref:`PoolVector2Array` **get_polygon** **(** **)** const .. _class_OccluderPolygon2D_is_closed: @@ -64,6 +71,6 @@ Member Function Description .. _class_OccluderPolygon2D_set_polygon: -- void **set_polygon** **(** :ref:`Vector2Array` polygon **)** +- void **set_polygon** **(** :ref:`PoolVector2Array` polygon **)** diff --git a/classes/class_omnilight.rst b/classes/class_omnilight.rst index 15b4d9cb5..a3732fddf 100644 --- a/classes/class_omnilight.rst +++ b/classes/class_omnilight.rst @@ -15,8 +15,49 @@ Brief Description OmniDirectional Light, such as a light bulb or a candle. +Member Functions +---------------- + ++------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_detail` **(** **)** const | ++------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_mode` **(** **)** const | ++------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_detail` **(** :ref:`int` detail **)** | ++------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_mode` **(** :ref:`int` mode **)** | ++------------------------+--------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **omni_attenuation** +- :ref:`float` **omni_range** +- :ref:`int` **omni_shadow_detail** +- :ref:`int` **omni_shadow_mode** + Description ----------- An OmniDirectional light is a type of :ref:`Light` node that emits lights in all directions. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of :ref:`Light`. TODO: Image of an omnilight. +Member Function Description +--------------------------- + +.. _class_OmniLight_get_shadow_detail: + +- :ref:`int` **get_shadow_detail** **(** **)** const + +.. _class_OmniLight_get_shadow_mode: + +- :ref:`int` **get_shadow_mode** **(** **)** const + +.. _class_OmniLight_set_shadow_detail: + +- void **set_shadow_detail** **(** :ref:`int` detail **)** + +.. _class_OmniLight_set_shadow_mode: + +- void **set_shadow_mode** **(** :ref:`int` mode **)** + + diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index eecce8445..664570e42 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -65,6 +65,12 @@ Signals - **item_selected** **(** :ref:`int` ID **)** +Member Variables +---------------- + +- :ref:`Array` **items** +- :ref:`int` **selected** + Description ----------- diff --git a/classes/class_os.rst b/classes/class_os.rst index 928631133..9383b43e4 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -18,219 +18,197 @@ Operating System functions. Member Functions ---------------- -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`alert` **(** :ref:`String` text, :ref:`String` title="Alert!" **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_draw` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_use_threads` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`delay_msec` **(** :ref:`int` msec **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`delay_usec` **(** :ref:`int` usec **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`dump_memory_to_file` **(** :ref:`String` file **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`dump_resources_to_file` **(** :ref:`String` file **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`StringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=Array() **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_scancode_from_string` **(** :ref:`String` string **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_borderless_window` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_clipboard` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_cmdline_args` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_current_screen` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_custom_level` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_data_dir` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_date` **(** :ref:`bool` utc=false **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_datetime` **(** :ref:`bool` utc=false **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_datetime_from_unix_time` **(** :ref:`int` unix_time_val **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_dynamic_memory_usage` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_engine_version` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_environment` **(** :ref:`String` environment **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_executable_path` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frames_drawn` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_frames_per_second` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_fullscreen_mode_list` **(** :ref:`int` screen=0 **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_iterations_per_second` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_latin_keyboard_variant` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_locale` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_main_loop` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_model_name` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_process_ID` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_processor_count` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_scancode_string` **(** :ref:`int` code **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_screen_count` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_screen_dpi` **(** :ref:`int` screen=0 **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_screen_orientation` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_screen_position` **(** :ref:`int` screen=0 **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_screen_size` **(** :ref:`int` screen=0 **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_splash_tick_msec` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_static_memory_peak_usage` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_static_memory_usage` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_system_dir` **(** :ref:`int` dir **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_system_time_secs` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_target_fps` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_ticks_msec` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_time` **(** :ref:`bool` utc=false **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_time_scale` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_time_zone_info` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_unique_ID` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_unix_time` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_unix_time_from_datetime` **(** :ref:`Dictionary` datetime **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_video_mode_size` **(** :ref:`int` screen=0 **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_window_position` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_window_size` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_environment` **(** :ref:`String` environment **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_touchscreen_ui_hint` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_virtual_keyboard` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hide_virtual_keyboard` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_debug_build` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_in_low_processor_usage_mode` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_keep_screen_on` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ok_left_and_cancel_right` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_scancode_unicode` **(** :ref:`int` code **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_stdout_verbose` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_video_mode_fullscreen` **(** :ref:`int` screen=0 **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_video_mode_resizable` **(** :ref:`int` screen=0 **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_vsync_enabled` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_window_fullscreen` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_window_maximized` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_window_minimized` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_window_resizable` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`kill` **(** :ref:`int` pid **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`native_video_is_playing` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`native_video_pause` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`native_video_play` **(** :ref:`String` path, :ref:`float` volume, :ref:`String` audio_track, :ref:`String` subtitle_track **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`native_video_stop` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`native_video_unpause` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_all_resources` **(** :ref:`String` tofile="" **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_all_textures_by_size` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_resources_by_type` **(** :ref:`StringArray` types **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_resources_in_use` **(** :ref:`bool` short=false **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`request_attention` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_borderless_window` **(** :ref:`bool` borderless **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clipboard` **(** :ref:`String` clipboard **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_screen` **(** :ref:`int` screen **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`Image` icon **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_iterations_per_second` **(** :ref:`int` iterations_per_second **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_keep_screen_on` **(** :ref:`bool` enabled **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_low_processor_usage_mode` **(** :ref:`bool` enable **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_screen_orientation` **(** :ref:`int` orientation **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_target_fps` **(** :ref:`int` target_fps **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`set_thread_name` **(** :ref:`String` name **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_time_scale` **(** :ref:`float` time_scale **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_file_access_save_and_swap` **(** :ref:`bool` enabled **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_vsync` **(** :ref:`bool` enable **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_video_mode` **(** :ref:`Vector2` size, :ref:`bool` fullscreen, :ref:`bool` resizable, :ref:`int` screen=0 **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_fullscreen` **(** :ref:`bool` enabled **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_maximized` **(** :ref:`bool` enabled **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_minimized` **(** :ref:`bool` enabled **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_position` **(** :ref:`Vector2` position **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_resizable` **(** :ref:`bool` enabled **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_size` **(** :ref:`Vector2` size **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_title` **(** :ref:`String` title **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shell_open` **(** :ref:`String` uri **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show_virtual_keyboard` **(** :ref:`String` existing_text="" **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`alert` **(** :ref:`String` text, :ref:`String` title="Alert!" **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_draw` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_use_threads` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`delay_msec` **(** :ref:`int` msec **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`delay_usec` **(** :ref:`int` usec **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`dump_memory_to_file` **(** :ref:`String` file **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`dump_resources_to_file` **(** :ref:`String` file **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=Array() **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_scancode_from_string` **(** :ref:`String` string **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_borderless_window` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_clipboard` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_cmdline_args` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_current_screen` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_data_dir` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_date` **(** :ref:`bool` utc=false **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_datetime` **(** :ref:`bool` utc=false **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_datetime_from_unix_time` **(** :ref:`int` unix_time_val **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_dynamic_memory_usage` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_environment` **(** :ref:`String` environment **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_executable_path` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_exit_code` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_latin_keyboard_variant` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_locale` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_model_name` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_power_percent_left` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_power_seconds_left` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_power_state` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_process_ID` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_processor_count` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_scancode_string` **(** :ref:`int` code **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_screen_count` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_screen_dpi` **(** :ref:`int` screen=0 **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_screen_orientation` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_screen_position` **(** :ref:`int` screen=0 **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_screen_size` **(** :ref:`int` screen=0 **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_splash_tick_msec` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_static_memory_peak_usage` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_static_memory_usage` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_system_dir` **(** :ref:`int` dir **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_system_time_secs` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_ticks_msec` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_time` **(** :ref:`bool` utc=false **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_time_zone_info` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_unique_ID` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_unix_time` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_unix_time_from_datetime` **(** :ref:`Dictionary` datetime **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_window_position` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_window_size` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_environment` **(** :ref:`String` environment **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_touchscreen_ui_hint` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_virtual_keyboard` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hide_virtual_keyboard` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_debug_build` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_in_low_processor_usage_mode` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_keep_screen_on` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ok_left_and_cancel_right` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_scancode_unicode` **(** :ref:`int` code **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_stdout_verbose` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_vsync_enabled` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_window_fullscreen` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_window_maximized` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_window_minimized` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_window_resizable` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`kill` **(** :ref:`int` pid **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`native_video_is_playing` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`native_video_pause` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`native_video_play` **(** :ref:`String` path, :ref:`float` volume, :ref:`String` audio_track, :ref:`String` subtitle_track **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`native_video_stop` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`native_video_unpause` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_all_resources` **(** :ref:`String` tofile="" **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_all_textures_by_size` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_resources_by_type` **(** :ref:`PoolStringArray` types **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_resources_in_use` **(** :ref:`bool` short=false **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`request_attention` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_borderless_window` **(** :ref:`bool` borderless **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clipboard` **(** :ref:`String` clipboard **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_screen` **(** :ref:`int` screen **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_exit_code` **(** :ref:`int` code **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon` **(** :ref:`Image` icon **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_keep_screen_on` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_low_processor_usage_mode` **(** :ref:`bool` enable **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_screen_orientation` **(** :ref:`int` orientation **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`set_thread_name` **(** :ref:`String` name **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_file_access_save_and_swap` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_vsync` **(** :ref:`bool` enable **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_fullscreen` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_maximized` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_minimized` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_position` **(** :ref:`Vector2` position **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_resizable` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_size` **(** :ref:`Vector2` size **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_title` **(** :ref:`String` title **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shell_open` **(** :ref:`String` uri **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`show_virtual_keyboard` **(** :ref:`String` existing_text="" **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -269,6 +247,11 @@ Numeric Constants - **SYSTEM_DIR_MUSIC** = **5** - **SYSTEM_DIR_PICTURES** = **6** - **SYSTEM_DIR_RINGTONES** = **7** +- **POWERSTATE_UNKNOWN** = **0** +- **POWERSTATE_ON_BATTERY** = **1** +- **POWERSTATE_NO_BATTERY** = **2** +- **POWERSTATE_CHARGING** = **3** +- **POWERSTATE_CHARGED** = **4** Description ----------- @@ -328,7 +311,7 @@ At the end of the file is a statistic of all used Resource Types. .. _class_OS_execute: -- :ref:`int` **execute** **(** :ref:`String` path, :ref:`StringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=Array() **)** +- :ref:`int` **execute** **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=Array() **)** Execute the binary file in given path, optionally blocking until it returns. A process ID is returned. @@ -352,7 +335,7 @@ Get clipboard from the host OS. .. _class_OS_get_cmdline_args: -- :ref:`StringArray` **get_cmdline_args** **(** **)** +- :ref:`PoolStringArray` **get_cmdline_args** **(** **)** Return the commandline passed to the engine. @@ -362,12 +345,6 @@ Return the commandline passed to the engine. Returns the current screen index (0 padded). -.. _class_OS_get_custom_level: - -- :ref:`String` **get_custom_level** **(** **)** const - -Returns the value of the commandline argument "-level". - .. _class_OS_get_data_dir: - :ref:`String` **get_data_dir** **(** **)** const @@ -400,26 +377,6 @@ Dictionary Time values will be a union of values from :ref:`get_time` **get_engine_version** **(** **)** const - -Returns the current engine version information in a Dictionary. - - - -"major" - Holds the major version number as a String - -"minor" - Holds the minor version number as a String - -"patch" - Holds the patch version number as a String - -"status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String - -"revision" - Holds the revision (e.g. "custom-build") as a String - -"string" - major + minor + patch + status + revision in a single String - .. _class_OS_get_environment: - :ref:`String` **get_environment** **(** :ref:`String` environment **)** const @@ -432,29 +389,9 @@ Return an environment variable. Return the path to the current engine executable. -.. _class_OS_get_frames_drawn: +.. _class_OS_get_exit_code: -- :ref:`int` **get_frames_drawn** **(** **)** - -Return the total amount of frames drawn. - -.. _class_OS_get_frames_per_second: - -- :ref:`float` **get_frames_per_second** **(** **)** const - -Returns the frames per second of the running game. - -.. _class_OS_get_fullscreen_mode_list: - -- :ref:`Array` **get_fullscreen_mode_list** **(** :ref:`int` screen=0 **)** const - -Return the list of fullscreen modes. - -.. _class_OS_get_iterations_per_second: - -- :ref:`int` **get_iterations_per_second** **(** **)** const - -Return the amount of fixed iterations per second (for fixed process and physics). +- :ref:`int` **get_exit_code** **(** **)** const .. _class_OS_get_latin_keyboard_variant: @@ -470,12 +407,6 @@ Possible return values are: "QWERTY", "AZERTY", "QZERTY", "DVORAK", "NEO" or "ER Return the host OS locale. -.. _class_OS_get_main_loop: - -- :ref:`Object` **get_main_loop** **(** **)** const - -Return the main loop object (see :ref:`MainLoop`). - .. _class_OS_get_model_name: - :ref:`String` **get_model_name** **(** **)** const @@ -488,6 +419,18 @@ Returns the model name of the current device. Return the name of the host OS. Possible values are: "Android", "BlackBerry 10", "Flash", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "UWP", "X11" +.. _class_OS_get_power_percent_left: + +- :ref:`int` **get_power_percent_left** **(** **)** + +.. _class_OS_get_power_seconds_left: + +- :ref:`int` **get_power_seconds_left** **(** **)** + +.. _class_OS_get_power_state: + +- :ref:`int` **get_power_state** **(** **)** + .. _class_OS_get_process_ID: - :ref:`int` **get_process_ID** **(** **)** const @@ -572,10 +515,6 @@ Return the max amount of static memory used (only works in debug). - :ref:`int` **get_system_time_secs** **(** **)** const -.. _class_OS_get_target_fps: - -- :ref:`float` **get_target_fps** **(** **)** const - .. _class_OS_get_ticks_msec: - :ref:`int` **get_ticks_msec** **(** **)** const @@ -588,10 +527,6 @@ Return the amount of time passed in milliseconds since the engine started. Returns current time as a dictionary of keys: hour, minute, second -.. _class_OS_get_time_scale: - -- :ref:`float` **get_time_scale** **(** **)** - .. _class_OS_get_time_zone_info: - :ref:`Dictionary` **get_time_zone_info** **(** **)** const @@ -616,12 +551,6 @@ Get an epoch time value from a dictionary of time values. You can pass the output from :ref:`get_datetime_from_unix_time` directly into this function. Daylight savings time (dst), if present, is ignored. -.. _class_OS_get_video_mode_size: - -- :ref:`Vector2` **get_video_mode_size** **(** :ref:`int` screen=0 **)** const - -Return the current video mode size. - .. _class_OS_get_window_position: - :ref:`Vector2` **get_window_position** **(** **)** const @@ -686,18 +615,6 @@ Returns whether the screen is being kept on or not. Return true if the engine was executed with -v (verbose stdout). -.. _class_OS_is_video_mode_fullscreen: - -- :ref:`bool` **is_video_mode_fullscreen** **(** :ref:`int` screen=0 **)** const - -Return true if the current video mode is fullscreen. - -.. _class_OS_is_video_mode_resizable: - -- :ref:`bool` **is_video_mode_resizable** **(** :ref:`int` screen=0 **)** const - -Return true if the window is resizable. - .. _class_OS_is_vsync_enabled: - :ref:`bool` **is_vsync_enabled** **(** **)** const @@ -762,7 +679,7 @@ Kill a process ID (this method can be used to kill processes that were not spawn .. _class_OS_print_resources_by_type: -- void **print_resources_by_type** **(** :ref:`StringArray` types **)** +- void **print_resources_by_type** **(** :ref:`PoolStringArray` types **)** .. _class_OS_print_resources_in_use: @@ -788,16 +705,14 @@ Set clipboard to the OS. - void **set_current_screen** **(** :ref:`int` screen **)** +.. _class_OS_set_exit_code: + +- void **set_exit_code** **(** :ref:`int` code **)** + .. _class_OS_set_icon: - void **set_icon** **(** :ref:`Image` icon **)** -.. _class_OS_set_iterations_per_second: - -- void **set_iterations_per_second** **(** :ref:`int` iterations_per_second **)** - -Set the amount of fixed iterations per second (for fixed process and physics). - .. _class_OS_set_keep_screen_on: - void **set_keep_screen_on** **(** :ref:`bool` enabled **)** @@ -816,20 +731,10 @@ Set to true to enable the low cpu usage mode. In this mode, the screen only redr Sets the current screen orientation, the argument value must be one of the SCREEN_ORIENTATION constants in this class. -.. _class_OS_set_target_fps: - -- void **set_target_fps** **(** :ref:`int` target_fps **)** - .. _class_OS_set_thread_name: - :ref:`int` **set_thread_name** **(** :ref:`String` name **)** -.. _class_OS_set_time_scale: - -- void **set_time_scale** **(** :ref:`float` time_scale **)** - -Speeds up or slows down the physics by changing the delta variable. (delta \* time_scale) - .. _class_OS_set_use_file_access_save_and_swap: - void **set_use_file_access_save_and_swap** **(** :ref:`bool` enabled **)** @@ -838,12 +743,6 @@ Speeds up or slows down the physics by changing the delta variable. (delta \* ti - void **set_use_vsync** **(** :ref:`bool` enable **)** -.. _class_OS_set_video_mode: - -- void **set_video_mode** **(** :ref:`Vector2` size, :ref:`bool` fullscreen, :ref:`bool` resizable, :ref:`int` screen=0 **)** - -Change the video mode. - .. _class_OS_set_window_fullscreen: - void **set_window_fullscreen** **(** :ref:`bool` enabled **)** diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index a83ed9ecd..dcc2f70f1 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -24,6 +24,11 @@ Member Functions | :ref:`int` | :ref:`size` **(** **)** const | +------------------------+-----------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`PoolByteArray` **__data__** + Member Function Description --------------------------- diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index 90a360e5a..e8032feeb 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -18,15 +18,27 @@ Brief Description Member Functions ---------------- -+--------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_instance` **(** **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneState` | :ref:`get_state` **(** **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`instance` **(** :ref:`bool` gen_edit_state=false **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`pack` **(** :ref:`Node` path **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_instance` **(** **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`SceneState` | :ref:`get_state` **(** **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`instance` **(** :ref:`int` edit_state=false **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`pack` **(** :ref:`Node` path **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Dictionary` **_bundled** + +Numeric Constants +----------------- + +- **GEN_EDIT_STATE_DISABLED** = **0** +- **GEN_EDIT_STATE_INSTANCE** = **1** +- **GEN_EDIT_STATE_MAIN** = **2** Description ----------- @@ -46,7 +58,7 @@ Member Function Description .. _class_PackedScene_instance: -- :ref:`Node` **instance** **(** :ref:`bool` gen_edit_state=false **)** const +- :ref:`Node` **instance** **(** :ref:`int` edit_state=false **)** const .. _class_PackedScene_pack: diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index ea7713b90..0faa32d1d 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -20,19 +20,19 @@ Abstraction and base class for packet-based protocols. Member Functions ---------------- -+----------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_packet_count` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`get_packet` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------+ -| Error | :ref:`get_packet_error` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_var` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------+ -| Error | :ref:`put_packet` **(** :ref:`RawArray` buffer **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`put_var` **(** :ref:`Variant` var **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------+ ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_packet_count` **(** **)** const | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_packet` **(** **)** const | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`get_packet_error` **(** **)** const | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_var` **(** **)** const | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`put_packet` **(** :ref:`PoolByteArray` buffer **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`put_var` **(** :ref:`Variant` var **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -50,7 +50,7 @@ Return the number of packets currently available in the ring-buffer. .. _class_PacketPeer_get_packet: -- :ref:`RawArray` **get_packet** **(** **)** const +- :ref:`PoolByteArray` **get_packet** **(** **)** const Get a raw packet. @@ -68,7 +68,7 @@ Get a Variant. .. _class_PacketPeer_put_packet: -- Error **put_packet** **(** :ref:`RawArray` buffer **)** +- Error **put_packet** **(** :ref:`PoolByteArray` buffer **)** Send a raw packet. diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index 87d4e4d60..896c8647d 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -18,23 +18,21 @@ UDP packet peer. Member Functions ---------------- -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_packet_address` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_packet_ip` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_packet_port` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_listening` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`listen` **(** :ref:`int` port, :ref:`int` recv_buf_size=65536 **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`set_send_address` **(** :ref:`String` host, :ref:`int` port **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`wait` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_packet_ip` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_packet_port` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_listening` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`set_dest_address` **(** :ref:`String` host, :ref:`int` port **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`wait` **(** **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -50,12 +48,6 @@ Member Function Description Close the UDP socket the :ref:`PacketPeerUDP` is currently listening on. -.. _class_PacketPeerUDP_get_packet_address: - -- :ref:`int` **get_packet_address** **(** **)** const - -Return the address of the remote peer(as a 32bit integer) that sent the last packet(that was received with :ref:`get_packet` or :ref:`get_var`). - .. _class_PacketPeerUDP_get_packet_ip: - :ref:`String` **get_packet_ip** **(** **)** const @@ -76,13 +68,19 @@ Return whether this :ref:`PacketPeerUDP` is listening. .. _class_PacketPeerUDP_listen: -- Error **listen** **(** :ref:`int` port, :ref:`int` recv_buf_size=65536 **)** +- Error **listen** **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** -Make this :ref:`PacketPeerUDP` listen on the "port" with a buffer size "recv_buf_size". Listens on all available addresses. +Make this :ref:`PacketPeerUDP` listen on the "port" binding to "bind_address" with a buffer size "recv_buf_size". -.. _class_PacketPeerUDP_set_send_address: +If "bind_address" is set as "\*" (default), the peer will listen on all available addresses (both IPv4 and IPv6). -- :ref:`int` **set_send_address** **(** :ref:`String` host, :ref:`int` port **)** +If "bind_address" is set as "0.0.0.0" (for IPv4) or "::" (for IPv6), the peer will listen on all available addresses matching that IP type. + +If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc), the peer will only listen on the interface with that addresses (or fail if no interface with the given address exists). + +.. _class_PacketPeerUDP_set_dest_address: + +- :ref:`int` **set_dest_address** **(** :ref:`String` host, :ref:`int` port **)** Set the destination address and port for sending packets and variables, a hostname will be resolved using if valid. diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index 738265e09..d1a3c4a91 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -44,6 +44,16 @@ Member Functions | void | :ref:`set_scroll_offset` **(** :ref:`Vector2` ofs **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Vector2` **scroll_base_offset** +- :ref:`Vector2` **scroll_base_scale** +- :ref:`bool` **scroll_ignore_camera_zoom** +- :ref:`Vector2` **scroll_limit_begin** +- :ref:`Vector2` **scroll_limit_end** +- :ref:`Vector2` **scroll_offset** + Description ----------- diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index db7e3dd5b..81b44a74c 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -32,6 +32,13 @@ Member Functions | void | :ref:`set_motion_scale` **(** :ref:`Vector2` scale **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Vector2` **motion_mirroring** +- :ref:`Vector2` **motion_offset** +- :ref:`Vector2` **motion_scale** + Description ----------- diff --git a/classes/class_particleattractor2d.rst b/classes/class_particleattractor2d.rst index 8cc2b9b84..552ddd8b7 100644 --- a/classes/class_particleattractor2d.rst +++ b/classes/class_particleattractor2d.rst @@ -44,6 +44,16 @@ Member Functions | void | :ref:`set_radius` **(** :ref:`float` radius **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **absorption** +- :ref:`float` **disable_radius** +- :ref:`bool` **enabled** +- :ref:`float` **gravity** +- :ref:`NodePath` **particles_path** +- :ref:`float` **radius** + Member Function Description --------------------------- diff --git a/classes/class_particles.rst b/classes/class_particles.rst index 125bfcaa6..a27738ad0 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -13,99 +13,102 @@ Particles Brief Description ----------------- -Particle system 3D Node + Member Functions ---------------- -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_amount` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color_phase_color` **(** :ref:`int` phase **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_color_phase_pos` **(** :ref:`int` phase **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_color_phases` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_emission_base_velocity` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_emission_half_extents` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3Array` | :ref:`get_emission_points` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_emit_timeout` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gravity_normal` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_material` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_randomness` **(** :ref:`int` variable **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_variable` **(** :ref:`int` variable **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_visibility_aabb` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_height_from_velocity` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_emitting` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_local_coordinates` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_amount` **(** :ref:`int` amount **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color_phase_color` **(** :ref:`int` phase, :ref:`Color` color **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color_phase_pos` **(** :ref:`int` phase, :ref:`float` pos **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color_phases` **(** :ref:`int` count **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_base_velocity` **(** :ref:`Vector3` base_velocity **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_half_extents` **(** :ref:`Vector3` half_extents **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_points` **(** :ref:`Vector3Array` points **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emit_timeout` **(** :ref:`float` timeout **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emitting` **(** :ref:`bool` enabled **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_normal` **(** :ref:`Vector3` normal **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_height_from_velocity` **(** :ref:`bool` enable **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_randomness` **(** :ref:`int` variable, :ref:`float` randomness **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_local_coordinates` **(** :ref:`bool` enable **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable` **(** :ref:`int` variable, :ref:`float` value **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visibility_aabb` **(** :ref:`AABB` aabb **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_amount` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`get_custom_aabb` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_draw_order` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`get_draw_pass_mesh` **(** :ref:`int` pass **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_draw_passes` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_explosiveness_ratio` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_fixed_fps` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_fractional_delta` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lifetime` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pre_process_time` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_process_material` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_randomness_ratio` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_use_local_coordinates` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_emitting` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_amount` **(** :ref:`int` amount **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_aabb` **(** :ref:`Rect3` aabb **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_order` **(** :ref:`int` order **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_pass_mesh` **(** :ref:`int` pass, :ref:`Mesh` mesh **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_passes` **(** :ref:`int` passes **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emitting` **(** :ref:`bool` emitting **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_explosiveness_ratio` **(** :ref:`float` ratio **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fixed_fps` **(** :ref:`int` fps **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fractional_delta` **(** :ref:`bool` enable **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity` **(** :ref:`Vector3` accel_vec **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lifetime` **(** :ref:`float` secs **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pre_process_time` **(** :ref:`float` secs **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_material` **(** :ref:`Material` material **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_randomness_ratio` **(** :ref:`float` ratio **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_local_coordinates` **(** :ref:`bool` enable **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`int` **amount** +- :ref:`Rect3` **custom_aabb** +- :ref:`int` **draw_order** +- :ref:`Mesh` **draw_pass_1** +- :ref:`Mesh` **draw_pass_2** +- :ref:`Mesh` **draw_pass_3** +- :ref:`Mesh` **draw_pass_4** +- :ref:`int` **draw_passes** +- :ref:`bool` **emitting** +- :ref:`float` **explosiveness** +- :ref:`int` **fixed_fps** +- :ref:`bool` **fract_delta** +- :ref:`Vector3` **gravity** +- :ref:`float` **lifetime** +- :ref:`bool` **local_coords** +- :ref:`float` **preprocess** +- ParticlesMaterial,ShaderMaterial **process_material** +- :ref:`float` **randomness** Numeric Constants ----------------- -- **VAR_LIFETIME** = **0** -- **VAR_SPREAD** = **1** -- **VAR_GRAVITY** = **2** -- **VAR_LINEAR_VELOCITY** = **3** -- **VAR_ANGULAR_VELOCITY** = **4** -- **VAR_LINEAR_ACCELERATION** = **5** -- **VAR_DRAG** = **6** -- **VAR_TANGENTIAL_ACCELERATION** = **7** -- **VAR_INITIAL_SIZE** = **9** -- **VAR_FINAL_SIZE** = **10** -- **VAR_INITIAL_ANGLE** = **11** -- **VAR_HEIGHT** = **12** -- **VAR_HEIGHT_SPEED_SCALE** = **13** -- **VAR_MAX** = **14** - -Description ------------ - -Particles is a particle system 3D :ref:`Node` that is used to simulate several types of particle effects, such as explosions, rain, snow, fireflies, or other magical-like shinny sparkles. Particles are drawn using impostors, and given their dynamic behavior, the user must provide a visibility AABB (although helpers to create one automatically exist). +- **DRAW_ORDER_INDEX** = **0** +- **DRAW_ORDER_LIFETIME** = **1** +- **DRAW_ORDER_VIEW_DEPTH** = **2** +- **MAX_DRAW_PASSES** = **4** Member Function Description --------------------------- @@ -114,168 +117,120 @@ Member Function Description - :ref:`int` **get_amount** **(** **)** const -Return the total amount of particles in the system. +.. _class_Particles_get_custom_aabb: -.. _class_Particles_get_color_phase_color: +- :ref:`Rect3` **get_custom_aabb** **(** **)** const -- :ref:`Color` **get_color_phase_color** **(** :ref:`int` phase **)** const +.. _class_Particles_get_draw_order: -Return the color of a color phase. +- :ref:`int` **get_draw_order** **(** **)** const -.. _class_Particles_get_color_phase_pos: +.. _class_Particles_get_draw_pass_mesh: -- :ref:`float` **get_color_phase_pos** **(** :ref:`int` phase **)** const +- :ref:`Mesh` **get_draw_pass_mesh** **(** :ref:`int` pass **)** const -Return the position of a color phase (0 to 1). +.. _class_Particles_get_draw_passes: -.. _class_Particles_get_color_phases: +- :ref:`int` **get_draw_passes** **(** **)** const -- :ref:`int` **get_color_phases** **(** **)** const +.. _class_Particles_get_explosiveness_ratio: -.. _class_Particles_get_emission_base_velocity: +- :ref:`float` **get_explosiveness_ratio** **(** **)** const -- :ref:`Vector3` **get_emission_base_velocity** **(** **)** const +.. _class_Particles_get_fixed_fps: -.. _class_Particles_get_emission_half_extents: +- :ref:`int` **get_fixed_fps** **(** **)** const -- :ref:`Vector3` **get_emission_half_extents** **(** **)** const +.. _class_Particles_get_fractional_delta: -Return the half extents for the emission box. +- :ref:`bool` **get_fractional_delta** **(** **)** const -.. _class_Particles_get_emission_points: +.. _class_Particles_get_gravity: -- :ref:`Vector3Array` **get_emission_points** **(** **)** const +- :ref:`Vector3` **get_gravity** **(** **)** const -.. _class_Particles_get_emit_timeout: +.. _class_Particles_get_lifetime: -- :ref:`float` **get_emit_timeout** **(** **)** const +- :ref:`float` **get_lifetime** **(** **)** const -.. _class_Particles_get_gravity_normal: +.. _class_Particles_get_pre_process_time: -- :ref:`Vector3` **get_gravity_normal** **(** **)** const +- :ref:`float` **get_pre_process_time** **(** **)** const -Return the normal vector towards where gravity is pulling (by default, negative Y). +.. _class_Particles_get_process_material: -.. _class_Particles_get_material: +- :ref:`Material` **get_process_material** **(** **)** const -- :ref:`Material` **get_material** **(** **)** const +.. _class_Particles_get_randomness_ratio: -Return the material used to draw particles. +- :ref:`float` **get_randomness_ratio** **(** **)** const -.. _class_Particles_get_randomness: +.. _class_Particles_get_use_local_coordinates: -- :ref:`float` **get_randomness** **(** :ref:`int` variable **)** const - -Return the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted. - -.. _class_Particles_get_variable: - -- :ref:`float` **get_variable** **(** :ref:`int` variable **)** const - -Return a specific variable for the particle system (see VAR\_\* enum). - -.. _class_Particles_get_visibility_aabb: - -- :ref:`AABB` **get_visibility_aabb** **(** **)** const - -Return the current visibility AABB. - -.. _class_Particles_has_height_from_velocity: - -- :ref:`bool` **has_height_from_velocity** **(** **)** const +- :ref:`bool` **get_use_local_coordinates** **(** **)** const .. _class_Particles_is_emitting: - :ref:`bool` **is_emitting** **(** **)** const -Return the "emitting" property state (see :ref:`set_emitting`). - -.. _class_Particles_is_using_local_coordinates: - -- :ref:`bool` **is_using_local_coordinates** **(** **)** const - .. _class_Particles_set_amount: - void **set_amount** **(** :ref:`int` amount **)** -Set total amount of particles in the system. +.. _class_Particles_set_custom_aabb: -.. _class_Particles_set_color_phase_color: +- void **set_custom_aabb** **(** :ref:`Rect3` aabb **)** -- void **set_color_phase_color** **(** :ref:`int` phase, :ref:`Color` color **)** +.. _class_Particles_set_draw_order: -Set the color of a color phase. +- void **set_draw_order** **(** :ref:`int` order **)** -.. _class_Particles_set_color_phase_pos: +.. _class_Particles_set_draw_pass_mesh: -- void **set_color_phase_pos** **(** :ref:`int` phase, :ref:`float` pos **)** +- void **set_draw_pass_mesh** **(** :ref:`int` pass, :ref:`Mesh` mesh **)** -Set the position of a color phase (0 to 1). +.. _class_Particles_set_draw_passes: -.. _class_Particles_set_color_phases: - -- void **set_color_phases** **(** :ref:`int` count **)** - -.. _class_Particles_set_emission_base_velocity: - -- void **set_emission_base_velocity** **(** :ref:`Vector3` base_velocity **)** - -.. _class_Particles_set_emission_half_extents: - -- void **set_emission_half_extents** **(** :ref:`Vector3` half_extents **)** - -Set the half extents for the emission box. - -.. _class_Particles_set_emission_points: - -- void **set_emission_points** **(** :ref:`Vector3Array` points **)** - -.. _class_Particles_set_emit_timeout: - -- void **set_emit_timeout** **(** :ref:`float` timeout **)** +- void **set_draw_passes** **(** :ref:`int` passes **)** .. _class_Particles_set_emitting: -- void **set_emitting** **(** :ref:`bool` enabled **)** +- void **set_emitting** **(** :ref:`bool` emitting **)** -Set the "emitting" property state. When emitting, the particle system generates new particles at constant rate. +.. _class_Particles_set_explosiveness_ratio: -.. _class_Particles_set_gravity_normal: +- void **set_explosiveness_ratio** **(** :ref:`float` ratio **)** -- void **set_gravity_normal** **(** :ref:`Vector3` normal **)** +.. _class_Particles_set_fixed_fps: -Set the normal vector towards where gravity is pulling (by default, negative Y). +- void **set_fixed_fps** **(** :ref:`int` fps **)** -.. _class_Particles_set_height_from_velocity: +.. _class_Particles_set_fractional_delta: -- void **set_height_from_velocity** **(** :ref:`bool` enable **)** +- void **set_fractional_delta** **(** :ref:`bool` enable **)** -.. _class_Particles_set_material: +.. _class_Particles_set_gravity: -- void **set_material** **(** :ref:`Material` material **)** +- void **set_gravity** **(** :ref:`Vector3` accel_vec **)** -Set the material used to draw particles. +.. _class_Particles_set_lifetime: -.. _class_Particles_set_randomness: +- void **set_lifetime** **(** :ref:`float` secs **)** -- void **set_randomness** **(** :ref:`int` variable, :ref:`float` randomness **)** +.. _class_Particles_set_pre_process_time: -Set the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted. +- void **set_pre_process_time** **(** :ref:`float` secs **)** + +.. _class_Particles_set_process_material: + +- void **set_process_material** **(** :ref:`Material` material **)** + +.. _class_Particles_set_randomness_ratio: + +- void **set_randomness_ratio** **(** :ref:`float` ratio **)** .. _class_Particles_set_use_local_coordinates: - void **set_use_local_coordinates** **(** :ref:`bool` enable **)** -.. _class_Particles_set_variable: - -- void **set_variable** **(** :ref:`int` variable, :ref:`float` value **)** - -Set a specific variable for the particle system (see VAR\_\* enum). - -.. _class_Particles_set_visibility_aabb: - -- void **set_visibility_aabb** **(** :ref:`AABB` aabb **)** - -Set the visibility AABB for the particle system, since the default one will not work properly most of the time. - diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index 36d9383d0..26e7c4d85 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -18,107 +18,180 @@ Brief Description Member Functions ---------------- -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_amount` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color_phase_color` **(** :ref:`int` phase **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_color_phase_pos` **(** :ref:`int` phase **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_color_phases` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ColorRamp` | :ref:`get_color_ramp` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_emission_half_extents` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`get_emission_points` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_emissor_offset` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_emit_timeout` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_explosiveness` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_h_frames` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_initial_velocity` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lifetime` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pre_process_time` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_randomness` **(** :ref:`int` param **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_time_scale` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_v_frames` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_emitting` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flipped_h` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flipped_v` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_local_space` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pre_process` **(** :ref:`float` time **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reset` **(** **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_amount` **(** :ref:`int` amount **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color_phase_color` **(** :ref:`int` phase, :ref:`Color` color **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color_phase_pos` **(** :ref:`int` phase, :ref:`float` pos **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color_phases` **(** :ref:`int` phases **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ColorRamp` | :ref:`set_color_ramp` **(** :ref:`Object` color_ramp **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_half_extents` **(** :ref:`Vector2` extents **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_points` **(** :ref:`Vector2Array` points **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emissor_offset` **(** :ref:`Vector2` offset **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emit_timeout` **(** :ref:`float` value **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emitting` **(** :ref:`bool` active **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_explosiveness` **(** :ref:`float` amount **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flip_h` **(** :ref:`bool` enable **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flip_v` **(** :ref:`bool` enable **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_frames` **(** :ref:`int` enable **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_initial_velocity` **(** :ref:`Vector2` velocity **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lifetime` **(** :ref:`float` lifetime **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pre_process_time` **(** :ref:`float` time **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_randomness` **(** :ref:`int` param, :ref:`float` value **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`set_texture` **(** :ref:`Object` texture **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_time_scale` **(** :ref:`float` time_scale **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_local_space` **(** :ref:`bool` enable **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_frames` **(** :ref:`int` enable **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_amount` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color_phase_color` **(** :ref:`int` phase **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_color_phase_pos` **(** :ref:`int` phase **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_color_phases` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ColorRamp` | :ref:`get_color_ramp` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_emission_half_extents` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_emission_points` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_emissor_offset` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_emit_timeout` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_explosiveness` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_h_frames` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_initial_velocity` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lifetime` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pre_process_time` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_process_mode` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_randomness` **(** :ref:`int` param **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_time_scale` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_v_frames` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_emitting` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_flipped_h` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_flipped_v` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_local_space` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`pre_process` **(** :ref:`float` time **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reset` **(** **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_amount` **(** :ref:`int` amount **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`Color` color **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color_phase_color` **(** :ref:`int` phase, :ref:`Color` color **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color_phase_pos` **(** :ref:`int` phase, :ref:`float` pos **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color_phases` **(** :ref:`int` phases **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ColorRamp` | :ref:`set_color_ramp` **(** :ref:`Object` color_ramp **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_half_extents` **(** :ref:`Vector2` extents **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_points` **(** :ref:`PoolVector2Array` points **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emissor_offset` **(** :ref:`Vector2` offset **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emit_timeout` **(** :ref:`float` value **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emitting` **(** :ref:`bool` active **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_explosiveness` **(** :ref:`float` amount **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flip_h` **(** :ref:`bool` enable **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flip_v` **(** :ref:`bool` enable **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_frames` **(** :ref:`int` enable **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_initial_velocity` **(** :ref:`Vector2` velocity **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lifetime` **(** :ref:`float` lifetime **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pre_process_time` **(** :ref:`float` time **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_mode` **(** :ref:`int` mode **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_randomness` **(** :ref:`int` param, :ref:`float` value **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`set_texture` **(** :ref:`Object` texture **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_time_scale` **(** :ref:`float` time_scale **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_local_space` **(** :ref:`bool` enable **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_frames` **(** :ref:`int` enable **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +- **emission_finished** **(** **)** + +Member Variables +---------------- + +- :ref:`Color` **color/color** +- :ref:`ColorRamp` **color/color_ramp** +- :ref:`int` **color_phases/count** +- :ref:`int` **config/amount** +- :ref:`float` **config/emit_timeout** +- :ref:`bool` **config/emitting** +- :ref:`float` **config/explosiveness** +- :ref:`bool` **config/flip_h** +- :ref:`bool` **config/flip_v** +- :ref:`int` **config/h_frames** +- :ref:`Vector2` **config/half_extents** +- :ref:`float` **config/lifetime** +- :ref:`bool` **config/local_space** +- :ref:`Vector2` **config/offset** +- :ref:`float` **config/preprocess** +- :ref:`int` **config/process_mode** +- :ref:`Texture` **config/texture** +- :ref:`float` **config/time_scale** +- :ref:`int` **config/v_frames** +- :ref:`PoolVector2Array` **emission_points** +- :ref:`float` **params/anim_initial_pos** +- :ref:`float` **params/anim_speed_scale** +- :ref:`float` **params/damping** +- :ref:`float` **params/direction** +- :ref:`float` **params/final_size** +- :ref:`float` **params/gravity_direction** +- :ref:`float` **params/gravity_strength** +- :ref:`float` **params/hue_variation** +- :ref:`float` **params/initial_angle** +- :ref:`float` **params/initial_size** +- :ref:`float` **params/linear_velocity** +- :ref:`float` **params/orbit_velocity** +- :ref:`float` **params/radial_accel** +- :ref:`float` **params/spin_velocity** +- :ref:`float` **params/spread** +- :ref:`float` **params/tangential_accel** +- :ref:`Color` **phase_0/color** +- :ref:`float` **phase_0/pos** +- :ref:`Color` **phase_1/color** +- :ref:`float` **phase_1/pos** +- :ref:`Color` **phase_2/color** +- :ref:`float` **phase_2/pos** +- :ref:`Color` **phase_3/color** +- :ref:`float` **phase_3/pos** +- :ref:`float` **randomness/anim_initial_pos** +- :ref:`float` **randomness/anim_speed_scale** +- :ref:`float` **randomness/damping** +- :ref:`float` **randomness/direction** +- :ref:`float` **randomness/final_size** +- :ref:`float` **randomness/gravity_direction** +- :ref:`float` **randomness/gravity_strength** +- :ref:`float` **randomness/hue_variation** +- :ref:`float` **randomness/initial_angle** +- :ref:`float` **randomness/initial_size** +- :ref:`float` **randomness/linear_velocity** +- :ref:`float` **randomness/orbit_velocity** +- :ref:`float` **randomness/radial_accel** +- :ref:`float` **randomness/spin_velocity** +- :ref:`float` **randomness/spread** +- :ref:`float` **randomness/tangential_accel** Numeric Constants ----------------- @@ -145,7 +218,7 @@ Numeric Constants Description ----------- -Particles2D is a particle system 2D :ref:`Node` that is used to simulate several types of particle effects, such as explosions, rain, snow, fireflies, or other magical-like shinny sparkles. Particles are drawn using impostors, and given their dynamic behavior, the user must provide a visibility AABB (although helpers to create one automatically exist). +Particles2D is a particle system 2D :ref:`Node` that is used to simulate several types of particle effects, such as explosions, rain, snow, fireflies, or other magical-like shinny sparkles. Particles are drawn using impostors, and given their dynamic behavior, the user must provide a visibility bounding box (although helpers to create one automatically exist). Member Function Description --------------------------- @@ -188,7 +261,7 @@ Returns the half extents of the emission box. .. _class_Particles2D_get_emission_points: -- :ref:`Vector2Array` **get_emission_points** **(** **)** const +- :ref:`PoolVector2Array` **get_emission_points** **(** **)** const .. _class_Particles2D_get_emissor_offset: @@ -230,6 +303,10 @@ Returns the value of the specified emitter parameter - :ref:`float` **get_pre_process_time** **(** **)** const +.. _class_Particles2D_get_process_mode: + +- :ref:`int` **get_process_mode** **(** **)** const + .. _class_Particles2D_get_randomness: - :ref:`float` **get_randomness** **(** :ref:`int` param **)** const @@ -316,7 +393,7 @@ Sets the half extents of the emission box, particles will be spawned at random i .. _class_Particles2D_set_emission_points: -- void **set_emission_points** **(** :ref:`Vector2Array` points **)** +- void **set_emission_points** **(** :ref:`PoolVector2Array` points **)** .. _class_Particles2D_set_emissor_offset: @@ -372,11 +449,15 @@ Sets the value of the specified emitter parameter (see the constants secction fo - void **set_pre_process_time** **(** :ref:`float` time **)** +.. _class_Particles2D_set_process_mode: + +- void **set_process_mode** **(** :ref:`int` mode **)** + .. _class_Particles2D_set_randomness: - void **set_randomness** **(** :ref:`int` param, :ref:`float` value **)** -Sets the randomness value of the specified emitter parameter (see the constants secction for the list of parameters), 0 means no randomness, so every particle will have the parameters specified, 1 means that the parameter will be choosen at random, the closer the randomness value gets to 0 the more conservative the variation of the parameter will be. +Sets the randomness value of the specified emitter parameter (see the constants secction for the list of parameters), 0 means no randomness, so every particle will have the parameters specified, 1 means that the parameter will be chosen at random, the closer the randomness value gets to 0 the more conservative the variation of the parameter will be. .. _class_Particles2D_set_texture: diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst new file mode 100644 index 000000000..a5f38e5d9 --- /dev/null +++ b/classes/class_particlesmaterial.rst @@ -0,0 +1,309 @@ +.. 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_ParticlesMaterial: + +ParticlesMaterial +================= + +**Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_color_ramp` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_emission_box_extents` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_emission_normal_texture` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_emission_point_count` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_emission_point_texture` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_emission_shape` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_emission_sphere_radius` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_flag` **(** :ref:`int` flag **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_flatness` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_param_randomness` **(** :ref:`int` param **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_param_texture` **(** :ref:`int` param **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_spread` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`GradientTexture` | :ref:`get_trail_color_modifier` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_trail_divisor` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`CurveTexture` | :ref:`get_trail_size_modifier` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`Color` color **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color_ramp` **(** :ref:`Texture` ramp **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_box_extents` **(** :ref:`Vector3` extents **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_normal_texture` **(** :ref:`Texture` texture **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_point_count` **(** :ref:`int` point_count **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_point_texture` **(** :ref:`Texture` texture **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_shape` **(** :ref:`int` shape **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_sphere_radius` **(** :ref:`float` radius **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` enable **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flatness` **(** :ref:`float` amount **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param_randomness` **(** :ref:`int` param, :ref:`float` randomness **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param_texture` **(** :ref:`int` param, :ref:`Object` texture **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_spread` **(** :ref:`float` degrees **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_trail_color_modifier` **(** :ref:`GradientTexture` texture **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_trail_divisor` **(** :ref:`int` divisor **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_trail_size_modifier` **(** :ref:`CurveTexture` texture **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **angle** +- :ref:`CurveTexture` **angle_curve** +- :ref:`float` **angle_random** +- :ref:`float` **angular_velocity** +- :ref:`CurveTexture` **angular_velocity_curve** +- :ref:`float` **angular_velocity_random** +- :ref:`float` **anim_offset** +- :ref:`CurveTexture` **anim_offset_curve** +- :ref:`float` **anim_offset_random** +- :ref:`float` **anim_speed** +- :ref:`CurveTexture` **anim_speed_curve** +- :ref:`float` **anim_speed_random** +- :ref:`Color` **color** +- :ref:`GradientTexture` **color_ramp** +- :ref:`float` **damping** +- :ref:`CurveTexture` **damping_curve** +- :ref:`float` **damping_random** +- :ref:`Vector3` **emission_box_extents** +- :ref:`Texture` **emission_normal_texture** +- :ref:`int` **emission_point_count** +- :ref:`Texture` **emission_point_texture** +- :ref:`int` **emission_shape** +- :ref:`float` **emission_sphere_radius** +- :ref:`bool` **flag_align_y** +- :ref:`bool` **flag_rotate_y** +- :ref:`float` **flatness** +- :ref:`float` **hue_variation** +- :ref:`CurveTexture` **hue_variation_curve** +- :ref:`float` **hue_variation_random** +- :ref:`float` **initial_velocity** +- :ref:`float` **initial_velocity_random** +- :ref:`float` **linear_accel** +- :ref:`CurveTexture` **linear_accel_curve** +- :ref:`float` **linear_accel_random** +- :ref:`float` **orbit_velocity** +- :ref:`CurveTexture` **orbit_velocity_curve** +- :ref:`float` **orbit_velocity_random** +- :ref:`float` **radial_accel** +- :ref:`CurveTexture` **radial_accel_curve** +- :ref:`float` **radial_accel_random** +- :ref:`float` **scale** +- :ref:`CurveTexture` **scale_curve** +- :ref:`float` **scale_random** +- :ref:`float` **spread** +- :ref:`float` **tangential_accel** +- :ref:`CurveTexture` **tangential_accel_curve** +- :ref:`float` **tangential_accel_random** +- :ref:`GradientTexture` **trail_color_modifier** +- :ref:`int` **trail_divisor** +- :ref:`CurveTexture` **trail_size_modifier** + +Numeric Constants +----------------- + +- **PARAM_INITIAL_LINEAR_VELOCITY** = **0** +- **PARAM_ANGULAR_VELOCITY** = **1** +- **PARAM_ORBIT_VELOCITY** = **2** +- **PARAM_LINEAR_ACCEL** = **3** +- **PARAM_RADIAL_ACCEL** = **4** +- **PARAM_TANGENTIAL_ACCEL** = **5** +- **PARAM_DAMPING** = **6** +- **PARAM_ANGLE** = **7** +- **PARAM_SCALE** = **8** +- **PARAM_HUE_VARIATION** = **9** +- **PARAM_ANIM_SPEED** = **10** +- **PARAM_ANIM_OFFSET** = **11** +- **PARAM_MAX** = **12** +- **FLAG_ALIGN_Y_TO_VELOCITY** = **0** +- **FLAG_ROTATE_Y** = **1** +- **FLAG_MAX** = **2** +- **EMISSION_SHAPE_POINT** = **0** +- **EMISSION_SHAPE_SPHERE** = **1** +- **EMISSION_SHAPE_BOX** = **2** +- **EMISSION_SHAPE_POINTS** = **3** +- **EMISSION_SHAPE_DIRECTED_POINTS** = **4** + +Member Function Description +--------------------------- + +.. _class_ParticlesMaterial_get_color: + +- :ref:`Color` **get_color** **(** **)** const + +.. _class_ParticlesMaterial_get_color_ramp: + +- :ref:`Texture` **get_color_ramp** **(** **)** const + +.. _class_ParticlesMaterial_get_emission_box_extents: + +- :ref:`Vector3` **get_emission_box_extents** **(** **)** const + +.. _class_ParticlesMaterial_get_emission_normal_texture: + +- :ref:`Texture` **get_emission_normal_texture** **(** **)** const + +.. _class_ParticlesMaterial_get_emission_point_count: + +- :ref:`int` **get_emission_point_count** **(** **)** const + +.. _class_ParticlesMaterial_get_emission_point_texture: + +- :ref:`Texture` **get_emission_point_texture** **(** **)** const + +.. _class_ParticlesMaterial_get_emission_shape: + +- :ref:`int` **get_emission_shape** **(** **)** const + +.. _class_ParticlesMaterial_get_emission_sphere_radius: + +- :ref:`float` **get_emission_sphere_radius** **(** **)** const + +.. _class_ParticlesMaterial_get_flag: + +- :ref:`bool` **get_flag** **(** :ref:`int` flag **)** const + +.. _class_ParticlesMaterial_get_flatness: + +- :ref:`float` **get_flatness** **(** **)** const + +.. _class_ParticlesMaterial_get_param: + +- :ref:`float` **get_param** **(** :ref:`int` param **)** const + +.. _class_ParticlesMaterial_get_param_randomness: + +- :ref:`float` **get_param_randomness** **(** :ref:`int` param **)** const + +.. _class_ParticlesMaterial_get_param_texture: + +- :ref:`Object` **get_param_texture** **(** :ref:`int` param **)** const + +.. _class_ParticlesMaterial_get_spread: + +- :ref:`float` **get_spread** **(** **)** const + +.. _class_ParticlesMaterial_get_trail_color_modifier: + +- :ref:`GradientTexture` **get_trail_color_modifier** **(** **)** const + +.. _class_ParticlesMaterial_get_trail_divisor: + +- :ref:`int` **get_trail_divisor** **(** **)** const + +.. _class_ParticlesMaterial_get_trail_size_modifier: + +- :ref:`CurveTexture` **get_trail_size_modifier** **(** **)** const + +.. _class_ParticlesMaterial_set_color: + +- void **set_color** **(** :ref:`Color` color **)** + +.. _class_ParticlesMaterial_set_color_ramp: + +- void **set_color_ramp** **(** :ref:`Texture` ramp **)** + +.. _class_ParticlesMaterial_set_emission_box_extents: + +- void **set_emission_box_extents** **(** :ref:`Vector3` extents **)** + +.. _class_ParticlesMaterial_set_emission_normal_texture: + +- void **set_emission_normal_texture** **(** :ref:`Texture` texture **)** + +.. _class_ParticlesMaterial_set_emission_point_count: + +- void **set_emission_point_count** **(** :ref:`int` point_count **)** + +.. _class_ParticlesMaterial_set_emission_point_texture: + +- void **set_emission_point_texture** **(** :ref:`Texture` texture **)** + +.. _class_ParticlesMaterial_set_emission_shape: + +- void **set_emission_shape** **(** :ref:`int` shape **)** + +.. _class_ParticlesMaterial_set_emission_sphere_radius: + +- void **set_emission_sphere_radius** **(** :ref:`float` radius **)** + +.. _class_ParticlesMaterial_set_flag: + +- void **set_flag** **(** :ref:`int` flag, :ref:`bool` enable **)** + +.. _class_ParticlesMaterial_set_flatness: + +- void **set_flatness** **(** :ref:`float` amount **)** + +.. _class_ParticlesMaterial_set_param: + +- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** + +.. _class_ParticlesMaterial_set_param_randomness: + +- void **set_param_randomness** **(** :ref:`int` param, :ref:`float` randomness **)** + +.. _class_ParticlesMaterial_set_param_texture: + +- void **set_param_texture** **(** :ref:`int` param, :ref:`Object` texture **)** + +.. _class_ParticlesMaterial_set_spread: + +- void **set_spread** **(** :ref:`float` degrees **)** + +.. _class_ParticlesMaterial_set_trail_color_modifier: + +- void **set_trail_color_modifier** **(** :ref:`GradientTexture` texture **)** + +.. _class_ParticlesMaterial_set_trail_divisor: + +- void **set_trail_divisor** **(** :ref:`int` divisor **)** + +.. _class_ParticlesMaterial_set_trail_size_modifier: + +- void **set_trail_size_modifier** **(** :ref:`CurveTexture` texture **)** + + diff --git a/classes/class_patch9frame.rst b/classes/class_patch9frame.rst deleted file mode 100644 index f78046ebc..000000000 --- a/classes/class_patch9frame.rst +++ /dev/null @@ -1,91 +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_Patch9Frame: - -Patch9Frame -=========== - -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - -Member Functions ----------------- - -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_draw_center` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_modulate` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_patch_margin` **(** :ref:`int` margin **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_texture` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_center` **(** :ref:`bool` draw_center **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_modulate` **(** :ref:`Color` modulate **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_patch_margin` **(** :ref:`int` margin, :ref:`int` value **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region_rect` **(** :ref:`Rect2` rect **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Object` texture **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - -Signals -------- - -- **texture_changed** **(** **)** - -Member Function Description ---------------------------- - -.. _class_Patch9Frame_get_draw_center: - -- :ref:`bool` **get_draw_center** **(** **)** const - -.. _class_Patch9Frame_get_modulate: - -- :ref:`Color` **get_modulate** **(** **)** const - -.. _class_Patch9Frame_get_patch_margin: - -- :ref:`int` **get_patch_margin** **(** :ref:`int` margin **)** const - -.. _class_Patch9Frame_get_region_rect: - -- :ref:`Rect2` **get_region_rect** **(** **)** const - -.. _class_Patch9Frame_get_texture: - -- :ref:`Object` **get_texture** **(** **)** const - -.. _class_Patch9Frame_set_draw_center: - -- void **set_draw_center** **(** :ref:`bool` draw_center **)** - -.. _class_Patch9Frame_set_modulate: - -- void **set_modulate** **(** :ref:`Color` modulate **)** - -.. _class_Patch9Frame_set_patch_margin: - -- void **set_patch_margin** **(** :ref:`int` margin, :ref:`int` value **)** - -.. _class_Patch9Frame_set_region_rect: - -- void **set_region_rect** **(** :ref:`Rect2` rect **)** - -.. _class_Patch9Frame_set_texture: - -- void **set_texture** **(** :ref:`Object` texture **)** - - diff --git a/classes/class_path.rst b/classes/class_path.rst index 6dced59aa..316ba5354 100644 --- a/classes/class_path.rst +++ b/classes/class_path.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_curve` **(** :ref:`Curve3D` curve **)** | +--------------------------------+------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Curve3D` **curve** + Description ----------- diff --git a/classes/class_path2d.rst b/classes/class_path2d.rst index 66f89a0bf..aec53f08f 100644 --- a/classes/class_path2d.rst +++ b/classes/class_path2d.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_curve` **(** :ref:`Curve2D` curve **)** | +--------------------------------+--------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Curve2D` **curve** + Description ----------- diff --git a/classes/class_pathremap.rst b/classes/class_pathremap.rst deleted file mode 100644 index 13b7e5615..000000000 --- a/classes/class_pathremap.rst +++ /dev/null @@ -1,71 +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_PathRemap: - -PathRemap -========= - -**Inherits:** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Singleton containing the list of remapped resources. - -Member Functions ----------------- - -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_remap` **(** :ref:`String` from, :ref:`String` to, :ref:`String` locale="" **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_remaps` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_remap` **(** :ref:`String` path **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_remap` **(** :ref:`String` path **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_remap` **(** :ref:`String` path **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Description ------------ - -When exporting, the types of some resources may change internally so they are converted to more optimized versions. While it's not usually necessary to access to this directly (path remapping happens automatically when opening a file), it's exported just for information. - -Member Function Description ---------------------------- - -.. _class_PathRemap_add_remap: - -- void **add_remap** **(** :ref:`String` from, :ref:`String` to, :ref:`String` locale="" **)** - -Add a remap from a file to another. - -.. _class_PathRemap_clear_remaps: - -- void **clear_remaps** **(** **)** - -Clear all remaps. - -.. _class_PathRemap_erase_remap: - -- void **erase_remap** **(** :ref:`String` path **)** - -Erase a remap. - -.. _class_PathRemap_get_remap: - -- :ref:`String` **get_remap** **(** :ref:`String` path **)** const - -Return the remapped new path of a file. - -.. _class_PathRemap_has_remap: - -- :ref:`bool` **has_remap** **(** :ref:`String` path **)** const - -Return true if a file is being remapped. - - diff --git a/classes/class_physics2ddirectbodystate.rst b/classes/class_physics2ddirectbodystate.rst index 730b3f240..81cf69595 100644 --- a/classes/class_physics2ddirectbodystate.rst +++ b/classes/class_physics2ddirectbodystate.rst @@ -61,7 +61,7 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_total_linear_damp` **(** **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`get_transform` **(** **)** const | +| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`integrate_forces` **(** **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -73,7 +73,7 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_sleep_state` **(** :ref:`bool` enabled **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Matrix32` transform **)** | +| void | :ref:`set_transform` **(** :ref:`Transform2D` transform **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -206,7 +206,7 @@ Return the rate at which the body stops moving, if there are not any other force .. _class_Physics2DDirectBodyState_get_transform: -- :ref:`Matrix32` **get_transform** **(** **)** const +- :ref:`Transform2D` **get_transform** **(** **)** const Return the transform matrix of the body. @@ -242,7 +242,7 @@ Set the sleeping state of the body, only affects character/rigid bodies. .. _class_Physics2DDirectBodyState_set_transform: -- void **set_transform** **(** :ref:`Matrix32` transform **)** +- void **set_transform** **(** :ref:`Transform2D` transform **)** Change the transform matrix of the body. diff --git a/classes/class_physics2ddirectspacestate.rst b/classes/class_physics2ddirectspacestate.rst index 29e8b5e59..89322080a 100644 --- a/classes/class_physics2ddirectspacestate.rst +++ b/classes/class_physics2ddirectspacestate.rst @@ -146,6 +146,6 @@ collider: Object the shape intersected. rid: :ref:`RID` of the object the shape intersected. -The number of intersections can be limited with the second paramater, to reduce the processing time. +The number of intersections can be limited with the second parameter, to reduce the processing time. diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index 1b8dea2a9..ddf5a868d 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -20,181 +20,181 @@ Physics 2D Server. Member Functions ---------------- -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Matrix32` transform=((1, 0), (0, 1), (0, 0)) **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_attach_object_instance_ID` **(** :ref:`RID` area, :ref:`int` id **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_create` **(** **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_object_instance_ID` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`int` param **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`area_get_transform` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_layer_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`int` param, :ref:`Variant` value **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Matrix32` transform **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`int` mode **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Matrix32` transform **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector2` offset, :ref:`Vector2` force **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Matrix32` transform=((1, 0), (0, 1), (0, 0)) **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` pos, :ref:`Vector2` impulse **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_attach_object_instance_ID` **(** :ref:`RID` body, :ref:`int` id **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_continuous_collision_detection_mode` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_layer_mask` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_object_instance_ID` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`body_get_one_way_collision_direction` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`body_get_one_way_collision_max_depth` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`int` param **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_get_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`int` state **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_shape_set_as_trigger` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_continuous_collision_detection_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=NULL **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_layer_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_one_way_collision_direction` **(** :ref:`RID` body, :ref:`Vector2` normal **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_one_way_collision_max_depth` **(** :ref:`RID` body, :ref:`float` depth **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`int` param, :ref:`float` value **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_as_trigger` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Variant` metadata **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Matrix32` transform **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`int` state, :ref:`Variant` value **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_test_motion` **(** :ref:`RID` body, :ref:`Matrix32` from, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=NULL **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`damped_spring_joint_create` **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damped_string_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`damped_string_joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_process_info` **(** :ref:`int` process_info **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`groove_joint_create` **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a=RID(), :ref:`RID` body_b=RID() **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`pin_joint_create` **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` active **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shape_create` **(** :ref:`int` type **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`space_create` **(** **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Physics2DDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`int` param **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`int` param, :ref:`float` value **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=((1, 0), (0, 1), (0, 0)) **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_attach_object_instance_ID` **(** :ref:`RID` area, :ref:`int` id **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_create` **(** **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`area_get_object_instance_ID` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`int` param **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`area_get_transform` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_layer_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`int` param, :ref:`Variant` value **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`int` mode **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform2D` transform **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector2` offset, :ref:`Vector2` force **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=((1, 0), (0, 1), (0, 0)) **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` pos, :ref:`Vector2` impulse **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_attach_object_instance_ID` **(** :ref:`RID` body, :ref:`int` id **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_continuous_collision_detection_mode` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_layer_mask` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_object_instance_ID` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`body_get_one_way_collision_direction` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`body_get_one_way_collision_max_depth` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`int` param **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_get_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`int` state **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_is_shape_set_as_trigger` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_continuous_collision_detection_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=NULL **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_layer_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_one_way_collision_direction` **(** :ref:`RID` body, :ref:`Vector2` normal **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_one_way_collision_max_depth` **(** :ref:`RID` body, :ref:`float` depth **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`int` param, :ref:`float` value **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_as_trigger` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Variant` metadata **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`int` state, :ref:`Variant` value **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_test_motion` **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=NULL **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`damped_spring_joint_create` **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`damped_string_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`damped_string_joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_process_info` **(** :ref:`int` process_info **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`groove_joint_create` **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a=RID(), :ref:`RID` body_b=RID() **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`pin_joint_create` **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` active **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shape_create` **(** :ref:`int` type **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`space_create` **(** **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Physics2DDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`int` param **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`int` param, :ref:`float` value **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -269,7 +269,7 @@ Member Function Description .. _class_Physics2DServer_area_add_shape: -- void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Matrix32` transform=((1, 0), (0, 1), (0, 0)) **)** +- void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=((1, 0), (0, 1), (0, 0)) **)** Add a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. @@ -317,7 +317,7 @@ Return the number of shapes assigned to an area. .. _class_Physics2DServer_area_get_shape_transform: -- :ref:`Matrix32` **area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const +- :ref:`Transform2D` **area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const Return the transform matrix of a shape within an area. @@ -335,7 +335,7 @@ Return the space override mode for the area. .. _class_Physics2DServer_area_get_transform: -- :ref:`Matrix32` **area_get_transform** **(** :ref:`RID` area **)** const +- :ref:`Transform2D` **area_get_transform** **(** :ref:`RID` area **)** const Return the transform matrix for an area. @@ -387,7 +387,7 @@ Substitute a given area shape by another. The old shape is selected by its index .. _class_Physics2DServer_area_set_shape_transform: -- void **area_set_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Matrix32` transform **)** +- void **area_set_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** Set the transform matrix for an area shape. @@ -405,7 +405,7 @@ Set the space override mode for the area. The modes are described in the constan .. _class_Physics2DServer_area_set_transform: -- void **area_set_transform** **(** :ref:`RID` area, :ref:`Matrix32` transform **)** +- void **area_set_transform** **(** :ref:`RID` area, :ref:`Transform2D` transform **)** Set the transform matrix for an area. @@ -423,7 +423,7 @@ Add a positioned force to the applied force and torque. As with :ref:`body_apply .. _class_Physics2DServer_body_add_shape: -- void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Matrix32` transform=((1, 0), (0, 1), (0, 0)) **)** +- void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=((1, 0), (0, 1), (0, 0)) **)** Add a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. @@ -525,7 +525,7 @@ Return the metadata of a shape of a body. .. _class_Physics2DServer_body_get_shape_transform: -- :ref:`Matrix32` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const +- :ref:`Transform2D` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const Return the transform matrix of a body shape. @@ -653,7 +653,7 @@ Set metadata of a shape within a body. This metadata is different from :ref:`Obj .. _class_Physics2DServer_body_set_shape_transform: -- void **body_set_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Matrix32` transform **)** +- void **body_set_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** Set the transform matrix for a body shape. @@ -671,7 +671,7 @@ Set a body state (see BODY_STATE\* constants). .. _class_Physics2DServer_body_test_motion: -- :ref:`bool` **body_test_motion** **(** :ref:`RID` body, :ref:`Matrix32` from, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=NULL **)** +- :ref:`bool` **body_test_motion** **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=NULL **)** Return whether a body can move from a given point in a given direction. Apart from the boolean return value, a :ref:`Physics2DTestMotionResult` can be passed to return additional information in. diff --git a/classes/class_physics2dshapequeryparameters.rst b/classes/class_physics2dshapequeryparameters.rst index e88a2f09e..8f6ef3a21 100644 --- a/classes/class_physics2dshapequeryparameters.rst +++ b/classes/class_physics2dshapequeryparameters.rst @@ -18,37 +18,37 @@ Parameters to be sent to a 2D shape physics query. Member Functions ---------------- -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_exclude` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_mask` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_motion` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_object_type_mask` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_shape_rid` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`get_transform` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exclude` **(** :ref:`Array` exclude **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_mask` **(** :ref:`int` layer_mask **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margin` **(** :ref:`float` margin **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_motion` **(** :ref:`Vector2` motion **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_object_type_mask` **(** :ref:`int` object_type_mask **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Shape2D` shape **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape_rid` **(** :ref:`RID` shape **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Matrix32` transform **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_exclude` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_layer_mask` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_margin` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_motion` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_object_type_mask` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_shape_rid` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_exclude` **(** :ref:`Array` exclude **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_layer_mask` **(** :ref:`int` layer_mask **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_margin` **(** :ref:`float` margin **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_motion` **(** :ref:`Vector2` motion **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_object_type_mask` **(** :ref:`int` object_type_mask **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape` **(** :ref:`Shape2D` shape **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape_rid` **(** :ref:`RID` shape **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform` **(** :ref:`Transform2D` transform **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -96,7 +96,7 @@ Return the :ref:`RID` of the shape queried. .. _class_Physics2DShapeQueryParameters_get_transform: -- :ref:`Matrix32` **get_transform** **(** **)** const +- :ref:`Transform2D` **get_transform** **(** **)** const Return the transform matrix of the shape queried. @@ -144,7 +144,7 @@ Set the :ref:`RID` of the shape to be used in queries. .. _class_Physics2DShapeQueryParameters_set_transform: -- void **set_transform** **(** :ref:`Matrix32` transform **)** +- void **set_transform** **(** :ref:`Transform2D` transform **)** Set the transormation matrix of the shape. This is necessary to set its position/rotation/scale. diff --git a/classes/class_physicsbody.rst b/classes/class_physicsbody.rst index bf738670c..371dcbe19 100644 --- a/classes/class_physicsbody.rst +++ b/classes/class_physicsbody.rst @@ -8,7 +8,7 @@ PhysicsBody **Inherits:** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`VehicleBody`, :ref:`KinematicBody`, :ref:`StaticBody`, :ref:`RigidBody` +**Inherited By:** :ref:`VehicleBody`, :ref:`StaticBody`, :ref:`KinematicBody`, :ref:`RigidBody` **Category:** Core @@ -23,24 +23,30 @@ Member Functions +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_collision_exception_with` **(** :ref:`PhysicsBody` body **)** | +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collision_mask` **(** **)** const | +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_mask` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_layer_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_collision_exception_with` **(** :ref:`PhysicsBody` body **)** | +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_mask` **(** :ref:`int` mask **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`int` **collision_layer** +- :ref:`int` **collision_mask** Description ----------- @@ -54,6 +60,14 @@ Member Function Description - void **add_collision_exception_with** **(** :ref:`PhysicsBody` body **)** +.. _class_PhysicsBody_get_collision_layer: + +- :ref:`int` **get_collision_layer** **(** **)** const + +.. _class_PhysicsBody_get_collision_layer_bit: + +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const + .. _class_PhysicsBody_get_collision_mask: - :ref:`int` **get_collision_mask** **(** **)** const @@ -62,18 +76,18 @@ Member Function Description - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const -.. _class_PhysicsBody_get_layer_mask: - -- :ref:`int` **get_layer_mask** **(** **)** const - -.. _class_PhysicsBody_get_layer_mask_bit: - -- :ref:`bool` **get_layer_mask_bit** **(** :ref:`int` bit **)** const - .. _class_PhysicsBody_remove_collision_exception_with: - void **remove_collision_exception_with** **(** :ref:`PhysicsBody` body **)** +.. _class_PhysicsBody_set_collision_layer: + +- void **set_collision_layer** **(** :ref:`int` layer **)** + +.. _class_PhysicsBody_set_collision_layer_bit: + +- void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** + .. _class_PhysicsBody_set_collision_mask: - void **set_collision_mask** **(** :ref:`int` mask **)** @@ -82,12 +96,4 @@ Member Function Description - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** -.. _class_PhysicsBody_set_layer_mask: - -- void **set_layer_mask** **(** :ref:`int` mask **)** - -.. _class_PhysicsBody_set_layer_mask_bit: - -- void **set_layer_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** - diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index d0fcbe7d8..75cc09c91 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -23,33 +23,42 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_collision_exception_with` **(** :ref:`PhysicsBody2D` body **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collision_mask` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_mask` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_layer_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_one_way_collision_direction` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_one_way_collision_max_depth` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_collision_exception_with` **(** :ref:`PhysicsBody2D` body **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` mask **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_mask` **(** :ref:`int` mask **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_one_way_collision_direction` **(** :ref:`Vector2` dir **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_one_way_collision_max_depth` **(** :ref:`float` depth **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **collision_layer** +- :ref:`int` **collision_mask** +- :ref:`int` **layers** +- :ref:`Vector2` **one_way_collision/direction** +- :ref:`float` **one_way_collision/max_depth** + Description ----------- @@ -64,6 +73,18 @@ Member Function Description Adds a body to the collision exception list. This list contains bodies that this body will not collide with. +.. _class_PhysicsBody2D_get_collision_layer: + +- :ref:`int` **get_collision_layer** **(** **)** const + +Return the physics layer this area is in. + +.. _class_PhysicsBody2D_get_collision_layer_bit: + +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const + +Return an individual bit on the collision mask. + .. _class_PhysicsBody2D_get_collision_mask: - :ref:`int` **get_collision_mask** **(** **)** const @@ -76,18 +97,6 @@ Return the physics layers this area can scan for collisions. Return an individual bit on the collision mask. -.. _class_PhysicsBody2D_get_layer_mask: - -- :ref:`int` **get_layer_mask** **(** **)** const - -Return the physics layer this area is in. - -.. _class_PhysicsBody2D_get_layer_mask_bit: - -- :ref:`bool` **get_layer_mask_bit** **(** :ref:`int` bit **)** const - -Return an individual bit on the collision mask. - .. _class_PhysicsBody2D_get_one_way_collision_direction: - :ref:`Vector2` **get_one_way_collision_direction** **(** **)** const @@ -106,6 +115,22 @@ Return how far a body can go through this one, when it allows one-way collisions Removes a body from the collision exception list. +.. _class_PhysicsBody2D_set_collision_layer: + +- void **set_collision_layer** **(** :ref:`int` mask **)** + +Set the physics layers this area is in. + +Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using :ref:`set_collision_mask`. + +A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. + +.. _class_PhysicsBody2D_set_collision_layer_bit: + +- void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** + +Set/clear individual bits on the layer mask. This makes getting a body in/out of only one layer easier. + .. _class_PhysicsBody2D_set_collision_mask: - void **set_collision_mask** **(** :ref:`int` mask **)** @@ -118,22 +143,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_PhysicsBody2D_set_layer_mask: - -- void **set_layer_mask** **(** :ref:`int` mask **)** - -Set the physics layers this area is in. - -Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using :ref:`set_collision_mask`. - -A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - -.. _class_PhysicsBody2D_set_layer_mask_bit: - -- void **set_layer_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** - -Set/clear individual bits on the layer mask. This makes getting a body in/out of only one layer easier. - .. _class_PhysicsBody2D_set_one_way_collision_direction: - void **set_one_way_collision_direction** **(** :ref:`Vector2` dir **)** diff --git a/classes/class_physicsdirectbodystate.rst b/classes/class_physicsdirectbodystate.rst index c46cff5e4..fc4239263 100644 --- a/classes/class_physicsdirectbodystate.rst +++ b/classes/class_physicsdirectbodystate.rst @@ -25,8 +25,12 @@ Member Functions +----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_impulse` **(** :ref:`Vector3` pos, :ref:`Vector3` j **)** | +----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_torqe_impulse` **(** :ref:`Vector3` j **)** | ++----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_angular_velocity` **(** **)** const | +----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_center_of_mass` **(** **)** const | ++----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** const | +----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_contact_collider_id` **(** :ref:`int` contact_idx **)** const | @@ -53,6 +57,8 @@ Member Functions +----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_linear_velocity` **(** **)** const | +----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`get_principal_inetria_axes` **(** **)** const | ++----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PhysicsDirectSpaceState` | :ref:`get_space_state` **(** **)** | +----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_step` **(** **)** const | @@ -89,10 +95,18 @@ Member Function Description - void **apply_impulse** **(** :ref:`Vector3` pos, :ref:`Vector3` j **)** +.. _class_PhysicsDirectBodyState_apply_torqe_impulse: + +- void **apply_torqe_impulse** **(** :ref:`Vector3` j **)** + .. _class_PhysicsDirectBodyState_get_angular_velocity: - :ref:`Vector3` **get_angular_velocity** **(** **)** const +.. _class_PhysicsDirectBodyState_get_center_of_mass: + +- :ref:`Vector3` **get_center_of_mass** **(** **)** const + .. _class_PhysicsDirectBodyState_get_contact_collider: - :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** const @@ -145,6 +159,10 @@ Member Function Description - :ref:`Vector3` **get_linear_velocity** **(** **)** const +.. _class_PhysicsDirectBodyState_get_principal_inetria_axes: + +- :ref:`Basis` **get_principal_inetria_axes** **(** **)** const + .. _class_PhysicsDirectBodyState_get_space_state: - :ref:`PhysicsDirectSpaceState` **get_space_state** **(** **)** diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index 276cedab7..16097912a 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -75,6 +75,8 @@ Member Functions +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` pos, :ref:`Vector3` impulse **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | ++----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_attach_object_instance_ID` **(** :ref:`RID` body, :ref:`int` id **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | @@ -445,6 +447,10 @@ Member Function Description - void **body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector3` pos, :ref:`Vector3` impulse **)** +.. _class_PhysicsServer_body_apply_torque_impulse: + +- void **body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse **)** + .. _class_PhysicsServer_body_attach_object_instance_ID: - void **body_attach_object_instance_ID** **(** :ref:`RID` body, :ref:`int` id **)** diff --git a/classes/class_pinjoint.rst b/classes/class_pinjoint.rst index ce918ab47..1937508e0 100644 --- a/classes/class_pinjoint.rst +++ b/classes/class_pinjoint.rst @@ -24,6 +24,13 @@ Member Functions | void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **params/bias** +- :ref:`float` **params/damping** +- :ref:`float` **params/impulse_clamp** + Numeric Constants ----------------- diff --git a/classes/class_pinjoint2d.rst b/classes/class_pinjoint2d.rst index ac32c7128..8cc75ce2f 100644 --- a/classes/class_pinjoint2d.rst +++ b/classes/class_pinjoint2d.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_softness` **(** :ref:`float` softness **)** | +----------------------------+-----------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **softness** + Description ----------- diff --git a/classes/class_planeshape.rst b/classes/class_planeshape.rst index 5d3a96bec..d6174eb63 100644 --- a/classes/class_planeshape.rst +++ b/classes/class_planeshape.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_plane` **(** :ref:`Plane` plane **)** | +----------------------------+--------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Plane` **plane** + Member Function Description --------------------------- diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index bd91abd60..44d9387b3 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -18,51 +18,66 @@ Brief Description Member Functions ---------------- -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_invert` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_invert_border` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`get_polygon` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_texture` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_texture_offset` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_texture_rotation` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_texture_scale` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`get_uv` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ColorArray` | :ref:`get_vertex_colors` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_invert` **(** :ref:`bool` invert **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_invert_border` **(** :ref:`float` invert_border **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_polygon` **(** :ref:`Vector2Array` polygon **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Object` texture **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_offset` **(** :ref:`Vector2` texture_offset **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_rotation` **(** :ref:`float` texture_rotation **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_scale` **(** :ref:`Vector2` texture_scale **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv` **(** :ref:`Vector2Array` uv **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_colors` **(** :ref:`ColorArray` vertex_colors **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_invert` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_invert_border` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_polygon` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_texture` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_texture_offset` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_texture_rotation` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_texture_scale` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_uv` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolColorArray` | :ref:`get_vertex_colors` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`Color` color **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_invert` **(** :ref:`bool` invert **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_invert_border` **(** :ref:`float` invert_border **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Object` texture **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture_offset` **(** :ref:`Vector2` texture_offset **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture_rotation` **(** :ref:`float` texture_rotation **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture_scale` **(** :ref:`Vector2` texture_scale **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv` **(** :ref:`PoolVector2Array` uv **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_colors` **(** :ref:`PoolColorArray` vertex_colors **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Color` **color** +- :ref:`float` **invert_border** +- :ref:`bool` **invert_enable** +- :ref:`Vector2` **offset** +- :ref:`PoolVector2Array` **polygon** +- :ref:`Texture` **texture** +- :ref:`Vector2` **texture_offset** +- :ref:`float` **texture_rotation** +- :ref:`Vector2` **texture_scale** +- :ref:`PoolVector2Array` **uv** +- :ref:`PoolColorArray` **vertex_colors** Description ----------- @@ -98,7 +113,7 @@ Return the offset for the polygon vertices. .. _class_Polygon2D_get_polygon: -- :ref:`Vector2Array` **get_polygon** **(** **)** const +- :ref:`PoolVector2Array` **get_polygon** **(** **)** const Return the set of vertices that defines this polygon. @@ -128,13 +143,13 @@ Return the uv coordinate multiplier. .. _class_Polygon2D_get_uv: -- :ref:`Vector2Array` **get_uv** **(** **)** const +- :ref:`PoolVector2Array` **get_uv** **(** **)** const Return the texture coordinates associated with every vertex of the polygon. .. _class_Polygon2D_get_vertex_colors: -- :ref:`ColorArray` **get_vertex_colors** **(** **)** const +- :ref:`PoolColorArray` **get_vertex_colors** **(** **)** const Return the list of vertex colors. @@ -164,7 +179,7 @@ Set the an offset that will be added to the vertices' position. E.g. if the offs .. _class_Polygon2D_set_polygon: -- void **set_polygon** **(** :ref:`Vector2Array` polygon **)** +- void **set_polygon** **(** :ref:`PoolVector2Array` polygon **)** Define the set of vertices that will represent the polygon. @@ -194,13 +209,13 @@ Set the value that will multiply the uv coordinates (:ref:`get_uv` uv **)** +- void **set_uv** **(** :ref:`PoolVector2Array` uv **)** Set the texture coordinates for every vertex of the polygon. There should be one uv vertex for every vertex in the polygon. If there are less, the undefined ones will be assumed to be (0,0). Extra uv vertices are ignored. .. _class_Polygon2D_set_vertex_colors: -- void **set_vertex_colors** **(** :ref:`ColorArray` vertex_colors **)** +- void **set_vertex_colors** **(** :ref:`PoolColorArray` vertex_colors **)** Set the color for each vertex of the polygon. There should be one color for every vertex in the polygon. If there are less, the undefined ones will be assumed to be :ref:`get_color`. Extra color entries are ignored. diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index 1d75e8ace..8d9bb610c 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -18,30 +18,35 @@ Brief Description Member Functions ---------------- -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`find_path` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_bounds` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` point **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`get_intersections` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_penalty` **(** :ref:`int` idx **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_point_inside` **(** :ref:`Vector2` point **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_penalty` **(** :ref:`int` idx, :ref:`float` penalty **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`setup` **(** :ref:`Vector2Array` points, :ref:`IntArray` connections **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`find_path` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_bounds` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` point **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_intersections` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_penalty` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_point_inside` **(** :ref:`Vector2` point **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_penalty` **(** :ref:`int` idx, :ref:`float` penalty **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`setup` **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Dictionary` **data** Member Function Description --------------------------- .. _class_PolygonPathFinder_find_path: -- :ref:`Vector2Array` **find_path** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** +- :ref:`PoolVector2Array` **find_path** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** .. _class_PolygonPathFinder_get_bounds: @@ -53,7 +58,7 @@ Member Function Description .. _class_PolygonPathFinder_get_intersections: -- :ref:`Vector2Array` **get_intersections** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const +- :ref:`PoolVector2Array` **get_intersections** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const .. _class_PolygonPathFinder_get_point_penalty: @@ -69,6 +74,6 @@ Member Function Description .. _class_PolygonPathFinder_setup: -- void **setup** **(** :ref:`Vector2Array` points, :ref:`IntArray` connections **)** +- void **setup** **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** diff --git a/classes/class_poolbytearray.rst b/classes/class_poolbytearray.rst new file mode 100644 index 000000000..a3fed5eab --- /dev/null +++ b/classes/class_poolbytearray.rst @@ -0,0 +1,131 @@ +.. 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_PoolByteArray: + +PoolByteArray +============= + +**Category:** Built-In Types + +Brief Description +----------------- + +Raw byte array. + +Member Functions +---------------- + ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`PoolByteArray` **(** :ref:`Array` from **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`int` byte **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolByteArray` array **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_string_from_ascii` **(** **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_string_from_utf8` **(** **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` byte **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`int` byte **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` byte **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + +Description +----------- + +Raw byte array. Contains bytes. Optimized for memory usage, can't fragment the memory. + +Member Function Description +--------------------------- + +.. _class_PoolByteArray_PoolByteArray: + +- :ref:`PoolByteArray` **PoolByteArray** **(** :ref:`Array` from **)** + +Create from a generic array. + +.. _class_PoolByteArray_append: + +- void **append** **(** :ref:`int` byte **)** + +.. _class_PoolByteArray_append_array: + +- void **append_array** **(** :ref:`PoolByteArray` array **)** + +Append an :ref:`PoolByteArray` at the end of this array. + +.. _class_PoolByteArray_get_string_from_ascii: + +- :ref:`String` **get_string_from_ascii** **(** **)** + +Returns a copy of the array's contents formatted as String. Fast alternative to get_string_from_utf8(), assuming the content is ASCII-only (unlike the UTF-8 function, this function maps every byte to a character in the string, so any multibyte sequence will be torn apart). + +.. _class_PoolByteArray_get_string_from_utf8: + +- :ref:`String` **get_string_from_utf8** **(** **)** + +Returns a copy of the array's contents formatted as String, assuming the array is formatted as UTF-8. Slower than get_string_from_ascii(), but works for UTF-8. Usually you should prefer this function over get_string_from_ascii() to support international input. + +.. _class_PoolByteArray_insert: + +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`int` byte **)** + +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_PoolByteArray_invert: + +- void **invert** **(** **)** + +Reverse the order of the elements in the array (so first element will now be the last). + +.. _class_PoolByteArray_push_back: + +- void **push_back** **(** :ref:`int` byte **)** + +Append an element at the end of the array. + +.. _class_PoolByteArray_remove: + +- void **remove** **(** :ref:`int` idx **)** + +Remove an element from the array by index. + +.. _class_PoolByteArray_resize: + +- void **resize** **(** :ref:`int` idx **)** + +Set the size of the :ref:`PoolByteArray`. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + +.. _class_PoolByteArray_set: + +- void **set** **(** :ref:`int` idx, :ref:`int` byte **)** + +Change the byte at the given index. + +.. _class_PoolByteArray_size: + +- :ref:`int` **size** **(** **)** + +Return the size of the array. + +.. _class_PoolByteArray_subarray: + +- :ref:`PoolByteArray` **subarray** **(** :ref:`int` from, :ref:`int` to **)** + +Returns the slice of the :ref:`PoolByteArray` between indices (inclusive) as a new :ref:`RawArray`. Any negative index is considered to be from the end of the array. + + diff --git a/classes/class_poolcolorarray.rst b/classes/class_poolcolorarray.rst new file mode 100644 index 000000000..64252f67f --- /dev/null +++ b/classes/class_poolcolorarray.rst @@ -0,0 +1,109 @@ +.. 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_PoolColorArray: + +PoolColorArray +============== + +**Category:** Built-In Types + +Brief Description +----------------- + +Array of Colors + +Member Functions +---------------- + ++----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolColorArray` | :ref:`PoolColorArray` **(** :ref:`Array` from **)** | ++----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`Color` color **)** | ++----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolColorArray` array **)** | ++----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Color` color **)** | ++----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`Color` color **)** | ++----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`Color` color **)** | ++----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + +Description +----------- + +Array of Color, can only contains colors. Optimized for memory usage, can't fragment the memory. + +Member Function Description +--------------------------- + +.. _class_PoolColorArray_PoolColorArray: + +- :ref:`PoolColorArray` **PoolColorArray** **(** :ref:`Array` from **)** + +Create from a generic array. + +.. _class_PoolColorArray_append: + +- void **append** **(** :ref:`Color` color **)** + +Append an element at the end of the array (alias of :ref:`push_back`). + +.. _class_PoolColorArray_append_array: + +- void **append_array** **(** :ref:`PoolColorArray` array **)** + +Append an :ref:`PoolColorArray` at the end of this array. + +.. _class_PoolColorArray_insert: + +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`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_PoolColorArray_invert: + +- void **invert** **(** **)** + +Reverse the order of the elements in the array (so first element will now be the last). + +.. _class_PoolColorArray_push_back: + +- void **push_back** **(** :ref:`Color` color **)** + +Append a value to the array. + +.. _class_PoolColorArray_remove: + +- void **remove** **(** :ref:`int` idx **)** + +Remove an element from the array by index. + +.. _class_PoolColorArray_resize: + +- void **resize** **(** :ref:`int` idx **)** + +Set the size of the :ref:`PoolColorArray`. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + +.. _class_PoolColorArray_set: + +- void **set** **(** :ref:`int` idx, :ref:`Color` color **)** + +Change the :ref:`Color` at the given index. + +.. _class_PoolColorArray_size: + +- :ref:`int` **size** **(** **)** + +Return the array size. + + diff --git a/classes/class_poolintarray.rst b/classes/class_poolintarray.rst new file mode 100644 index 000000000..781b1104e --- /dev/null +++ b/classes/class_poolintarray.rst @@ -0,0 +1,109 @@ +.. 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_PoolIntArray: + +PoolIntArray +============ + +**Category:** Built-In Types + +Brief Description +----------------- + +Integer Array. + +Member Functions +---------------- + ++------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`PoolIntArray` **(** :ref:`Array` from **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`int` integer **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolIntArray` array **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` integer **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`int` integer **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` integer **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + +Description +----------- + +Integer Array. Array of integers. Can only contain integers. Optimized for memory usage, can't fragment the memory. + +Member Function Description +--------------------------- + +.. _class_PoolIntArray_PoolIntArray: + +- :ref:`PoolIntArray` **PoolIntArray** **(** :ref:`Array` from **)** + +Create from a generic array. + +.. _class_PoolIntArray_append: + +- void **append** **(** :ref:`int` integer **)** + +Append an element at the end of the array (alias of :ref:`push_back`). + +.. _class_PoolIntArray_append_array: + +- void **append_array** **(** :ref:`PoolIntArray` array **)** + +Append an :ref:`PoolIntArray` at the end of this array. + +.. _class_PoolIntArray_insert: + +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`int` integer **)** + +Insert a new int at a given position in the array. The position must be valid, or at the end of the array (pos==size()). + +.. _class_PoolIntArray_invert: + +- void **invert** **(** **)** + +Reverse the order of the elements in the array (so first element will now be the last). + +.. _class_PoolIntArray_push_back: + +- void **push_back** **(** :ref:`int` integer **)** + +Append a value to the array. + +.. _class_PoolIntArray_remove: + +- void **remove** **(** :ref:`int` idx **)** + +Remove an element from the array by index. + +.. _class_PoolIntArray_resize: + +- void **resize** **(** :ref:`int` idx **)** + +Set the size of the :ref:`PoolIntArray`. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + +.. _class_PoolIntArray_set: + +- void **set** **(** :ref:`int` idx, :ref:`int` integer **)** + +Change the int at the given index. + +.. _class_PoolIntArray_size: + +- :ref:`int` **size** **(** **)** + +Return the array size. + + diff --git a/classes/class_poolrealarray.rst b/classes/class_poolrealarray.rst new file mode 100644 index 000000000..809896d5b --- /dev/null +++ b/classes/class_poolrealarray.rst @@ -0,0 +1,109 @@ +.. 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_PoolRealArray: + +PoolRealArray +============= + +**Category:** Built-In Types + +Brief Description +----------------- + +Real Array. + +Member Functions +---------------- + ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`PoolRealArray` **(** :ref:`Array` from **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`float` value **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolRealArray` array **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`float` value **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`float` value **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`float` value **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + +Description +----------- + +Real Array. Array of floating point values. Can only contain floats. Optimized for memory usage, can't fragment the memory. + +Member Function Description +--------------------------- + +.. _class_PoolRealArray_PoolRealArray: + +- :ref:`PoolRealArray` **PoolRealArray** **(** :ref:`Array` from **)** + +Create from a generic array. + +.. _class_PoolRealArray_append: + +- void **append** **(** :ref:`float` value **)** + +Append an element at the end of the array (alias of :ref:`push_back`). + +.. _class_PoolRealArray_append_array: + +- void **append_array** **(** :ref:`PoolRealArray` array **)** + +Append an :ref:`RealArray` at the end of this array. + +.. _class_PoolRealArray_insert: + +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`float` value **)** + +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_PoolRealArray_invert: + +- void **invert** **(** **)** + +Reverse the order of the elements in the array (so first element will now be the last). + +.. _class_PoolRealArray_push_back: + +- void **push_back** **(** :ref:`float` value **)** + +Append an element at the end of the array. + +.. _class_PoolRealArray_remove: + +- void **remove** **(** :ref:`int` idx **)** + +Remove an element from the array by index. + +.. _class_PoolRealArray_resize: + +- void **resize** **(** :ref:`int` idx **)** + +Set the size of the :ref:`RealArray`. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + +.. _class_PoolRealArray_set: + +- void **set** **(** :ref:`int` idx, :ref:`float` value **)** + +Change the float at the given index. + +.. _class_PoolRealArray_size: + +- :ref:`int` **size** **(** **)** + +Return the size of the array. + + diff --git a/classes/class_poolstringarray.rst b/classes/class_poolstringarray.rst new file mode 100644 index 000000000..0ef0ce42f --- /dev/null +++ b/classes/class_poolstringarray.rst @@ -0,0 +1,115 @@ +.. 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_PoolStringArray: + +PoolStringArray +=============== + +**Category:** Built-In Types + +Brief Description +----------------- + +String Array. + +Member Functions +---------------- + ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`PoolStringArray` **(** :ref:`Array` from **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`String` string **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolStringArray` array **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`String` string **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`join` **(** :ref:`String` string **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`String` string **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`String` string **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ + +Description +----------- + +String Array. Array of strings. Can only contain strings. Optimized for memory usage, can't fragment the memory. + +Member Function Description +--------------------------- + +.. _class_PoolStringArray_PoolStringArray: + +- :ref:`PoolStringArray` **PoolStringArray** **(** :ref:`Array` from **)** + +Create from a generic array. + +.. _class_PoolStringArray_append: + +- void **append** **(** :ref:`String` string **)** + +Append an element at the end of the array (alias of :ref:`push_back`). + +.. _class_PoolStringArray_append_array: + +- void **append_array** **(** :ref:`PoolStringArray` array **)** + +Append an :ref:`StringArray` at the end of this array. + +.. _class_PoolStringArray_insert: + +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`String` string **)** + +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_PoolStringArray_invert: + +- void **invert** **(** **)** + +.. _class_PoolStringArray_join: + +- :ref:`String` **join** **(** :ref:`String` string **)** + +Reverse the order of the elements in the array (so first element will now be the last). + +.. _class_PoolStringArray_push_back: + +- void **push_back** **(** :ref:`String` string **)** + +Append a string element at end of the array. + +.. _class_PoolStringArray_remove: + +- void **remove** **(** :ref:`int` idx **)** + +Remove an element from the array by index. + +.. _class_PoolStringArray_resize: + +- void **resize** **(** :ref:`int` idx **)** + +Set the size of the :ref:`StringArray`. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + +.. _class_PoolStringArray_set: + +- void **set** **(** :ref:`int` idx, :ref:`String` string **)** + +Change the :ref:`String` at the given index. + +.. _class_PoolStringArray_size: + +- :ref:`int` **size** **(** **)** + +Return the size of the array. + + diff --git a/classes/class_poolvector2array.rst b/classes/class_poolvector2array.rst new file mode 100644 index 000000000..00fa0f194 --- /dev/null +++ b/classes/class_poolvector2array.rst @@ -0,0 +1,109 @@ +.. 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_PoolVector2Array: + +PoolVector2Array +================ + +**Category:** Built-In Types + +Brief Description +----------------- + +An Array of Vector2. + +Member Functions +---------------- + ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`PoolVector2Array` **(** :ref:`Array` from **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`Vector2` vector2 **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolVector2Array` array **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`Vector2` vector2 **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ + +Description +----------- + +An Array specifically designed to hold Vector2. + +Member Function Description +--------------------------- + +.. _class_PoolVector2Array_PoolVector2Array: + +- :ref:`PoolVector2Array` **PoolVector2Array** **(** :ref:`Array` from **)** + +Construct a new :ref:`PoolVector2Array`. Optionally, you can pass in an Array that will be converted. + +.. _class_PoolVector2Array_append: + +- void **append** **(** :ref:`Vector2` vector2 **)** + +Append an element at the end of the array (alias of :ref:`push_back`). + +.. _class_PoolVector2Array_append_array: + +- void **append_array** **(** :ref:`PoolVector2Array` array **)** + +Append an :ref:`PoolVector2Array` at the end of this array. + +.. _class_PoolVector2Array_insert: + +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** + +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_PoolVector2Array_invert: + +- void **invert** **(** **)** + +Reverse the order of the elements in the array (so first element will now be the last). + +.. _class_PoolVector2Array_push_back: + +- void **push_back** **(** :ref:`Vector2` vector2 **)** + +Insert a :ref:`Vector2` at the end. + +.. _class_PoolVector2Array_remove: + +- void **remove** **(** :ref:`int` idx **)** + +Remove an element from the array by index. + +.. _class_PoolVector2Array_resize: + +- void **resize** **(** :ref:`int` idx **)** + +Set the size of the PoolVector2Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + +.. _class_PoolVector2Array_set: + +- void **set** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** + +Change the :ref:`Vector2` at the given index. + +.. _class_PoolVector2Array_size: + +- :ref:`int` **size** **(** **)** + +Return the size of the array. + + diff --git a/classes/class_poolvector3array.rst b/classes/class_poolvector3array.rst new file mode 100644 index 000000000..402f6fa54 --- /dev/null +++ b/classes/class_poolvector3array.rst @@ -0,0 +1,109 @@ +.. 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_PoolVector3Array: + +PoolVector3Array +================ + +**Category:** Built-In Types + +Brief Description +----------------- + +An Array of Vector3. + +Member Functions +---------------- + ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`PoolVector3Array` **(** :ref:`Array` from **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`Vector3` vector3 **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolVector3Array` array **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`Vector3` vector3 **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ + +Description +----------- + +An Array specifically designed to hold Vector3. + +Member Function Description +--------------------------- + +.. _class_PoolVector3Array_PoolVector3Array: + +- :ref:`PoolVector3Array` **PoolVector3Array** **(** :ref:`Array` from **)** + +Construct a new PoolVector3Array. Optionally, you can pass in an Array that will be converted. + +.. _class_PoolVector3Array_append: + +- void **append** **(** :ref:`Vector3` vector3 **)** + +Append an element at the end of the array (alias of :ref:`push_back`). + +.. _class_PoolVector3Array_append_array: + +- void **append_array** **(** :ref:`PoolVector3Array` array **)** + +Append an :ref:`PoolVector3Array` at the end of this array. + +.. _class_PoolVector3Array_insert: + +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** + +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_PoolVector3Array_invert: + +- void **invert** **(** **)** + +Reverse the order of the elements in the array (so first element will now be the last). + +.. _class_PoolVector3Array_push_back: + +- void **push_back** **(** :ref:`Vector3` vector3 **)** + +Insert a Vector3 at the end. + +.. _class_PoolVector3Array_remove: + +- void **remove** **(** :ref:`int` idx **)** + +Remove an element from the array by index. + +.. _class_PoolVector3Array_resize: + +- void **resize** **(** :ref:`int` idx **)** + +Set the size of the PoolVector3Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + +.. _class_PoolVector3Array_set: + +- void **set** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** + +Change the :ref:`Vector3` at the given index. + +.. _class_PoolVector3Array_size: + +- :ref:`int` **size** **(** **)** + +Return the size of the array. + + diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 56ffe25ce..dcb47d89b 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -23,7 +23,7 @@ Member Functions +--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_exclusive` **(** **)** const | +--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup` **(** **)** | +| void | :ref:`popup` **(** :ref:`Rect2` bounds=Rect2(0, 0, 0, 0) **)** | +--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`popup_centered` **(** :ref:`Vector2` size=Vector2(0, 0) **)** | +--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ @@ -40,6 +40,11 @@ Signals - **about_to_show** **(** **)** - **popup_hide** **(** **)** +Member Variables +---------------- + +- :ref:`bool` **popup_exclusive** + Numeric Constants ----------------- @@ -62,7 +67,7 @@ Returns whether the popup will hide other popups when shown on the screen. .. _class_Popup_popup: -- void **popup** **(** **)** +- void **popup** **(** :ref:`Rect2` bounds=Rect2(0, 0, 0, 0) **)** Popup (show the control in modal form). diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index eed94acda..0c8cf2435 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -18,88 +18,101 @@ PopupMenu displays a list of options. Member Functions ---------------- -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_check_item` **(** :ref:`Object` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_check_shortcut` **(** :ref:`Object` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_item` **(** :ref:`Object` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_shortcut` **(** :ref:`Object` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_separator` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hide_on_item_selection` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_ID` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_accelerator` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_count` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShortCut` | :ref:`get_item_shortcut` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_item` **(** :ref:`int` idx **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_on_item_selection` **(** :ref:`bool` enable **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_ID` **(** :ref:`int` idx, :ref:`int` id **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_accelerator` **(** :ref:`int` idx, :ref:`int` accel **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_as_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_as_separator` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_checked` **(** :ref:`int` idx, :ref:`bool` checked **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Object` icon **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shortcut` **(** :ref:`int` idx, :ref:`ShortCut` shortcut **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_submenu` **(** :ref:`int` idx, :ref:`String` submenu **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_check_item` **(** :ref:`Object` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_check_shortcut` **(** :ref:`Object` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_item` **(** :ref:`Object` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_shortcut` **(** :ref:`Object` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_separator` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_ID` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_accelerator` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_count` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ShortCut` | :ref:`get_item_shortcut` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_hide_on_item_selection` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_item` **(** :ref:`int` idx **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_on_item_selection` **(** :ref:`bool` enable **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_ID` **(** :ref:`int` idx, :ref:`int` id **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_accelerator` **(** :ref:`int` idx, :ref:`int` accel **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_as_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_as_separator` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_checked` **(** :ref:`int` idx, :ref:`bool` checked **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Object` icon **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_shortcut` **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_submenu` **(** :ref:`int` idx, :ref:`String` submenu **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`toggle_item_checked` **(** :ref:`int` idx **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -- **item_pressed** **(** :ref:`int` ID **)** +- **id_pressed** **(** :ref:`int` ID **)** +- **index_pressed** **(** :ref:`int` index **)** + +Member Variables +---------------- + +- :ref:`bool` **hide_on_item_selection** +- :ref:`Array` **items** Description ----------- @@ -117,7 +130,7 @@ Add a new checkable item with text "label". An id can optionally be provided, as .. _class_PopupMenu_add_check_shortcut: -- void **add_check_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1 **)** +- void **add_check_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** .. _class_PopupMenu_add_icon_check_item: @@ -127,7 +140,7 @@ Add a new checkable item with text "label" and icon "texture". An id can optiona .. _class_PopupMenu_add_icon_check_shortcut: -- void **add_icon_check_shortcut** **(** :ref:`Object` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1 **)** +- void **add_icon_check_shortcut** **(** :ref:`Object` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** .. _class_PopupMenu_add_icon_item: @@ -137,7 +150,7 @@ Add a new item with text "label" and icon "texture". An id can optionally be pro .. _class_PopupMenu_add_icon_shortcut: -- void **add_icon_shortcut** **(** :ref:`Object` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1 **)** +- void **add_icon_shortcut** **(** :ref:`Object` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** .. _class_PopupMenu_add_item: @@ -153,7 +166,7 @@ Add a separator between items. Separators also occupy an index. .. _class_PopupMenu_add_shortcut: -- void **add_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1 **)** +- void **add_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** .. _class_PopupMenu_add_submenu_item: @@ -167,12 +180,6 @@ Adds an item with a submenu. The submenu is the name of a child PopupMenu node t Clear the popup menu, in effect removing all items. -.. _class_PopupMenu_is_hide_on_item_selection: - -- :ref:`bool` **is_hide_on_item_selection** **(** **)** - -Returns a boolean that indicates whether or not the PopupMenu will hide on item selection. - .. _class_PopupMenu_get_item_ID: - :ref:`int` **get_item_ID** **(** :ref:`int` idx **)** const @@ -225,6 +232,16 @@ Return the submenu name of the item at index "idx". Return the text of the item at index "idx". +.. _class_PopupMenu_get_item_tooltip: + +- :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const + +.. _class_PopupMenu_is_hide_on_item_selection: + +- :ref:`bool` **is_hide_on_item_selection** **(** **)** + +Returns a boolean that indicates whether or not the PopupMenu will hide on item selection. + .. _class_PopupMenu_is_item_checkable: - :ref:`bool` **is_item_checkable** **(** :ref:`int` idx **)** const @@ -311,7 +328,7 @@ Sets the metadata of an item, which might be of any type. You can later get it w .. _class_PopupMenu_set_item_shortcut: -- void **set_item_shortcut** **(** :ref:`int` idx, :ref:`ShortCut` shortcut **)** +- void **set_item_shortcut** **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** .. _class_PopupMenu_set_item_submenu: @@ -325,4 +342,12 @@ Sets the submenu of the item at index "idx". The submenu is the name of a child Set the text of the item at index "idx". +.. _class_PopupMenu_set_item_tooltip: + +- void **set_item_tooltip** **(** :ref:`int` idx, :ref:`String` tooltip **)** + +.. _class_PopupMenu_toggle_item_checked: + +- void **toggle_item_checked** **(** :ref:`int` idx **)** + diff --git a/classes/class_portal.rst b/classes/class_portal.rst index 6e17d6ddd..1d717b319 100644 --- a/classes/class_portal.rst +++ b/classes/class_portal.rst @@ -18,27 +18,27 @@ Portals provide virtual openings to rooms. Member Functions ---------------- -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_connect_range` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_disable_distance` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_disabled_color` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`get_shape` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabled` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_connect_range` **(** :ref:`float` range **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_distance` **(** :ref:`float` distance **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disabled_color` **(** :ref:`Color` color **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled` **(** :ref:`bool` enable **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Vector2Array` points **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_connect_range` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_disable_distance` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_disabled_color` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_shape` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_enabled` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_connect_range` **(** :ref:`float` range **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_distance` **(** :ref:`float` distance **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disabled_color` **(** :ref:`Color` color **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enabled` **(** :ref:`bool` enable **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape` **(** :ref:`PoolVector2Array` points **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -68,7 +68,7 @@ Return the color for when the portal goes beyond the disable distance (see :ref: .. _class_Portal_get_shape: -- :ref:`Vector2Array` **get_shape** **(** **)** const +- :ref:`PoolVector2Array` **get_shape** **(** **)** const Return the portal shape. The shape is an array of :ref:`Vector2` points, representing a convex polygon in the X,Y plane. @@ -104,7 +104,7 @@ Enable the portal (it is enabled by default though), disabling it will cause the .. _class_Portal_set_shape: -- void **set_shape** **(** :ref:`Vector2Array` points **)** +- void **set_shape** **(** :ref:`PoolVector2Array` points **)** Set the portal shape. The shape is an array of :ref:`Vector2` points, representing a convex polygon in the X,Y plane. diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index 6dabeba1b..a70d50509 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_percent_visible` **(** :ref:`bool` visible **)** | +--------------------------+-----------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`bool` **percent_visible** + Description ----------- diff --git a/classes/class_proximitygroup.rst b/classes/class_proximitygroup.rst index d6f96f4a9..cb69cbe95 100644 --- a/classes/class_proximitygroup.rst +++ b/classes/class_proximitygroup.rst @@ -35,6 +35,11 @@ Signals - **broadcast** **(** :ref:`String` name, :ref:`Array` parameters **)** +Member Variables +---------------- + +- :ref:`Vector3` **grid_radius** + Description ----------- diff --git a/classes/class_quad.rst b/classes/class_quad.rst index 6f98451cb..d709f08ea 100644 --- a/classes/class_quad.rst +++ b/classes/class_quad.rst @@ -36,6 +36,14 @@ Member Functions | void | :ref:`set_size` **(** :ref:`Vector2` size **)** | +--------------------------------+---------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **axis** +- :ref:`bool` **centered** +- :ref:`Vector2` **offset** +- :ref:`Vector2` **size** + Member Function Description --------------------------- diff --git a/classes/class_quadmesh.rst b/classes/class_quadmesh.rst new file mode 100644 index 000000000..0d8204cdc --- /dev/null +++ b/classes/class_quadmesh.rst @@ -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_QuadMesh: + +QuadMesh +======== + +**Inherits:** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_material` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material` **(** :ref:`Material` material **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Material` **material** + +Member Function Description +--------------------------- + +.. _class_QuadMesh_get_material: + +- :ref:`Material` **get_material** **(** **)** const + +.. _class_QuadMesh_set_material: + +- void **set_material** **(** :ref:`Material` material **)** + + diff --git a/classes/class_quat.rst b/classes/class_quat.rst index 409504e90..1eddd027c 100644 --- a/classes/class_quat.rst +++ b/classes/class_quat.rst @@ -21,7 +21,7 @@ Member Functions +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Quat` | :ref:`Quat` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`Quat` **(** :ref:`Matrix3` from **)** | +| :ref:`Quat` | :ref:`Quat` **(** :ref:`Basis` from **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Quat` | :ref:`cubic_slerp` **(** :ref:`Quat` b, :ref:`Quat` pre_a, :ref:`Quat` post_b, :ref:`float` t **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -53,7 +53,7 @@ Member Variables Description ----------- -Quaternion is a 4 dimensional vector that is used to represent a rotation. It mainly exists to perform SLERP (spherical-linear interpolation) between to rotations obtained by a Matrix3 cheaply. Multiplying quaternions also cheaply reproduces rotation sequences, however quaternions need to be often normalized, or else they suffer from precision issues. +Quaternion is a 4 dimensional vector that is used to represent a rotation. It mainly exists to perform SLERP (spherical-linear interpolation) between two rotations. Multiplying quaternions also cheaply reproduces rotation sequences. However quaternions need to be often renormalized, or else they suffer from precision issues. Member Function Description --------------------------- @@ -66,11 +66,11 @@ Member Function Description - :ref:`Quat` **Quat** **(** :ref:`Vector3` axis, :ref:`float` angle **)** -Returns a quaternion that will rotate around the given axis by the specified angle. +Returns a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector. .. _class_Quat_Quat: -- :ref:`Quat` **Quat** **(** :ref:`Matrix3` from **)** +- :ref:`Quat` **Quat** **(** :ref:`Basis` from **)** Returns the rotation matrix corresponding to the given quaternion. diff --git a/classes/class_range.rst b/classes/class_range.rst index c60d3171e..e92a0baea 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -20,47 +20,43 @@ Abstract base class for range-based controls. Member Functions ---------------- -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_min` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_page` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_step` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_unit_value` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_val` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_value` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_rounded_values` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_unit_value_exp` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exp_unit_value` **(** :ref:`bool` enabled **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max` **(** :ref:`float` maximum **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_min` **(** :ref:`float` minimum **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_page` **(** :ref:`float` pagesize **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rounded_values` **(** :ref:`bool` enabled **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_step` **(** :ref:`float` step **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_unit_value` **(** :ref:`float` value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_val` **(** :ref:`float` value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_value` **(** :ref:`float` value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`share` **(** :ref:`Object` with **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`unshare` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_as_ratio` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_max` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_min` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_page` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_step` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_value` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ratio_exp` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_rounded_values` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_ratio` **(** :ref:`float` value **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_exp_ratio` **(** :ref:`bool` enabled **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max` **(** :ref:`float` maximum **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_min` **(** :ref:`float` minimum **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_page` **(** :ref:`float` pagesize **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_step` **(** :ref:`float` step **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_rounded_values` **(** :ref:`bool` enabled **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_value` **(** :ref:`float` value **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`share` **(** :ref:`Object` with **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unshare` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -68,6 +64,17 @@ Signals - **changed** **(** **)** - **value_changed** **(** :ref:`float` value **)** +Member Variables +---------------- + +- :ref:`bool` **exp_edit** +- :ref:`float` **max_value** +- :ref:`float` **min_value** +- :ref:`float` **page** +- :ref:`bool` **rounded** +- :ref:`float` **step** +- :ref:`float` **value** + Description ----------- @@ -76,6 +83,12 @@ Range is a base class for :ref:`Control` nodes that change a floa Member Function Description --------------------------- +.. _class_Range_get_as_ratio: + +- :ref:`float` **get_as_ratio** **(** **)** const + +Return value mapped to 0 to 1 range. + .. _class_Range_get_max: - :ref:`float` **get_max** **(** **)** const @@ -100,33 +113,27 @@ Return the page size, if page is 0, paging is disabled. Return the stepping, if step is 0, stepping is disabled. -.. _class_Range_get_unit_value: - -- :ref:`float` **get_unit_value** **(** **)** const - -Return value mapped to 0 to 1 (unit) range. - -.. _class_Range_get_val: - -- :ref:`float` **get_val** **(** **)** const - -Return the current value. - .. _class_Range_get_value: - :ref:`float` **get_value** **(** **)** const -.. _class_Range_is_rounded_values: +.. _class_Range_is_ratio_exp: -- :ref:`bool` **is_rounded_values** **(** **)** const +- :ref:`bool` **is_ratio_exp** **(** **)** const -.. _class_Range_is_unit_value_exp: +.. _class_Range_is_using_rounded_values: -- :ref:`bool` **is_unit_value_exp** **(** **)** const +- :ref:`bool` **is_using_rounded_values** **(** **)** const -.. _class_Range_set_exp_unit_value: +.. _class_Range_set_as_ratio: -- void **set_exp_unit_value** **(** :ref:`bool` enabled **)** +- void **set_as_ratio** **(** :ref:`float` value **)** + +Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max. + +.. _class_Range_set_exp_ratio: + +- void **set_exp_ratio** **(** :ref:`bool` enabled **)** .. _class_Range_set_max: @@ -144,25 +151,15 @@ Set minimum value, clamped range value to it if it's less. Set page size. Page is mainly used for scrollbars or anything that controls text scrolling. -.. _class_Range_set_rounded_values: - -- void **set_rounded_values** **(** :ref:`bool` enabled **)** - .. _class_Range_set_step: - void **set_step** **(** :ref:`float` step **)** Set step value. If step is 0, stepping will be disabled. -.. _class_Range_set_unit_value: +.. _class_Range_set_use_rounded_values: -- void **set_unit_value** **(** :ref:`float` value **)** - -Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max. - -.. _class_Range_set_val: - -- void **set_val** **(** :ref:`float` value **)** +- void **set_use_rounded_values** **(** :ref:`bool` enabled **)** .. _class_Range_set_value: diff --git a/classes/class_rawarray.rst b/classes/class_rawarray.rst deleted file mode 100644 index 1f9621655..000000000 --- a/classes/class_rawarray.rst +++ /dev/null @@ -1,131 +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_RawArray: - -RawArray -======== - -**Category:** Built-In Types - -Brief Description ------------------ - -Raw byte array. - -Member Functions ----------------- - -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`RawArray` **(** :ref:`Array` from **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`int` byte **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`RawArray` array **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string_from_ascii` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string_from_utf8` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` byte **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`int` byte **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` byte **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ - -Description ------------ - -Raw byte array. Contains bytes. Optimized for memory usage, can't fragment the memory. - -Member Function Description ---------------------------- - -.. _class_RawArray_RawArray: - -- :ref:`RawArray` **RawArray** **(** :ref:`Array` from **)** - -Create from a generic array. - -.. _class_RawArray_append: - -- void **append** **(** :ref:`int` byte **)** - -.. _class_RawArray_append_array: - -- void **append_array** **(** :ref:`RawArray` array **)** - -Append an :ref:`RawArray` at the end of this array. - -.. _class_RawArray_get_string_from_ascii: - -- :ref:`String` **get_string_from_ascii** **(** **)** - -Returns a copy of the array's contents formatted as String. Fast alternative to get_string_from_utf8(), assuming the content is ASCII-only (unlike the UTF-8 function, this function maps every byte to a character in the string, so any multibyte sequence will be torn apart). - -.. _class_RawArray_get_string_from_utf8: - -- :ref:`String` **get_string_from_utf8** **(** **)** - -Returns a copy of the array's contents formatted as String, assuming the array is formatted as UTF-8. Slower than get_string_from_ascii(), but works for UTF-8. Usually you should prefer this function over get_string_from_ascii() to support international input. - -.. _class_RawArray_insert: - -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`int` byte **)** - -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_RawArray_invert: - -- void **invert** **(** **)** - -Reverse the order of the elements in the array (so first element will now be the last). - -.. _class_RawArray_push_back: - -- void **push_back** **(** :ref:`int` byte **)** - -Append an element at the end of the array. - -.. _class_RawArray_remove: - -- void **remove** **(** :ref:`int` idx **)** - -Remove an element from the array by index. - -.. _class_RawArray_resize: - -- void **resize** **(** :ref:`int` idx **)** - -Set the size of the :ref:`RawArray`. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. - -.. _class_RawArray_set: - -- void **set** **(** :ref:`int` idx, :ref:`int` byte **)** - -Change the byte at the given index. - -.. _class_RawArray_size: - -- :ref:`int` **size** **(** **)** - -Return the size of the array. - -.. _class_RawArray_subarray: - -- :ref:`RawArray` **subarray** **(** :ref:`int` from, :ref:`int` to **)** - -Returns the slice of the :ref:`RawArray` between indices (inclusive) as a new :ref:`RawArray`. Any negative index is considered to be from the end of the array. - - diff --git a/classes/class_raycast.rst b/classes/class_raycast.rst index 27da651ef..ac9a4a07c 100644 --- a/classes/class_raycast.rst +++ b/classes/class_raycast.rst @@ -58,6 +58,14 @@ Member Functions | void | :ref:`set_type_mask` **(** :ref:`int` mask **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Vector3` **cast_to** +- :ref:`bool` **enabled** +- :ref:`int` **layer_mask** +- :ref:`int` **type_mask** + Description ----------- diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index fc556f499..823ff1688 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -62,6 +62,15 @@ Member Functions | void | :ref:`set_type_mask` **(** :ref:`int` mask **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Vector2` **cast_to** +- :ref:`bool` **enabled** +- :ref:`bool` **exclude_parent** +- :ref:`int` **layer_mask** +- :ref:`int` **type_mask** + Description ----------- diff --git a/classes/class_rayshape.rst b/classes/class_rayshape.rst index 3fcdb7da8..bcd2b3095 100644 --- a/classes/class_rayshape.rst +++ b/classes/class_rayshape.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_length` **(** :ref:`float` length **)** | +----------------------------+---------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **length** + Member Function Description --------------------------- diff --git a/classes/class_rayshape2d.rst b/classes/class_rayshape2d.rst index 2402477e1..d43eebd71 100644 --- a/classes/class_rayshape2d.rst +++ b/classes/class_rayshape2d.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_length` **(** :ref:`float` length **)** | +----------------------------+-----------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **length** + Description ----------- diff --git a/classes/class_realarray.rst b/classes/class_realarray.rst deleted file mode 100644 index 544500b8d..000000000 --- a/classes/class_realarray.rst +++ /dev/null @@ -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_RealArray: - -RealArray -========= - -**Category:** Built-In Types - -Brief Description ------------------ - -Real Array . - -Member Functions ----------------- - -+------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`RealArray` | :ref:`RealArray` **(** :ref:`Array` from **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`float` value **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`RealArray` array **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`float` value **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`float` value **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`float` value **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------+ - -Description ------------ - -Real Array. Array of floating point values. Can only contain floats. Optimized for memory usage, can't fragment the memory. - -Member Function Description ---------------------------- - -.. _class_RealArray_RealArray: - -- :ref:`RealArray` **RealArray** **(** :ref:`Array` from **)** - -Create from a generic array. - -.. _class_RealArray_append: - -- void **append** **(** :ref:`float` value **)** - -Append an element at the end of the array (alias of :ref:`push_back`). - -.. _class_RealArray_append_array: - -- void **append_array** **(** :ref:`RealArray` array **)** - -Append an :ref:`RealArray` at the end of this array. - -.. _class_RealArray_insert: - -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`float` value **)** - -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_RealArray_invert: - -- void **invert** **(** **)** - -Reverse the order of the elements in the array (so first element will now be the last). - -.. _class_RealArray_push_back: - -- void **push_back** **(** :ref:`float` value **)** - -Append an element at the end of the array. - -.. _class_RealArray_remove: - -- void **remove** **(** :ref:`int` idx **)** - -Remove an element from the array by index. - -.. _class_RealArray_resize: - -- void **resize** **(** :ref:`int` idx **)** - -Set the size of the :ref:`RealArray`. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. - -.. _class_RealArray_set: - -- void **set** **(** :ref:`int` idx, :ref:`float` value **)** - -Change the float at the given index. - -.. _class_RealArray_size: - -- :ref:`int` **size** **(** **)** - -Return the size of the array. - - diff --git a/classes/class_rect3.rst b/classes/class_rect3.rst new file mode 100644 index 000000000..ae78946a1 --- /dev/null +++ b/classes/class_rect3.rst @@ -0,0 +1,204 @@ +.. 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_Rect3: + +Rect3 +===== + +**Category:** Built-In Types + +Brief Description +----------------- + +Axis-Aligned Bounding Box. + +Member Functions +---------------- + ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`Rect3` **(** :ref:`Vector3` pos, :ref:`Vector3` size **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`encloses` **(** :ref:`Rect3` with **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`expand` **(** :ref:`Vector3` to_point **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_area` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_endpoint` **(** :ref:`int` idx **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_longest_axis` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_longest_axis_index` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_longest_axis_size` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_shortest_axis` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shortest_axis_index` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_shortest_axis_size` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_support` **(** :ref:`Vector3` dir **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`grow` **(** :ref:`float` by **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_no_area` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_no_surface` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`intersection` **(** :ref:`Rect3` with **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`intersects` **(** :ref:`Rect3` with **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`intersects_plane` **(** :ref:`Plane` plane **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`intersects_segment` **(** :ref:`Vector3` from, :ref:`Vector3` to **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`merge` **(** :ref:`Rect3` with **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Vector3` **end** - Ending corner. +- :ref:`Vector3` **pos** - Position (starting corner). +- :ref:`Vector3` **size** - Size from position to end. + +Description +----------- + +Rect3 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_Rect3_Rect3: + +- :ref:`Rect3` **Rect3** **(** :ref:`Vector3` pos, :ref:`Vector3` size **)** + +Optional constructor, accepts position and size. + +.. _class_Rect3_encloses: + +- :ref:`bool` **encloses** **(** :ref:`Rect3` with **)** + +Return true if this :ref:`Rect3` completely encloses another one. + +.. _class_Rect3_expand: + +- :ref:`Rect3` **expand** **(** :ref:`Vector3` to_point **)** + +Return this :ref:`Rect3` expanded to include a given point. + +.. _class_Rect3_get_area: + +- :ref:`float` **get_area** **(** **)** + +Get the area of the :ref:`Rect3`. + +.. _class_Rect3_get_endpoint: + +- :ref:`Vector3` **get_endpoint** **(** :ref:`int` idx **)** + +Get the position of the 8 endpoints of the :ref:`Rect3` in space. + +.. _class_Rect3_get_longest_axis: + +- :ref:`Vector3` **get_longest_axis** **(** **)** + +Return the normalized longest axis of the :ref:`Rect3`. + +.. _class_Rect3_get_longest_axis_index: + +- :ref:`int` **get_longest_axis_index** **(** **)** + +Return the index of the longest axis of the :ref:`Rect3` (according to :ref:`Vector3`::AXIS\* enum). + +.. _class_Rect3_get_longest_axis_size: + +- :ref:`float` **get_longest_axis_size** **(** **)** + +Return the scalar length of the longest axis of the :ref:`Rect3`. + +.. _class_Rect3_get_shortest_axis: + +- :ref:`Vector3` **get_shortest_axis** **(** **)** + +Return the normalized shortest axis of the :ref:`Rect3`. + +.. _class_Rect3_get_shortest_axis_index: + +- :ref:`int` **get_shortest_axis_index** **(** **)** + +Return the index of the shortest axis of the :ref:`Rect3` (according to :ref:`Vector3`::AXIS\* enum). + +.. _class_Rect3_get_shortest_axis_size: + +- :ref:`float` **get_shortest_axis_size** **(** **)** + +Return the scalar length of the shortest axis of the :ref:`Rect3`. + +.. _class_Rect3_get_support: + +- :ref:`Vector3` **get_support** **(** :ref:`Vector3` dir **)** + +Return the support point in a given direction. This is useful for collision detection algorithms. + +.. _class_Rect3_grow: + +- :ref:`Rect3` **grow** **(** :ref:`float` by **)** + +Return a copy of the :ref:`Rect3` grown a given amount of units towards all the sides. + +.. _class_Rect3_has_no_area: + +- :ref:`bool` **has_no_area** **(** **)** + +Return true if the :ref:`Rect3` is flat or empty. + +.. _class_Rect3_has_no_surface: + +- :ref:`bool` **has_no_surface** **(** **)** + +Return true if the :ref:`Rect3` is empty. + +.. _class_Rect3_has_point: + +- :ref:`bool` **has_point** **(** :ref:`Vector3` point **)** + +Return true if the :ref:`Rect3` contains a point. + +.. _class_Rect3_intersection: + +- :ref:`Rect3` **intersection** **(** :ref:`Rect3` with **)** + +Return the intersection between two :ref:`Rect3`. An empty AABB (size 0,0,0) is returned on failure. + +.. _class_Rect3_intersects: + +- :ref:`bool` **intersects** **(** :ref:`Rect3` with **)** + +Return true if the :ref:`Rect3` overlaps with another. + +.. _class_Rect3_intersects_plane: + +- :ref:`bool` **intersects_plane** **(** :ref:`Plane` plane **)** + +Return true if the :ref:`Rect3` is at both sides of a plane. + +.. _class_Rect3_intersects_segment: + +- :ref:`bool` **intersects_segment** **(** :ref:`Vector3` from, :ref:`Vector3` to **)** + +Return true if the :ref:`Rect3` intersects the line segment between from and to + +.. _class_Rect3_merge: + +- :ref:`Rect3` **merge** **(** :ref:`Rect3` with **)** + +Combine this :ref:`Rect3` with another, a larger one is returned that contains both. + + diff --git a/classes/class_rectangleshape2d.rst b/classes/class_rectangleshape2d.rst index 72a52ca59..2c541bec6 100644 --- a/classes/class_rectangleshape2d.rst +++ b/classes/class_rectangleshape2d.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_extents` **(** :ref:`Vector2` extents **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Vector2` **extents** + Description ----------- diff --git a/classes/class_reference.rst b/classes/class_reference.rst index b82b2715b..7088c73ff 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -8,7 +8,7 @@ Reference **Inherits:** :ref:`Object` -**Inherited By:** :ref:`RegExMatch`, :ref:`RegEx`, :ref:`SurfaceTool`, :ref:`SpatialGizmo`, :ref:`EditorScenePostImport`, :ref:`PhysicsShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`Physics2DShapeQueryParameters`, :ref:`GDFunctionState`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorExportPlugin`, :ref:`EditorScript`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`Marshalls`, :ref:`AStar`, :ref:`SceneState`, :ref:`GDNativeClass`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`WeakRef`, :ref:`Resource`, :ref:`SceneTreeTimer`, :ref:`Thread`, :ref:`PackedDataContainerRef`, :ref:`ResourceInteractiveLoader`, :ref:`ResourceImportMetadata`, :ref:`PhysicsShapeQueryParameters` +**Inherited By:** :ref:`RegExMatch`, :ref:`SurfaceTool`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`PhysicsShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`Marshalls`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`GDFunctionState`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorScript`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`Directory`, :ref:`AStar`, :ref:`SceneState`, :ref:`GDNativeClass`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`WeakRef`, :ref:`ResourceImporter`, :ref:`Resource`, :ref:`SceneTreeTimer`, :ref:`Thread`, :ref:`PackedDataContainerRef`, :ref:`ResourceInteractiveLoader`, :ref:`PhysicsShapeQueryParameters` **Category:** Core diff --git a/classes/class_referenceframe.rst b/classes/class_referencerect.rst similarity index 90% rename from classes/class_referenceframe.rst rename to classes/class_referencerect.rst index 71bc487dd..4ddb1813d 100644 --- a/classes/class_referenceframe.rst +++ b/classes/class_referencerect.rst @@ -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_ReferenceFrame: +.. _class_ReferenceRect: -ReferenceFrame -============== +ReferenceRect +============= **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst new file mode 100644 index 000000000..80db9e4e5 --- /dev/null +++ b/classes/class_reflectionprobe.rst @@ -0,0 +1,192 @@ +.. 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_ReflectionProbe: + +ReflectionProbe +=============== + +**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_shadows_enabled` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cull_mask` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_extents` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_intensity` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_interior_ambient` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_interior_ambient_energy` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_interior_ambient_probe_contribution` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_max_distance` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_origin_offset` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_update_mode` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_box_projection_enabled` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_set_as_interior` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_interior` **(** :ref:`bool` enable **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cull_mask` **(** :ref:`int` layers **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enable_box_projection` **(** :ref:`bool` enable **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enable_shadows` **(** :ref:`bool` enable **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_extents` **(** :ref:`Vector3` extents **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_intensity` **(** :ref:`float` intensity **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_interior_ambient` **(** :ref:`Color` ambient **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_interior_ambient_energy` **(** :ref:`float` ambient_energy **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_interior_ambient_probe_contribution` **(** :ref:`float` ambient_probe_contribution **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_distance` **(** :ref:`float` max_distance **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_origin_offset` **(** :ref:`Vector3` origin_offset **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_update_mode` **(** :ref:`int` mode **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`bool` **box_projection** +- :ref:`int` **cull_mask** +- :ref:`bool` **enable_shadows** +- :ref:`Vector2` **extents** +- :ref:`float` **intensity** +- :ref:`Color` **interior_ambient_color** +- :ref:`float` **interior_ambient_contrib** +- :ref:`float` **interior_ambient_energy** +- :ref:`bool` **interior_enable** +- :ref:`float` **max_distance** +- :ref:`Vector2` **origin_offset** +- :ref:`int` **update_mode** + +Numeric Constants +----------------- + +- **UPDATE_ONCE** = **0** +- **UPDATE_ALWAYS** = **1** + +Member Function Description +--------------------------- + +.. _class_ReflectionProbe_are_shadows_enabled: + +- :ref:`bool` **are_shadows_enabled** **(** **)** const + +.. _class_ReflectionProbe_get_cull_mask: + +- :ref:`int` **get_cull_mask** **(** **)** const + +.. _class_ReflectionProbe_get_extents: + +- :ref:`Vector3` **get_extents** **(** **)** const + +.. _class_ReflectionProbe_get_intensity: + +- :ref:`float` **get_intensity** **(** **)** const + +.. _class_ReflectionProbe_get_interior_ambient: + +- :ref:`Color` **get_interior_ambient** **(** **)** const + +.. _class_ReflectionProbe_get_interior_ambient_energy: + +- :ref:`float` **get_interior_ambient_energy** **(** **)** const + +.. _class_ReflectionProbe_get_interior_ambient_probe_contribution: + +- :ref:`float` **get_interior_ambient_probe_contribution** **(** **)** const + +.. _class_ReflectionProbe_get_max_distance: + +- :ref:`float` **get_max_distance** **(** **)** const + +.. _class_ReflectionProbe_get_origin_offset: + +- :ref:`Vector3` **get_origin_offset** **(** **)** const + +.. _class_ReflectionProbe_get_update_mode: + +- :ref:`int` **get_update_mode** **(** **)** const + +.. _class_ReflectionProbe_is_box_projection_enabled: + +- :ref:`bool` **is_box_projection_enabled** **(** **)** const + +.. _class_ReflectionProbe_is_set_as_interior: + +- :ref:`bool` **is_set_as_interior** **(** **)** const + +.. _class_ReflectionProbe_set_as_interior: + +- void **set_as_interior** **(** :ref:`bool` enable **)** + +.. _class_ReflectionProbe_set_cull_mask: + +- void **set_cull_mask** **(** :ref:`int` layers **)** + +.. _class_ReflectionProbe_set_enable_box_projection: + +- void **set_enable_box_projection** **(** :ref:`bool` enable **)** + +.. _class_ReflectionProbe_set_enable_shadows: + +- void **set_enable_shadows** **(** :ref:`bool` enable **)** + +.. _class_ReflectionProbe_set_extents: + +- void **set_extents** **(** :ref:`Vector3` extents **)** + +.. _class_ReflectionProbe_set_intensity: + +- void **set_intensity** **(** :ref:`float` intensity **)** + +.. _class_ReflectionProbe_set_interior_ambient: + +- void **set_interior_ambient** **(** :ref:`Color` ambient **)** + +.. _class_ReflectionProbe_set_interior_ambient_energy: + +- void **set_interior_ambient_energy** **(** :ref:`float` ambient_energy **)** + +.. _class_ReflectionProbe_set_interior_ambient_probe_contribution: + +- void **set_interior_ambient_probe_contribution** **(** :ref:`float` ambient_probe_contribution **)** + +.. _class_ReflectionProbe_set_max_distance: + +- void **set_max_distance** **(** :ref:`float` max_distance **)** + +.. _class_ReflectionProbe_set_origin_offset: + +- void **set_origin_offset** **(** :ref:`Vector3` origin_offset **)** + +.. _class_ReflectionProbe_set_update_mode: + +- void **set_update_mode** **(** :ref:`int` mode **)** + + diff --git a/classes/class_regex.rst b/classes/class_regex.rst index b96a0387d..ce214162a 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -6,7 +6,7 @@ RegEx ===== -**Inherits:** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core @@ -36,6 +36,11 @@ Member Functions | :ref:`String` | :ref:`sub` **(** :ref:`String` text, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` start=0, :ref:`int` end=-1 **)** const | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`String` **pattern** + Description ----------- diff --git a/classes/class_regexmatch.rst b/classes/class_regexmatch.rst index 959fa309f..1bbbfce5e 100644 --- a/classes/class_regexmatch.rst +++ b/classes/class_regexmatch.rst @@ -49,7 +49,7 @@ Using results from the search, returns the specified string with escapes and bac - :ref:`int` **get_end** **(** :ref:`Variant` name=0 **)** const -Returns the end position of the match in the string. An interger can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern). +Returns the end position of the match in the string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern). .. _class_RegExMatch_get_group_array: @@ -79,12 +79,12 @@ Returns an array of names of named capturing groups. - :ref:`int` **get_start** **(** :ref:`Variant` name=0 **)** const -Returns the starting position of the match in the string. An interger can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern). +Returns the starting position of the match in the string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern). .. _class_RegExMatch_get_string: - :ref:`String` **get_string** **(** :ref:`Variant` name=0 **)** const -Returns the result of the match in the string. An interger can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern). +Returns the result of the match in the string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern). diff --git a/classes/class_remotetransform.rst b/classes/class_remotetransform.rst index c36c32182..59e66215e 100644 --- a/classes/class_remotetransform.rst +++ b/classes/class_remotetransform.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_remote_node` **(** :ref:`NodePath` path **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`NodePath` **remote_path** + Member Function Description --------------------------- diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index 631d83881..a9db83c34 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_remote_node` **(** :ref:`NodePath` path **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`NodePath` **remote_path** + Member Function Description --------------------------- diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 094644ba1..0c868a043 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -8,7 +8,7 @@ Resource **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`Theme`, :ref:`AudioStream`, :ref:`EventStream`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`Translation`, :ref:`Curve2D`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Shader`, :ref:`ColorRamp`, :ref:`StyleBox`, :ref:`Material`, :ref:`VideoStream`, :ref:`RoomBounds`, :ref:`PackedScene`, :ref:`Texture`, :ref:`Script`, :ref:`OccluderPolygon2D`, :ref:`Mesh`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`BitMap`, :ref:`Animation`, :ref:`Sample`, :ref:`PolygonPathFinder`, :ref:`BakedLight`, :ref:`World`, :ref:`SampleLibrary`, :ref:`VisualScriptNode`, :ref:`World2D`, :ref:`Font`, :ref:`SpriteFrames`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`MultiMesh`, :ref:`CanvasItemMaterial`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` +**Inherited By:** :ref:`Theme`, :ref:`AudioStream`, :ref:`RegEx`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`SpriteFrames`, :ref:`Translation`, :ref:`Curve2D`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Shader`, :ref:`ColorRamp`, :ref:`StyleBox`, :ref:`Material`, :ref:`VideoStream`, :ref:`RoomBounds`, :ref:`PackedScene`, :ref:`Texture`, :ref:`Script`, :ref:`OccluderPolygon2D`, :ref:`Mesh`, :ref:`ButtonGroup`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`BitMap`, :ref:`Animation`, :ref:`PolygonPathFinder`, :ref:`SkyBox`, :ref:`AudioBusLayout`, :ref:`World`, :ref:`AudioEffect`, :ref:`DLLibrary`, :ref:`VisualScriptNode`, :ref:`World2D`, :ref:`GIProbeData`, :ref:`Font`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`MultiMesh`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` **Category:** Core @@ -20,31 +20,44 @@ Base class for all resources. Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`duplicate` **(** :ref:`bool` subresources=false **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_import_metadata` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_path` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_rid` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_import_metadata` **(** :ref:`Object` metadata **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_name` **(** :ref:`String` name **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_path` **(** :ref:`String` path **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`take_over_path` **(** :ref:`String` path **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`_setup_local_to_scene` **(** **)** virtual | ++------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`duplicate` **(** :ref:`bool` subresources=false **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_local_scene` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_path` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_rid` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_local_to_scene` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_local_to_scene` **(** :ref:`bool` enable **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_name` **(** :ref:`String` name **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_path` **(** :ref:`String` path **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`setup_local_to_scene` **(** **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`take_over_path` **(** :ref:`String` path **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------+ Signals ------- - **changed** **(** **)** +Member Variables +---------------- + +- :ref:`bool` **resource_local_to_scene** +- :ref:`String` **resource_name** +- :ref:`String` **resource_path** + Description ----------- @@ -53,13 +66,17 @@ Resource is the base class for all resource types. Resources are primarily data Member Function Description --------------------------- +.. _class_Resource__setup_local_to_scene: + +- void **_setup_local_to_scene** **(** **)** virtual + .. _class_Resource_duplicate: - :ref:`Object` **duplicate** **(** :ref:`bool` subresources=false **)** -.. _class_Resource_get_import_metadata: +.. _class_Resource_get_local_scene: -- :ref:`Object` **get_import_metadata** **(** **)** const +- :ref:`Node` **get_local_scene** **(** **)** const .. _class_Resource_get_name: @@ -79,9 +96,13 @@ Return the path of the resource. This is useful mainly for editors when saving/l Return the RID of the resource (or an empty RID). Many resources (such as :ref:`Texture`, :ref:`Mesh`, etc) are high level abstractions of resources stored in a server, so this function will return the original RID. -.. _class_Resource_set_import_metadata: +.. _class_Resource_is_local_to_scene: -- void **set_import_metadata** **(** :ref:`Object` metadata **)** +- :ref:`bool` **is_local_to_scene** **(** **)** const + +.. _class_Resource_set_local_to_scene: + +- void **set_local_to_scene** **(** :ref:`bool` enable **)** .. _class_Resource_set_name: @@ -95,6 +116,10 @@ Set the name of the resources, any name is valid (it doesn't have to be unique). Set the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. Fails if another :ref:`Resource` already has path "path". +.. _class_Resource_setup_local_to_scene: + +- void **setup_local_to_scene** **(** **)** + .. _class_Resource_take_over_path: - void **take_over_path** **(** :ref:`String` path **)** diff --git a/classes/class_canvasitemshader.rst b/classes/class_resourceimporter.rst similarity index 51% rename from classes/class_canvasitemshader.rst rename to classes/class_resourceimporter.rst index 57d7442dc..8f29a5495 100644 --- a/classes/class_canvasitemshader.rst +++ b/classes/class_resourceimporter.rst @@ -1,12 +1,14 @@ .. 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_CanvasItemShader: +.. _class_ResourceImporter: -CanvasItemShader +ResourceImporter ================ -**Inherits:** :ref:`Shader` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`ResourceImporterOGGVorbis` **Category:** Core diff --git a/classes/class_resourceimporteroggvorbis.rst b/classes/class_resourceimporteroggvorbis.rst new file mode 100644 index 000000000..1cfc996cc --- /dev/null +++ b/classes/class_resourceimporteroggvorbis.rst @@ -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_ResourceImporterOGGVorbis: + +ResourceImporterOGGVorbis +========================= + +**Inherits:** :ref:`ResourceImporter` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceimportmetadata.rst b/classes/class_resourceimportmetadata.rst deleted file mode 100644 index 599c3f1d8..000000000 --- a/classes/class_resourceimportmetadata.rst +++ /dev/null @@ -1,92 +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_ResourceImportMetadata: - -ResourceImportMetadata -====================== - -**Inherits:** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - -Member Functions ----------------- - -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_source` **(** :ref:`String` path, :ref:`String` md5="" **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_editor` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_option` **(** :ref:`String` key **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_options` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_source_count` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_source_md5` **(** :ref:`int` idx **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_source_path` **(** :ref:`int` idx **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_source` **(** :ref:`int` idx **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editor` **(** :ref:`String` name **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_option` **(** :ref:`String` key, :ref:`Variant` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_source_md5` **(** :ref:`int` idx, :ref:`String` md5 **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - -Member Function Description ---------------------------- - -.. _class_ResourceImportMetadata_add_source: - -- void **add_source** **(** :ref:`String` path, :ref:`String` md5="" **)** - -.. _class_ResourceImportMetadata_get_editor: - -- :ref:`String` **get_editor** **(** **)** const - -.. _class_ResourceImportMetadata_get_option: - -- void **get_option** **(** :ref:`String` key **)** const - -.. _class_ResourceImportMetadata_get_options: - -- :ref:`StringArray` **get_options** **(** **)** const - -.. _class_ResourceImportMetadata_get_source_count: - -- :ref:`int` **get_source_count** **(** **)** const - -.. _class_ResourceImportMetadata_get_source_md5: - -- :ref:`String` **get_source_md5** **(** :ref:`int` idx **)** const - -.. _class_ResourceImportMetadata_get_source_path: - -- :ref:`String` **get_source_path** **(** :ref:`int` idx **)** const - -.. _class_ResourceImportMetadata_remove_source: - -- void **remove_source** **(** :ref:`int` idx **)** - -.. _class_ResourceImportMetadata_set_editor: - -- void **set_editor** **(** :ref:`String` name **)** - -.. _class_ResourceImportMetadata_set_option: - -- void **set_option** **(** :ref:`String` key, :ref:`Variant` value **)** - -.. _class_ResourceImportMetadata_set_source_md5: - -- void **set_source_md5** **(** :ref:`int` idx, :ref:`String` md5 **)** - - diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index 4959cb9e0..98f4c2efd 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -19,16 +19,14 @@ Member Functions ---------------- +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_dependencies` **(** :ref:`String` path **)** | +| :ref:`PoolStringArray` | :ref:`get_dependencies` **(** :ref:`String` path **)** | +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_recognized_extensions_for_type` **(** :ref:`String` type **)** | +| :ref:`PoolStringArray` | :ref:`get_recognized_extensions_for_type` **(** :ref:`String` type **)** | +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has` **(** :ref:`String` path **)** | +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Resource` | :ref:`load` **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** | +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ResourceImportMetadata` | :ref:`load_import_metadata` **(** :ref:`String` path **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ResourceInteractiveLoader` | :ref:`load_interactive` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_abort_on_missing_resources` **(** :ref:`bool` abort **)** | @@ -44,11 +42,11 @@ Member Function Description .. _class_ResourceLoader_get_dependencies: -- :ref:`StringArray` **get_dependencies** **(** :ref:`String` path **)** +- :ref:`PoolStringArray` **get_dependencies** **(** :ref:`String` path **)** .. _class_ResourceLoader_get_recognized_extensions_for_type: -- :ref:`StringArray` **get_recognized_extensions_for_type** **(** :ref:`String` type **)** +- :ref:`PoolStringArray` **get_recognized_extensions_for_type** **(** :ref:`String` type **)** Return the list of recognized extensions for a resource type. @@ -60,10 +58,6 @@ Return the list of recognized extensions for a resource type. - :ref:`Resource` **load** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** -.. _class_ResourceLoader_load_import_metadata: - -- :ref:`ResourceImportMetadata` **load_import_metadata** **(** :ref:`String` path **)** - .. _class_ResourceLoader_load_interactive: - :ref:`ResourceInteractiveLoader` **load_interactive** **(** :ref:`String` path, :ref:`String` type_hint="" **)** diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index b753a81a9..b55c4e147 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -18,19 +18,24 @@ Resource Preloader Node. Member Functions ---------------- -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_resource` **(** :ref:`String` name, :ref:`Object` resource **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_resource` **(** :ref:`String` name **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_resource_list` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_resource` **(** :ref:`String` name **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_resource` **(** :ref:`String` name **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_resource` **(** :ref:`String` name, :ref:`String` newname **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_resource` **(** :ref:`String` name, :ref:`Object` resource **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_resource` **(** :ref:`String` name **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_resource_list` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_resource` **(** :ref:`String` name **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_resource` **(** :ref:`String` name **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_resource` **(** :ref:`String` name, :ref:`String` newname **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Array` **resources** Description ----------- @@ -54,7 +59,7 @@ Return the resource given a text-id. .. _class_ResourcePreloader_get_resource_list: -- :ref:`StringArray` **get_resource_list** **(** **)** const +- :ref:`PoolStringArray` **get_resource_list** **(** **)** const Return the list of resources inside the preloader. diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index 35e1927ad..1c7ab2cee 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -18,11 +18,11 @@ Resource Saving Interface. Member Functions ---------------- -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_recognized_extensions` **(** :ref:`Object` type **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Object` type **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -44,7 +44,7 @@ Member Function Description .. _class_ResourceSaver_get_recognized_extensions: -- :ref:`StringArray` **get_recognized_extensions** **(** :ref:`Object` type **)** +- :ref:`PoolStringArray` **get_recognized_extensions** **(** :ref:`Object` type **)** Return the list of extensions available for saving a resource of a given type. diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index edd1ff2cb..28cfdf08c 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -73,6 +73,8 @@ Member Functions +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`push_underline` **(** **)** | +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`remove_line` **(** :ref:`int` arg0 **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`scroll_to_line` **(** :ref:`int` line **)** | +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bbcode` **(** :ref:`String` text **)** | @@ -99,6 +101,13 @@ Signals - **meta_clicked** **(** :ref:`Nil` meta **)** +Member Variables +---------------- + +- :ref:`bool` **bbcode_enabled** +- :ref:`String` **bbcode_text** +- :ref:`int` **visible_characters** + Numeric Constants ----------------- @@ -241,6 +250,10 @@ Return true if selecting the text inside this richtext is allowed. - void **push_underline** **(** **)** +.. _class_RichTextLabel_remove_line: + +- :ref:`bool` **remove_line** **(** :ref:`int` arg0 **)** + .. _class_RichTextLabel_scroll_to_line: - void **scroll_to_line** **(** :ref:`int` line **)** diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index 3fac31066..49ccc5a2d 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -99,12 +99,33 @@ Member Functions Signals ------- -- **body_enter** **(** :ref:`Object` body **)** -- **body_enter_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** -- **body_exit** **(** :ref:`Object` body **)** -- **body_exit_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_entered** **(** :ref:`Object` body **)** +- **body_exited** **(** :ref:`Object` body **)** +- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** - **sleeping_state_changed** **(** **)** +Member Variables +---------------- + +- :ref:`float` **angular_damp** +- :ref:`Vector3` **angular_velocity** +- :ref:`int` **axis_lock** +- :ref:`float` **bounce** +- :ref:`bool` **can_sleep** +- :ref:`bool` **contact_monitor** +- :ref:`int` **contacts_reported** +- :ref:`bool` **continuous_cd** +- :ref:`bool` **custom_integrator** +- :ref:`float` **friction** +- :ref:`float` **gravity_scale** +- :ref:`float` **linear_damp** +- :ref:`Vector3` **linear_velocity** +- :ref:`float` **mass** +- :ref:`int` **mode** +- :ref:`bool` **sleeping** +- :ref:`float` **weight** + Numeric Constants ----------------- diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index c8da501c5..71f62f24a 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -111,12 +111,32 @@ Member Functions Signals ------- -- **body_enter** **(** :ref:`Object` body **)** -- **body_enter_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** -- **body_exit** **(** :ref:`Object` body **)** -- **body_exit_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_entered** **(** :ref:`Object` body **)** +- **body_exited** **(** :ref:`Object` body **)** +- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** - **sleeping_state_changed** **(** **)** +Member Variables +---------------- + +- :ref:`float` **angular_damp** +- :ref:`float` **angular_velocity** +- :ref:`float` **bounce** +- :ref:`bool` **can_sleep** +- :ref:`bool` **contact_monitor** +- :ref:`int` **contacts_reported** +- :ref:`int` **continuous_cd** +- :ref:`bool` **custom_integrator** +- :ref:`float` **friction** +- :ref:`float` **gravity_scale** +- :ref:`float` **linear_damp** +- :ref:`Vector2` **linear_velocity** +- :ref:`float` **mass** +- :ref:`int` **mode** +- :ref:`bool` **sleeping** +- :ref:`float` **weight** + Numeric Constants ----------------- diff --git a/classes/class_room.rst b/classes/class_room.rst index 24f0a0abe..a6bd15e8d 100644 --- a/classes/class_room.rst +++ b/classes/class_room.rst @@ -18,17 +18,16 @@ Room data resource. Member Functions ---------------- -+--------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`compute_room_from_subtree` **(** **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`Room` | :ref:`get_room` **(** **)** const | -+--------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_simulating_acoustics` **(** **)** const | -+--------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_room` **(** :ref:`Room` room **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_simulate_acoustics` **(** :ref:`bool` enable **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------+ ++--------------------------+---------------------------------------------------------------------------------+ +| :ref:`Room` | :ref:`get_room` **(** **)** const | ++--------------------------+---------------------------------------------------------------------------------+ +| void | :ref:`set_room` **(** :ref:`Room` room **)** | ++--------------------------+---------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Area` **room/room** Description ----------- @@ -38,24 +37,12 @@ Room contains the data to define the bounds of a scene (using a BSP Tree). It is Member Function Description --------------------------- -.. _class_Room_compute_room_from_subtree: - -- void **compute_room_from_subtree** **(** **)** - .. _class_Room_get_room: - :ref:`Room` **get_room** **(** **)** const -.. _class_Room_is_simulating_acoustics: - -- :ref:`bool` **is_simulating_acoustics** **(** **)** const - .. _class_Room_set_room: - void **set_room** **(** :ref:`Room` room **)** -.. _class_Room_set_simulate_acoustics: - -- void **set_simulate_acoustics** **(** :ref:`bool` enable **)** - diff --git a/classes/class_roombounds.rst b/classes/class_roombounds.rst index aac964541..7cae72842 100644 --- a/classes/class_roombounds.rst +++ b/classes/class_roombounds.rst @@ -18,45 +18,26 @@ Brief Description Member Functions ---------------- -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_bounds` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3Array` | :ref:`get_geometry_hint` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`regenerate_bsp` **(** **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`regenerate_bsp_cubic` **(** **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bounds` **(** :ref:`Dictionary` bsp_tree **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_geometry_hint` **(** :ref:`Vector3Array` triangles **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_geometry_hint` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_geometry_hint` **(** :ref:`PoolVector3Array` triangles **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`PoolVector3Array` **geometry_hint** Member Function Description --------------------------- -.. _class_RoomBounds_get_bounds: - -- :ref:`Dictionary` **get_bounds** **(** **)** const - .. _class_RoomBounds_get_geometry_hint: -- :ref:`Vector3Array` **get_geometry_hint** **(** **)** const - -.. _class_RoomBounds_regenerate_bsp: - -- void **regenerate_bsp** **(** **)** - -.. _class_RoomBounds_regenerate_bsp_cubic: - -- void **regenerate_bsp_cubic** **(** **)** - -.. _class_RoomBounds_set_bounds: - -- void **set_bounds** **(** :ref:`Dictionary` bsp_tree **)** +- :ref:`PoolVector3Array` **get_geometry_hint** **(** **)** const .. _class_RoomBounds_set_geometry_hint: -- void **set_geometry_hint** **(** :ref:`Vector3Array` triangles **)** +- void **set_geometry_hint** **(** :ref:`PoolVector3Array` triangles **)** diff --git a/classes/class_sample.rst b/classes/class_sample.rst deleted file mode 100644 index 53d8b1687..000000000 --- a/classes/class_sample.rst +++ /dev/null @@ -1,157 +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_Sample: - -Sample -====== - -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Audio sample (sound) class. - -Member Functions ----------------- - -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create` **(** :ref:`int` format, :ref:`bool` stereo, :ref:`int` length **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`get_data` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_format` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_length` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_loop_begin` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_loop_end` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_loop_format` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mix_rate` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_stereo` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_data` **(** :ref:`RawArray` data **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop_begin` **(** :ref:`int` pos **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop_end` **(** :ref:`int` pos **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop_format` **(** :ref:`int` format **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mix_rate` **(** :ref:`int` hz **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - -Numeric Constants ------------------ - -- **FORMAT_PCM8** = **0** --- 8-bits signed PCM audio. -- **FORMAT_PCM16** = **1** --- 16-bits signed little endian PCM audio. -- **FORMAT_IMA_ADPCM** = **2** --- IMA-ADPCM Audio. -- **LOOP_NONE** = **0** --- No loop enabled. -- **LOOP_FORWARD** = **1** --- Forward looping (when playback reaches loop end, goes back to loop begin). -- **LOOP_PING_PONG** = **2** --- Ping-pong looping (when playback reaches loop end, plays backward until loop begin). Not available in all platforms. - -Description ------------ - -Sample provides an audio sample class, containing audio data, together with some information for playback, such as format, mix rate and loop. It is used by sound playback routines. - -Member Function Description ---------------------------- - -.. _class_Sample_create: - -- void **create** **(** :ref:`int` format, :ref:`bool` stereo, :ref:`int` length **)** - -Create new data for the sample, with format (see FORMAT\_\* constants), stereo hint, and length in samples (not bytes). - -Calling this method overrides previously existing data. Stereo samples are interleaved pairs of left and right points (in that order), but count as one sample for length purposes. - -.. _class_Sample_get_data: - -- :ref:`RawArray` **get_data** **(** **)** const - -Return sample data as little endian. - -.. _class_Sample_get_format: - -- :ref:`int` **get_format** **(** **)** const - -Return the sample format. - -.. _class_Sample_get_length: - -- :ref:`int` **get_length** **(** **)** const - -Return the sample length in samples. Stereo samples count as one, even if they are made of a left and a right sample. - -.. _class_Sample_get_loop_begin: - -- :ref:`int` **get_loop_begin** **(** **)** const - -Return the loop begin position. - -.. _class_Sample_get_loop_end: - -- :ref:`int` **get_loop_end** **(** **)** const - -Return the loop end position. - -.. _class_Sample_get_loop_format: - -- :ref:`int` **get_loop_format** **(** **)** const - -Return the loop format. - -.. _class_Sample_get_mix_rate: - -- :ref:`int` **get_mix_rate** **(** **)** const - -Return the mix rate for the sample. - -.. _class_Sample_is_stereo: - -- :ref:`bool` **is_stereo** **(** **)** const - -Return whether the current sample was created as stereo. - -.. _class_Sample_set_data: - -- void **set_data** **(** :ref:`RawArray` data **)** - -Set sample data. Data must be little endian, no matter the host platform, and exactly as long as to fit all samples. The length of this array can be calculated as follows: - -Get the sample length (:ref:`get_length`). If the sample format is FORMAT_PCM16, multiply it by 2. If the sample format is FORMAT_IMA_ADPCM, divide it by 2 (rounding any fraction up), then add 4. If the sample is stereo (:ref:`is_stereo`), multiply it by 2. - -.. _class_Sample_set_loop_begin: - -- void **set_loop_begin** **(** :ref:`int` pos **)** - -Set the loop begin position. It must be a valid frame and less than the loop end position. - -.. _class_Sample_set_loop_end: - -- void **set_loop_end** **(** :ref:`int` pos **)** - -Set the loop end position. It must be a valid frame and greater than the loop begin position. - -.. _class_Sample_set_loop_format: - -- void **set_loop_format** **(** :ref:`int` format **)** - -Set the loop format (use LOOP\_\* constants as argument). - -.. _class_Sample_set_mix_rate: - -- void **set_mix_rate** **(** :ref:`int` hz **)** - -Set the mix rate for the sample (expected playback frequency). - - diff --git a/classes/class_samplelibrary.rst b/classes/class_samplelibrary.rst deleted file mode 100644 index 2f4333566..000000000 --- a/classes/class_samplelibrary.rst +++ /dev/null @@ -1,101 +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_SampleLibrary: - -SampleLibrary -============= - -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Library that contains a collection of samples. - -Member Functions ----------------- - -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_sample` **(** :ref:`String` name, :ref:`Sample` sample **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Sample` | :ref:`get_sample` **(** :ref:`String` name **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_sample_list` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_sample` **(** :ref:`String` name **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_sample` **(** :ref:`String` name **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sample_get_pitch_scale` **(** :ref:`String` name **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sample_get_volume_db` **(** :ref:`String` name **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sample_set_pitch_scale` **(** :ref:`String` name, :ref:`float` pitch **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sample_set_volume_db` **(** :ref:`String` name, :ref:`float` db **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Description ------------ - -Library that contains a collection of :ref:`Sample`, each identified by a text ID. This is used as a data container for the majority of the SamplePlayer classes and derivatives. - -Member Function Description ---------------------------- - -.. _class_SampleLibrary_add_sample: - -- void **add_sample** **(** :ref:`String` name, :ref:`Sample` sample **)** - -Add a sample to the library, with a given text ID. - -.. _class_SampleLibrary_get_sample: - -- :ref:`Sample` **get_sample** **(** :ref:`String` name **)** const - -Return the sample from the library matching the given text ID. Return null if the sample is not found. - -.. _class_SampleLibrary_get_sample_list: - -- :ref:`Array` **get_sample_list** **(** **)** const - -.. _class_SampleLibrary_has_sample: - -- :ref:`bool` **has_sample** **(** :ref:`String` name **)** const - -Return true if the sample text ID exists in the library. - -.. _class_SampleLibrary_remove_sample: - -- void **remove_sample** **(** :ref:`String` name **)** - -Remove the sample matching the given text ID. - -.. _class_SampleLibrary_sample_get_pitch_scale: - -- :ref:`float` **sample_get_pitch_scale** **(** :ref:`String` name **)** const - -Return the pitch scale for the given sample. - -.. _class_SampleLibrary_sample_get_volume_db: - -- :ref:`float` **sample_get_volume_db** **(** :ref:`String` name **)** const - -Return the volume (in dB) for the given sample. - -.. _class_SampleLibrary_sample_set_pitch_scale: - -- void **sample_set_pitch_scale** **(** :ref:`String` name, :ref:`float` pitch **)** - -Set the pitch scale for the given sample. - -.. _class_SampleLibrary_sample_set_volume_db: - -- void **sample_set_volume_db** **(** :ref:`String` name, :ref:`float` db **)** - -Set the volume (in dB) for the given sample. - - diff --git a/classes/class_sampleplayer.rst b/classes/class_sampleplayer.rst deleted file mode 100644 index 7256a75bd..000000000 --- a/classes/class_sampleplayer.rst +++ /dev/null @@ -1,479 +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_SamplePlayer: - -SamplePlayer -============ - -**Inherits:** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Sample Player node. - -Member Functions ----------------- - -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_chorus` **(** :ref:`int` voice **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_default_chorus` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_default_filter_cutoff` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_default_filter_gain` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_default_filter_resonance` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_default_filter_type` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_default_pan` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_default_pan_depth` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_default_pan_height` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_default_pitch_scale` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_default_reverb` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_default_reverb_room` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_default_volume` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_default_volume_db` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_filter_cutoff` **(** :ref:`int` voice **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_filter_gain` **(** :ref:`int` voice **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_filter_resonance` **(** :ref:`int` voice **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_filter_type` **(** :ref:`int` voice **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mix_rate` **(** :ref:`int` voice **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pan` **(** :ref:`int` voice **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pan_depth` **(** :ref:`int` voice **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pan_height` **(** :ref:`int` voice **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pitch_scale` **(** :ref:`int` voice **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_polyphony` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_reverb` **(** :ref:`int` voice **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_reverb_room` **(** :ref:`int` voice **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SampleLibrary` | :ref:`get_sample_library` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume` **(** :ref:`int` voice **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume_db` **(** :ref:`int` voice **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_voice_active` **(** :ref:`int` voice **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`play` **(** :ref:`String` name, :ref:`bool` unique=false **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_chorus` **(** :ref:`int` voice, :ref:`float` send **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_chorus` **(** :ref:`float` send **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_filter` **(** :ref:`int` type, :ref:`float` cutoff_hz, :ref:`float` resonance, :ref:`float` gain=0 **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_pan` **(** :ref:`float` pan, :ref:`float` depth=0, :ref:`float` height=0 **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_pitch_scale` **(** :ref:`float` ratio **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_reverb` **(** :ref:`int` room_type, :ref:`float` send **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_volume` **(** :ref:`float` volume **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_volume_db` **(** :ref:`float` db **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filter` **(** :ref:`int` voice, :ref:`int` type, :ref:`float` cutoff_hz, :ref:`float` resonance, :ref:`float` gain=0 **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mix_rate` **(** :ref:`int` voice, :ref:`int` hz **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pan` **(** :ref:`int` voice, :ref:`float` pan, :ref:`float` depth=0, :ref:`float` height=0 **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pitch_scale` **(** :ref:`int` voice, :ref:`float` ratio **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_polyphony` **(** :ref:`int` max_voices **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_reverb` **(** :ref:`int` voice, :ref:`int` room_type, :ref:`float` send **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sample_library` **(** :ref:`SampleLibrary` library **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume` **(** :ref:`int` voice, :ref:`float` volume **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume_db` **(** :ref:`int` voice, :ref:`float` db **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** :ref:`int` voice **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop_all` **(** **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Numeric Constants ------------------ - -- **FILTER_NONE** = **0** --- Filter is disabled for voice. -- **FILTER_LOWPASS** = **1** --- Low-pass filter is used for voice. -- **FILTER_BANDPASS** = **2** --- Band-pass filter is used for voice. -- **FILTER_HIPASS** = **3** --- High-pass filter is used for voice. -- **FILTER_NOTCH** = **4** --- Notch (band reject) filter is used for voice. -- **FILTER_PEAK** = **5** --- Peak (exclusive band) filter is used for voice. -- **FILTER_BANDLIMIT** = **6** --- Band-limit filter is used for voice, in this case resonance is the high-pass cutoff. A band-limit filter has a different frequency response than a notch filter, but otherwise both are band-rejecting filters. -- **FILTER_LOW_SHELF** = **7** --- Low-shelf filter is used for voice. -- **FILTER_HIGH_SHELF** = **8** --- High-shelf filter is used for voice. -- **REVERB_SMALL** = **0** --- Small reverberation room (house room). -- **REVERB_MEDIUM** = **1** --- Medium reverberation room (street) -- **REVERB_LARGE** = **2** --- Large reverberation room (theatre) -- **REVERB_HALL** = **3** --- Huge reverberation room (cathedral, warehouse). -- **INVALID_VOICE_ID** = **-1** --- Value returned if the voice ID is invalid. - -Description ------------ - -SamplePlayer is a :ref:`Node` meant for simple sample playback. A library of samples is loaded and played back "as is", without positioning or anything. - -Member Function Description ---------------------------- - -.. _class_SamplePlayer_get_chorus: - -- :ref:`float` **get_chorus** **(** :ref:`int` voice **)** const - -Return the current chorus send level for a given voice. - -.. _class_SamplePlayer_get_default_chorus: - -- :ref:`float` **get_default_chorus** **(** **)** const - -Return the default chorus send level of the player. - -.. _class_SamplePlayer_get_default_filter_cutoff: - -- :ref:`float` **get_default_filter_cutoff** **(** **)** const - -Return the default filter cutoff frequency of the player. - -.. _class_SamplePlayer_get_default_filter_gain: - -- :ref:`float` **get_default_filter_gain** **(** **)** const - -Return the default filter gain of the player. - -.. _class_SamplePlayer_get_default_filter_resonance: - -- :ref:`float` **get_default_filter_resonance** **(** **)** const - -Return the default filter resonance of the player. - -.. _class_SamplePlayer_get_default_filter_type: - -- :ref:`int` **get_default_filter_type** **(** **)** const - -Return the default filter type in use (see FILTER\_\* constants) for the player. - -.. _class_SamplePlayer_get_default_pan: - -- :ref:`float` **get_default_pan** **(** **)** const - -Return the default panning of the player. - -.. _class_SamplePlayer_get_default_pan_depth: - -- :ref:`float` **get_default_pan_depth** **(** **)** const - -Return the default pan depth of the player. - -.. _class_SamplePlayer_get_default_pan_height: - -- :ref:`float` **get_default_pan_height** **(** **)** const - -Return the default pan height of the player. - -.. _class_SamplePlayer_get_default_pitch_scale: - -- :ref:`float` **get_default_pitch_scale** **(** **)** const - -Return the default pitch scale of the player. - -.. _class_SamplePlayer_get_default_reverb: - -- :ref:`float` **get_default_reverb** **(** **)** const - -Return the default reverberation send level of the player. - -.. _class_SamplePlayer_get_default_reverb_room: - -- :ref:`int` **get_default_reverb_room** **(** **)** const - -Return the default reverberation room type of the player (see REVERB\_\* enum). - -.. _class_SamplePlayer_get_default_volume: - -- :ref:`float` **get_default_volume** **(** **)** const - -Return the default volume (on a linear scale) of the player. - -.. _class_SamplePlayer_get_default_volume_db: - -- :ref:`float` **get_default_volume_db** **(** **)** const - -Return the default volume (in dB) of the player. - -.. _class_SamplePlayer_get_filter_cutoff: - -- :ref:`float` **get_filter_cutoff** **(** :ref:`int` voice **)** const - -Return the current filter cutoff frequency for a given voice. - -.. _class_SamplePlayer_get_filter_gain: - -- :ref:`float` **get_filter_gain** **(** :ref:`int` voice **)** const - -Return the current filter gain for a given voice. - -.. _class_SamplePlayer_get_filter_resonance: - -- :ref:`float` **get_filter_resonance** **(** :ref:`int` voice **)** const - -Return the current filter resonance for a given voice. - -.. _class_SamplePlayer_get_filter_type: - -- :ref:`int` **get_filter_type** **(** :ref:`int` voice **)** const - -Return the current filter type in use (see FILTER\_\* constants) for a given voice. - -.. _class_SamplePlayer_get_mix_rate: - -- :ref:`int` **get_mix_rate** **(** :ref:`int` voice **)** const - -Return the current mix rate for a given voice. - -.. _class_SamplePlayer_get_pan: - -- :ref:`float` **get_pan** **(** :ref:`int` voice **)** const - -Return the current panning for a given voice. - -.. _class_SamplePlayer_get_pan_depth: - -- :ref:`float` **get_pan_depth** **(** :ref:`int` voice **)** const - -Return the current pan depth for a given voice. - -.. _class_SamplePlayer_get_pan_height: - -- :ref:`float` **get_pan_height** **(** :ref:`int` voice **)** const - -Return the current pan height for a given voice. - -.. _class_SamplePlayer_get_pitch_scale: - -- :ref:`float` **get_pitch_scale** **(** :ref:`int` voice **)** const - -Return the current pitch scale for a given voice. - -.. _class_SamplePlayer_get_polyphony: - -- :ref:`int` **get_polyphony** **(** **)** const - -Return the polyphony of the player. - -.. _class_SamplePlayer_get_reverb: - -- :ref:`float` **get_reverb** **(** :ref:`int` voice **)** const - -Return the current reverberation send level for a given voice. - -.. _class_SamplePlayer_get_reverb_room: - -- :ref:`int` **get_reverb_room** **(** :ref:`int` voice **)** const - -Return the current reverberation room type for a given voice (see REVERB\_\* enum). - -.. _class_SamplePlayer_get_sample_library: - -- :ref:`SampleLibrary` **get_sample_library** **(** **)** const - -Return the sample library used by the player. - -.. _class_SamplePlayer_get_volume: - -- :ref:`float` **get_volume** **(** :ref:`int` voice **)** const - -Return the current volume (on a linear scale) for a given voice. - -.. _class_SamplePlayer_get_volume_db: - -- :ref:`float` **get_volume_db** **(** :ref:`int` voice **)** const - -Return the current volume (in dB) for a given voice. - -.. _class_SamplePlayer_is_active: - -- :ref:`bool` **is_active** **(** **)** const - -Return whether the player is currently active. - -.. _class_SamplePlayer_is_voice_active: - -- :ref:`bool` **is_voice_active** **(** :ref:`int` voice **)** const - -Return whether the given voice is currently active. - -.. _class_SamplePlayer_play: - -- :ref:`int` **play** **(** :ref:`String` name, :ref:`bool` unique=false **)** - -Play a sample referenced by its name. - -Optionally, the playback can be made "unique" to force stopping all other samples currently played. The voices allocated for playback will then be returned. - -.. _class_SamplePlayer_set_chorus: - -- void **set_chorus** **(** :ref:`int` voice, :ref:`float` send **)** - -Set the chorus send level of a voice (from 0 to 1.0). For setting chorus parameters, see :ref:`AudioServer`. - -.. _class_SamplePlayer_set_default_chorus: - -- void **set_default_chorus** **(** :ref:`float` send **)** - -Set the default chorus send level of the player (from 0 to 1.0). For setting chorus parameters, see :ref:`AudioServer`. - -.. _class_SamplePlayer_set_default_filter: - -- void **set_default_filter** **(** :ref:`int` type, :ref:`float` cutoff_hz, :ref:`float` resonance, :ref:`float` gain=0 **)** - -Set the default filter for the player, using the given type (see FILTER\_\* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0). - -Optionally, a gain can also be given (from 0 to 2.0). - -.. _class_SamplePlayer_set_default_pan: - -- void **set_default_pan** **(** :ref:`float` pan, :ref:`float` depth=0, :ref:`float` height=0 **)** - -Set the default panning of the player. Panning goes from -1.0 (left) to +1.0 (right). - -Optionally, for hardware than support 3D sound, one can also set depth and height (also in range -1.0 to +1.0). - -.. _class_SamplePlayer_set_default_pitch_scale: - -- void **set_default_pitch_scale** **(** :ref:`float` ratio **)** - -Set the default pitch scale of the player. A ratio of 1.0 is the normal scale. - -.. _class_SamplePlayer_set_default_reverb: - -- void **set_default_reverb** **(** :ref:`int` room_type, :ref:`float` send **)** - -Set the default reverberation type (see REVERB\_\* constants) and send level (from 0 to 1.0) of the player. - -.. _class_SamplePlayer_set_default_volume: - -- void **set_default_volume** **(** :ref:`float` volume **)** - -Set the default volume of the player using a linear scale. - -The "volume" argument should be a positive factor ranging from 0.0 (mute) up to 16.0 (i.e. 24 dB). - -A factor of 1.0 means that the voice will be played at normal system volume. Factors above 1.0 might be limited by the platform's audio output. - -.. _class_SamplePlayer_set_default_volume_db: - -- void **set_default_volume_db** **(** :ref:`float` db **)** - -Set the default volume of the player in dB. - -The "dB" argument can range from -80 to 24 dB, 0 dB being the maximum volume. Every 6 dB (resp. -6 dB), the volume is increased (resp. reduced) by half. - -.. _class_SamplePlayer_set_filter: - -- void **set_filter** **(** :ref:`int` voice, :ref:`int` type, :ref:`float` cutoff_hz, :ref:`float` resonance, :ref:`float` gain=0 **)** - -Set the filter for a given voice, using the given type (see FILTER\_\* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0). - -Optionally, a gain can also be given (from 0 to 2.0). - -.. _class_SamplePlayer_set_mix_rate: - -- void **set_mix_rate** **(** :ref:`int` voice, :ref:`int` hz **)** - -Set the mix rate (in Hz) of a given voice. - -.. _class_SamplePlayer_set_pan: - -- void **set_pan** **(** :ref:`int` voice, :ref:`float` pan, :ref:`float` depth=0, :ref:`float` height=0 **)** - -Set the panning of a voice. Panning goes from -1.0 (left) to +1.0 (right). - -Optionally, for hardware than support 3D sound, one can also set depth and height (also in range -1.0 to +1.0). - -.. _class_SamplePlayer_set_pitch_scale: - -- void **set_pitch_scale** **(** :ref:`int` voice, :ref:`float` ratio **)** - -Set the pitch scale of a given voice. A ratio of 1.0 is the normal scale. - -.. _class_SamplePlayer_set_polyphony: - -- void **set_polyphony** **(** :ref:`int` max_voices **)** - -Set the polyphony of the player (maximum amount of simultaneous voices). - -.. _class_SamplePlayer_set_reverb: - -- void **set_reverb** **(** :ref:`int` voice, :ref:`int` room_type, :ref:`float` send **)** - -Set the reverberation type (see REVERB\_\* constants) and send level (from 0 to 1.0) of a voice. - -.. _class_SamplePlayer_set_sample_library: - -- void **set_sample_library** **(** :ref:`SampleLibrary` library **)** - -Set the sample library for the player. - -.. _class_SamplePlayer_set_volume: - -- void **set_volume** **(** :ref:`int` voice, :ref:`float` volume **)** - -Set the volume of a given voice using a linear scale. - -The "volume" argument should be a positive factor ranging from 0.0 (mute) up to 16.0 (i.e. 24 dB). - -A factor of 1.0 means that the voice will be played at normal system volume. Factors above 1.0 might be limited by the platform's audio output. - -.. _class_SamplePlayer_set_volume_db: - -- void **set_volume_db** **(** :ref:`int` voice, :ref:`float` db **)** - -Set the volume of a given voice in dB. - -The "dB" argument can range from -80 to 24 dB, 0 dB being the maximum volume. Every 6 dB (resp. -6 dB), the volume is increased (resp. reduced) by half. - -.. _class_SamplePlayer_stop: - -- void **stop** **(** :ref:`int` voice **)** - -Stop a given voice. - -.. _class_SamplePlayer_stop_all: - -- void **stop_all** **(** **)** - -Stop all playing voices. - - diff --git a/classes/class_sampleplayer2d.rst b/classes/class_sampleplayer2d.rst deleted file mode 100644 index bd3869f70..000000000 --- a/classes/class_sampleplayer2d.rst +++ /dev/null @@ -1,141 +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_SamplePlayer2D: - -SamplePlayer2D -============== - -**Inherits:** :ref:`SoundPlayer2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Sample player for positional 2D Sound. - -Member Functions ----------------- - -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_polyphony` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_random_pitch_scale` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SampleLibrary` | :ref:`get_sample_library` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_voice_active` **(** :ref:`int` voice **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`play` **(** :ref:`String` sample, :ref:`int` voice=-2 **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_polyphony` **(** :ref:`int` max_voices **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_random_pitch_scale` **(** :ref:`float` val **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sample_library` **(** :ref:`SampleLibrary` library **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop_all` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop_voice` **(** :ref:`int` voice **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voice_set_pitch_scale` **(** :ref:`int` voice, :ref:`float` ratio **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voice_set_volume_scale_db` **(** :ref:`int` voice, :ref:`float` db **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Numeric Constants ------------------ - -- **INVALID_VOICE** = **-1** --- Value returned if the voice or sample are invalid. -- **NEXT_VOICE** = **-2** --- Default voice for the play method. Corresponds to the first voice following the last used voice. - -Description ------------ - -Sample player for positional 2D Sound. Plays sound samples positionally, left and right depending on the distance/place on the screen. - -Member Function Description ---------------------------- - -.. _class_SamplePlayer2D_get_polyphony: - -- :ref:`int` **get_polyphony** **(** **)** const - -Return the polyphony of the player. - -.. _class_SamplePlayer2D_get_random_pitch_scale: - -- :ref:`float` **get_random_pitch_scale** **(** **)** const - -Return the amplitude used for random pitch scale variations. - -.. _class_SamplePlayer2D_get_sample_library: - -- :ref:`SampleLibrary` **get_sample_library** **(** **)** const - -Return the sample library used by the player. - -.. _class_SamplePlayer2D_is_voice_active: - -- :ref:`bool` **is_voice_active** **(** :ref:`int` voice **)** const - -Return whether a voice is still active or has stopped playing. - -.. _class_SamplePlayer2D_play: - -- :ref:`int` **play** **(** :ref:`String` sample, :ref:`int` voice=-2 **)** - -Play a sample. An internal polyphony ID can optionally be passed, or defaults to NEXT_VOICE. - -Return a voice ID which can be used to modify the voice parameters, or INVALID_VOICE if the voice or sample are invalid. - -.. _class_SamplePlayer2D_set_polyphony: - -- void **set_polyphony** **(** :ref:`int` max_voices **)** - -Set the polyphony of the player (maximum amount of simultaneous voices). - -.. _class_SamplePlayer2D_set_random_pitch_scale: - -- void **set_random_pitch_scale** **(** :ref:`float` val **)** - -Set the amplitude for random pitch scale variations. If different from zero, the pitch scale will vary randomly around 1.0 in a range defined by val. - -The actual pitch scale will be, with "variation" ranging from -val to val: - -\* variation > 0: 1.0 + variation - -\* variation < 0: 1.0/(1.0 - variation) - -.. _class_SamplePlayer2D_set_sample_library: - -- void **set_sample_library** **(** :ref:`SampleLibrary` library **)** - -Set the sample library for the player. - -.. _class_SamplePlayer2D_stop_all: - -- void **stop_all** **(** **)** - -Stop all playing voices. - -.. _class_SamplePlayer2D_stop_voice: - -- void **stop_voice** **(** :ref:`int` voice **)** - -Stop a given voice. - -.. _class_SamplePlayer2D_voice_set_pitch_scale: - -- void **voice_set_pitch_scale** **(** :ref:`int` voice, :ref:`float` ratio **)** - -Change the pitch scale of a currently playing voice. - -.. _class_SamplePlayer2D_voice_set_volume_scale_db: - -- void **voice_set_volume_scale_db** **(** :ref:`int` voice, :ref:`float` db **)** - -Change the volume scale (in dB) of a currently playing voice. - - diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index 73578a5c8..12100a28a 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -18,45 +18,52 @@ Brief Description Member Functions ---------------- -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_connection_binds` **(** :ref:`int` idx **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_count` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_flags` **(** :ref:`int` idx **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connection_method` **(** :ref:`int` idx **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connection_signal` **(** :ref:`int` idx **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_connection_source` **(** :ref:`int` idx **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_connection_target` **(** :ref:`int` idx **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_node_count` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_node_groups` **(** :ref:`int` idx **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedScene` | :ref:`get_node_instance` **(** :ref:`int` idx **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_instance_placeholder` **(** :ref:`int` idx **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_name` **(** :ref:`int` idx **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_owner_path` **(** :ref:`int` idx **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_path` **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_node_property_count` **(** :ref:`int` idx **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_property_name` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_node_property_value` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_type` **(** :ref:`int` idx **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_node_instance_placeholder` **(** :ref:`int` idx **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_connection_binds` **(** :ref:`int` idx **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_count` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_flags` **(** :ref:`int` idx **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_connection_method` **(** :ref:`int` idx **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_connection_signal` **(** :ref:`int` idx **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_connection_source` **(** :ref:`int` idx **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_connection_target` **(** :ref:`int` idx **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_node_count` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_node_groups` **(** :ref:`int` idx **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedScene` | :ref:`get_node_instance` **(** :ref:`int` idx **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_instance_placeholder` **(** :ref:`int` idx **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_name` **(** :ref:`int` idx **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_node_owner_path` **(** :ref:`int` idx **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_node_path` **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_node_property_count` **(** :ref:`int` idx **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_property_name` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_node_property_value` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_type` **(** :ref:`int` idx **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_node_instance_placeholder` **(** :ref:`int` idx **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Numeric Constants +----------------- + +- **GEN_EDIT_STATE_DISABLED** = **0** +- **GEN_EDIT_STATE_INSTANCE** = **1** +- **GEN_EDIT_STATE_MAIN** = **2** Member Function Description --------------------------- @@ -95,7 +102,7 @@ Member Function Description .. _class_SceneState_get_node_groups: -- :ref:`StringArray` **get_node_groups** **(** :ref:`int` idx **)** const +- :ref:`PoolStringArray` **get_node_groups** **(** :ref:`int` idx **)** const .. _class_SceneState_get_node_instance: diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 69a940ec5..69cbc7572 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -18,82 +18,92 @@ Brief Description Member Functions ---------------- -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`call_group` **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method **)** vararg | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`change_scene` **(** :ref:`String` path **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`change_scene_to` **(** :ref:`PackedScene` packed_scene **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_current_scene` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_edited_scene_root` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_network_unique_id` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_node_count` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_nodes_in_group` **(** :ref:`String` group **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Viewport` | :ref:`get_root` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_group` **(** :ref:`String` name **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_debugging_collisions_hint` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_debugging_navigation_hint` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editor_hint` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_network_server` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_paused` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_refusing_new_network_connections` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notify_group` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_delete` **(** :ref:`Object` obj **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`quit` **(** **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`reload_current_scene` **(** **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_auto_accept_quit` **(** :ref:`bool` enabled **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_scene` **(** :ref:`Node` child_node **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_debug_collisions_hint` **(** :ref:`bool` enable **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_debug_navigation_hint` **(** :ref:`bool` enable **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_edited_scene_root` **(** :ref:`Object` scene **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editor_hint` **(** :ref:`bool` enable **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_group` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_input_as_handled` **(** **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_network_peer` **(** :ref:`NetworkedMultiplayerPeer` peer **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pause` **(** :ref:`bool` enable **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_refuse_new_network_connections` **(** :ref:`bool` refuse **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_screen_stretch` **(** :ref:`int` mode, :ref:`int` aspect, :ref:`Vector2` minsize **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`call_group` **(** :ref:`String` group, :ref:`String` method **)** vararg | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`call_group_flags` **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method **)** vararg | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`change_scene` **(** :ref:`String` path **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`change_scene_to` **(** :ref:`PackedScene` packed_scene **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_current_scene` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_edited_scene_root` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frame` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_network_unique_id` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_node_count` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_nodes_in_group` **(** :ref:`String` group **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Viewport` | :ref:`get_root` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_group` **(** :ref:`String` name **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_network_peer` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_debugging_collisions_hint` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_debugging_navigation_hint` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editor_hint` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_input_handled` **(** **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_network_server` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_paused` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_refusing_new_network_connections` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`notify_group` **(** :ref:`String` call_flags, :ref:`int` group **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`notify_group_flags` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_delete` **(** :ref:`Object` obj **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`quit` **(** **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`reload_current_scene` **(** **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_auto_accept_quit` **(** :ref:`bool` enabled **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_scene` **(** :ref:`Node` child_node **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_debug_collisions_hint` **(** :ref:`bool` enable **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_debug_navigation_hint` **(** :ref:`bool` enable **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_edited_scene_root` **(** :ref:`Object` scene **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editor_hint` **(** :ref:`bool` enable **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_group` **(** :ref:`String` call_flags, :ref:`String` group, :ref:`Variant` property **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_group_flags` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_input_as_handled` **(** **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_network_peer` **(** :ref:`NetworkedMultiplayerPeer` peer **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pause` **(** :ref:`bool` enable **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_refuse_new_network_connections` **(** :ref:`bool` refuse **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_screen_stretch` **(** :ref:`int` mode, :ref:`int` aspect, :ref:`Vector2` minsize **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **connected_to_server** **(** **)** - **connection_failed** **(** **)** -- **files_dropped** **(** :ref:`StringArray` files, :ref:`int` screen **)** +- **files_dropped** **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** - **fixed_frame** **(** **)** - **idle_frame** **(** **)** - **network_peer_connected** **(** :ref:`int` id **)** @@ -124,7 +134,11 @@ Member Function Description .. _class_SceneTree_call_group: -- void **call_group** **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method **)** vararg +- void **call_group** **(** :ref:`String` group, :ref:`String` method **)** vararg + +.. _class_SceneTree_call_group_flags: + +- void **call_group_flags** **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method **)** vararg .. _class_SceneTree_change_scene: @@ -136,7 +150,7 @@ Member Function Description .. _class_SceneTree_create_timer: -- :ref:`SceneTreeTimer` **create_timer** **(** :ref:`float` time_sec **)** +- :ref:`SceneTreeTimer` **create_timer** **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** .. _class_SceneTree_get_current_scene: @@ -170,6 +184,12 @@ Member Function Description - :ref:`bool` **has_group** **(** :ref:`String` name **)** const +.. _class_SceneTree_has_network_peer: + +- :ref:`bool` **has_network_peer** **(** **)** const + +Returns true if there is a :ref:`NetworkedMultiplayerPeer` set (with :ref:`SceneTree.set_network_peer`). + .. _class_SceneTree_is_debugging_collisions_hint: - :ref:`bool` **is_debugging_collisions_hint** **(** **)** const @@ -182,6 +202,10 @@ Member Function Description - :ref:`bool` **is_editor_hint** **(** **)** const +.. _class_SceneTree_is_input_handled: + +- :ref:`bool` **is_input_handled** **(** **)** + .. _class_SceneTree_is_network_server: - :ref:`bool` **is_network_server** **(** **)** const @@ -198,7 +222,11 @@ Returns true if this SceneTree's :ref:`NetworkedMultiplayerPeer` call_flags, :ref:`String` group, :ref:`int` notification **)** +- void **notify_group** **(** :ref:`String` call_flags, :ref:`int` group **)** + +.. _class_SceneTree_notify_group_flags: + +- void **notify_group_flags** **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** .. _class_SceneTree_queue_delete: @@ -238,7 +266,11 @@ Returns true if this SceneTree's :ref:`NetworkedMultiplayerPeer` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** +- void **set_group** **(** :ref:`String` call_flags, :ref:`String` group, :ref:`Variant` property **)** + +.. _class_SceneTree_set_group_flags: + +- void **set_group_flags** **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** .. _class_SceneTree_set_input_as_handled: diff --git a/classes/class_script.rst b/classes/class_script.rst index 89cfda453..3afc4e52e 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -8,7 +8,7 @@ Script **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualScript`, :ref:`GDScript` +**Inherited By:** :ref:`VisualScript`, :ref:`GDScript`, :ref:`DLScript` **Category:** Core diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index 3964dd41b..3baac4a9b 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -26,6 +26,11 @@ Member Functions | void | :ref:`set_custom_step` **(** :ref:`float` step **)** | +----------------------------+------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **custom_step** + Description ----------- diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index 35e8565e5..93d7b3d20 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -36,6 +36,12 @@ Member Functions | void | :ref:`set_v_scroll` **(** :ref:`int` val **)** | +--------------------------+--------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`bool` **scroll_horizontal** +- :ref:`bool` **scroll_vertical** + Description ----------- diff --git a/classes/class_segmentshape2d.rst b/classes/class_segmentshape2d.rst index 7e43d1024..e9dee34ab 100644 --- a/classes/class_segmentshape2d.rst +++ b/classes/class_segmentshape2d.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_b` **(** :ref:`Vector2` b **)** | +--------------------------------+----------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Vector2` **a** +- :ref:`Vector2` **b** + Description ----------- diff --git a/classes/class_separator.rst b/classes/class_separator.rst index 59edd823d..c285ab758 100644 --- a/classes/class_separator.rst +++ b/classes/class_separator.rst @@ -8,7 +8,7 @@ Separator **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`VSeparator`, :ref:`HSeparator` +**Inherited By:** :ref:`HSeparator`, :ref:`VSeparator` **Category:** Core diff --git a/classes/class_shader.rst b/classes/class_shader.rst index 0f8931178..71c5dbd46 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -8,8 +8,6 @@ Shader **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`MaterialShader`, :ref:`CanvasItemShader`, :ref:`ShaderGraph` - **Category:** Core Brief Description @@ -20,30 +18,31 @@ To be changed, ignore. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_default_texture_param` **(** :ref:`String` param **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_fragment_code` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_light_code` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_vertex_code` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_param` **(** :ref:`String` name **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_code` **(** :ref:`String` vcode, :ref:`String` fcode, :ref:`String` lcode, :ref:`int` fofs=0, :ref:`int` lofs=0 **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_texture_param` **(** :ref:`String` param, :ref:`Texture` texture **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_code` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_default_texture_param` **(** :ref:`String` param **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mode` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_param` **(** :ref:`String` name **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_code` **(** :ref:`String` code **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_texture_param` **(** :ref:`String` param, :ref:`Texture` texture **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`String` **code** Numeric Constants ----------------- -- **MODE_MATERIAL** = **0** +- **MODE_SPATIAL** = **0** - **MODE_CANVAS_ITEM** = **1** -- **MODE_POST_PROCESS** = **2** +- **MODE_PARTICLES** = **2** Description ----------- @@ -53,33 +52,25 @@ To be changed, ignore. Member Function Description --------------------------- +.. _class_Shader_get_code: + +- :ref:`String` **get_code** **(** **)** const + .. _class_Shader_get_default_texture_param: - :ref:`Texture` **get_default_texture_param** **(** :ref:`String` param **)** const -.. _class_Shader_get_fragment_code: - -- :ref:`String` **get_fragment_code** **(** **)** const - -.. _class_Shader_get_light_code: - -- :ref:`String` **get_light_code** **(** **)** const - .. _class_Shader_get_mode: - :ref:`int` **get_mode** **(** **)** const -.. _class_Shader_get_vertex_code: - -- :ref:`String` **get_vertex_code** **(** **)** const - .. _class_Shader_has_param: - :ref:`bool` **has_param** **(** :ref:`String` name **)** const .. _class_Shader_set_code: -- void **set_code** **(** :ref:`String` vcode, :ref:`String` fcode, :ref:`String` lcode, :ref:`int` fofs=0, :ref:`int` lofs=0 **)** +- void **set_code** **(** :ref:`String` code **)** .. _class_Shader_set_default_texture_param: diff --git a/classes/class_shadergraph.rst b/classes/class_shadergraph.rst deleted file mode 100644 index 037b7d719..000000000 --- a/classes/class_shadergraph.rst +++ /dev/null @@ -1,521 +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_ShaderGraph: - -ShaderGraph -=========== - -**Inherits:** :ref:`Shader` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`MaterialShaderGraph`, :ref:`CanvasItemShaderGraph` - -**Category:** Core - -Brief Description ------------------ - - - -Member Functions ----------------- - -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** :ref:`int` shader_type **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ColorArray` | :ref:`color_ramp_node_get_colors` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RealArray` | :ref:`color_ramp_node_get_offsets` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`color_ramp_node_set_ramp` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`ColorArray` colors, :ref:`RealArray` offsets **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`comment_node_get_text` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`comment_node_set_text` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`String` text **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`connect_node` **(** :ref:`int` shader_type, :ref:`int` src_id, :ref:`int` src_slot, :ref:`int` dst_id, :ref:`int` dst_slot **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`CubeMap` | :ref:`cubemap_input_node_get_value` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cubemap_input_node_set_value` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`CubeMap` value **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`curve_map_node_get_points` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`curve_map_node_set_points` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Vector2Array` points **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`default_get_value` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`int` param_id **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`default_set_value` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`int` param_id, :ref:`Variant` value **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_node` **(** :ref:`int` shader_type, :ref:`int` src_id, :ref:`int` src_slot, :ref:`int` dst_id, :ref:`int` dst_slot **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_node_connections` **(** :ref:`int` shader_type **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_node_list` **(** :ref:`int` shader_type **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_node_get_name` **(** :ref:`int` shader_type, :ref:`int` id **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input_node_set_name` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`String` name **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_node_connected` **(** :ref:`int` shader_type, :ref:`int` src_id, :ref:`int` src_slot, :ref:`int` dst_id, :ref:`int` dst_slot **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`node_add` **(** :ref:`int` shader_type, :ref:`int` node_type, :ref:`int` id **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`node_get_pos` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`node_get_state` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`node_get_type` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`node_remove` **(** :ref:`int` shader_type, :ref:`int` id **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`node_set_pos` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Vector2` pos **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`node_set_state` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Variant` state **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`rgb_const_node_get_value` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rgb_const_node_set_value` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Color` value **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`rgb_input_node_get_value` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rgb_input_node_set_value` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Color` value **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rgb_op_node_get_op` **(** :ref:`int` shader_type, :ref:`float` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rgb_op_node_set_op` **(** :ref:`int` shader_type, :ref:`float` id, :ref:`int` op **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`scalar_const_node_get_value` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scalar_const_node_set_value` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`float` value **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`scalar_func_node_get_function` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scalar_func_node_set_function` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`int` func **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`scalar_input_node_get_value` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scalar_input_node_set_value` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`float` value **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`scalar_op_node_get_op` **(** :ref:`int` shader_type, :ref:`float` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scalar_op_node_set_op` **(** :ref:`int` shader_type, :ref:`float` id, :ref:`int` op **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture_input_node_get_value` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_input_node_set_value` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Texture` value **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_node_get_filter_size` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`texture_node_get_filter_strength` **(** :ref:`int` shader_type, :ref:`float` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_node_set_filter_size` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`int` filter_size **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_node_set_filter_strength` **(** :ref:`int` shader_type, :ref:`float` id, :ref:`float` filter_strength **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`vec_const_node_get_value` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`vec_const_node_set_value` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Vector3` value **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`vec_func_node_get_function` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`vec_func_node_set_function` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`int` func **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`vec_input_node_get_value` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`vec_input_node_set_value` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Vector3` value **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`vec_op_node_get_op` **(** :ref:`int` shader_type, :ref:`float` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`vec_op_node_set_op` **(** :ref:`int` shader_type, :ref:`float` id, :ref:`int` op **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`vec_scalar_op_node_get_op` **(** :ref:`int` shader_type, :ref:`float` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`vec_scalar_op_node_set_op` **(** :ref:`int` shader_type, :ref:`float` id, :ref:`int` op **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`xform_const_node_get_value` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`xform_const_node_set_value` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Transform` value **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`xform_input_node_get_value` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`xform_input_node_set_value` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Transform` value **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`xform_vec_mult_node_get_no_translation` **(** :ref:`int` shader_type, :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`xform_vec_mult_node_set_no_translation` **(** :ref:`int` shader_type, :ref:`int` id, :ref:`bool` disable **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Signals -------- - -- **updated** **(** **)** - -Numeric Constants ------------------ - -- **NODE_INPUT** = **0** -- **NODE_SCALAR_CONST** = **1** -- **NODE_VEC_CONST** = **2** -- **NODE_RGB_CONST** = **3** -- **NODE_XFORM_CONST** = **4** -- **NODE_TIME** = **5** -- **NODE_SCREEN_TEX** = **6** -- **NODE_SCALAR_OP** = **7** -- **NODE_VEC_OP** = **8** -- **NODE_VEC_SCALAR_OP** = **9** -- **NODE_RGB_OP** = **10** -- **NODE_XFORM_MULT** = **11** -- **NODE_XFORM_VEC_MULT** = **12** -- **NODE_XFORM_VEC_INV_MULT** = **13** -- **NODE_SCALAR_FUNC** = **14** -- **NODE_VEC_FUNC** = **15** -- **NODE_VEC_LEN** = **16** -- **NODE_DOT_PROD** = **17** -- **NODE_VEC_TO_SCALAR** = **18** -- **NODE_SCALAR_TO_VEC** = **19** -- **NODE_VEC_TO_XFORM** = **21** -- **NODE_XFORM_TO_VEC** = **20** -- **NODE_SCALAR_INTERP** = **22** -- **NODE_VEC_INTERP** = **23** -- **NODE_COLOR_RAMP** = **24** -- **NODE_CURVE_MAP** = **25** -- **NODE_SCALAR_INPUT** = **26** -- **NODE_VEC_INPUT** = **27** -- **NODE_RGB_INPUT** = **28** -- **NODE_XFORM_INPUT** = **29** -- **NODE_TEXTURE_INPUT** = **30** -- **NODE_CUBEMAP_INPUT** = **31** -- **NODE_DEFAULT_TEXTURE** = **32** -- **NODE_OUTPUT** = **33** -- **NODE_COMMENT** = **34** -- **NODE_TYPE_MAX** = **35** -- **SLOT_TYPE_SCALAR** = **0** -- **SLOT_TYPE_VEC** = **1** -- **SLOT_TYPE_XFORM** = **2** -- **SLOT_TYPE_TEXTURE** = **3** -- **SLOT_MAX** = **4** -- **SHADER_TYPE_VERTEX** = **0** -- **SHADER_TYPE_FRAGMENT** = **1** -- **SHADER_TYPE_LIGHT** = **2** -- **SHADER_TYPE_MAX** = **3** -- **SLOT_IN** = **0** -- **SLOT_OUT** = **1** -- **GRAPH_OK** = **0** -- **GRAPH_ERROR_CYCLIC** = **1** -- **GRAPH_ERROR_MISSING_CONNECTIONS** = **2** -- **SCALAR_OP_ADD** = **0** -- **SCALAR_OP_SUB** = **1** -- **SCALAR_OP_MUL** = **2** -- **SCALAR_OP_DIV** = **3** -- **SCALAR_OP_MOD** = **4** -- **SCALAR_OP_POW** = **5** -- **SCALAR_OP_MAX** = **6** -- **SCALAR_OP_MIN** = **7** -- **SCALAR_OP_ATAN2** = **8** -- **SCALAR_MAX_OP** = **9** -- **VEC_OP_ADD** = **0** -- **VEC_OP_SUB** = **1** -- **VEC_OP_MUL** = **2** -- **VEC_OP_DIV** = **3** -- **VEC_OP_MOD** = **4** -- **VEC_OP_POW** = **5** -- **VEC_OP_MAX** = **6** -- **VEC_OP_MIN** = **7** -- **VEC_OP_CROSS** = **8** -- **VEC_MAX_OP** = **9** -- **VEC_SCALAR_OP_MUL** = **0** -- **VEC_SCALAR_OP_DIV** = **1** -- **VEC_SCALAR_OP_POW** = **2** -- **VEC_SCALAR_MAX_OP** = **3** -- **RGB_OP_SCREEN** = **0** -- **RGB_OP_DIFFERENCE** = **1** -- **RGB_OP_DARKEN** = **2** -- **RGB_OP_LIGHTEN** = **3** -- **RGB_OP_OVERLAY** = **4** -- **RGB_OP_DODGE** = **5** -- **RGB_OP_BURN** = **6** -- **RGB_OP_SOFT_LIGHT** = **7** -- **RGB_OP_HARD_LIGHT** = **8** -- **RGB_MAX_OP** = **9** -- **SCALAR_FUNC_SIN** = **0** -- **SCALAR_FUNC_COS** = **1** -- **SCALAR_FUNC_TAN** = **2** -- **SCALAR_FUNC_ASIN** = **3** -- **SCALAR_FUNC_ACOS** = **4** -- **SCALAR_FUNC_ATAN** = **5** -- **SCALAR_FUNC_SINH** = **6** -- **SCALAR_FUNC_COSH** = **7** -- **SCALAR_FUNC_TANH** = **8** -- **SCALAR_FUNC_LOG** = **9** -- **SCALAR_FUNC_EXP** = **10** -- **SCALAR_FUNC_SQRT** = **11** -- **SCALAR_FUNC_ABS** = **12** -- **SCALAR_FUNC_SIGN** = **13** -- **SCALAR_FUNC_FLOOR** = **14** -- **SCALAR_FUNC_ROUND** = **15** -- **SCALAR_FUNC_CEIL** = **16** -- **SCALAR_FUNC_FRAC** = **17** -- **SCALAR_FUNC_SATURATE** = **18** -- **SCALAR_FUNC_NEGATE** = **19** -- **SCALAR_MAX_FUNC** = **20** -- **VEC_FUNC_NORMALIZE** = **0** -- **VEC_FUNC_SATURATE** = **1** -- **VEC_FUNC_NEGATE** = **2** -- **VEC_FUNC_RECIPROCAL** = **3** -- **VEC_FUNC_RGB2HSV** = **4** -- **VEC_FUNC_HSV2RGB** = **5** -- **VEC_MAX_FUNC** = **6** - -Member Function Description ---------------------------- - -.. _class_ShaderGraph_clear: - -- void **clear** **(** :ref:`int` shader_type **)** - -.. _class_ShaderGraph_color_ramp_node_get_colors: - -- :ref:`ColorArray` **color_ramp_node_get_colors** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_color_ramp_node_get_offsets: - -- :ref:`RealArray` **color_ramp_node_get_offsets** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_color_ramp_node_set_ramp: - -- void **color_ramp_node_set_ramp** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`ColorArray` colors, :ref:`RealArray` offsets **)** - -.. _class_ShaderGraph_comment_node_get_text: - -- :ref:`String` **comment_node_get_text** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_comment_node_set_text: - -- void **comment_node_set_text** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`String` text **)** - -.. _class_ShaderGraph_connect_node: - -- Error **connect_node** **(** :ref:`int` shader_type, :ref:`int` src_id, :ref:`int` src_slot, :ref:`int` dst_id, :ref:`int` dst_slot **)** - -.. _class_ShaderGraph_cubemap_input_node_get_value: - -- :ref:`CubeMap` **cubemap_input_node_get_value** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_cubemap_input_node_set_value: - -- void **cubemap_input_node_set_value** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`CubeMap` value **)** - -.. _class_ShaderGraph_curve_map_node_get_points: - -- :ref:`Vector2Array` **curve_map_node_get_points** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_curve_map_node_set_points: - -- void **curve_map_node_set_points** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Vector2Array` points **)** - -.. _class_ShaderGraph_default_get_value: - -- void **default_get_value** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`int` param_id **)** - -.. _class_ShaderGraph_default_set_value: - -- void **default_set_value** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`int` param_id, :ref:`Variant` value **)** - -.. _class_ShaderGraph_disconnect_node: - -- void **disconnect_node** **(** :ref:`int` shader_type, :ref:`int` src_id, :ref:`int` src_slot, :ref:`int` dst_id, :ref:`int` dst_slot **)** - -.. _class_ShaderGraph_get_node_connections: - -- :ref:`Array` **get_node_connections** **(** :ref:`int` shader_type **)** const - -.. _class_ShaderGraph_get_node_list: - -- :ref:`Array` **get_node_list** **(** :ref:`int` shader_type **)** const - -.. _class_ShaderGraph_input_node_get_name: - -- :ref:`String` **input_node_get_name** **(** :ref:`int` shader_type, :ref:`int` id **)** - -.. _class_ShaderGraph_input_node_set_name: - -- void **input_node_set_name** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`String` name **)** - -.. _class_ShaderGraph_is_node_connected: - -- :ref:`bool` **is_node_connected** **(** :ref:`int` shader_type, :ref:`int` src_id, :ref:`int` src_slot, :ref:`int` dst_id, :ref:`int` dst_slot **)** const - -.. _class_ShaderGraph_node_add: - -- void **node_add** **(** :ref:`int` shader_type, :ref:`int` node_type, :ref:`int` id **)** - -.. _class_ShaderGraph_node_get_pos: - -- :ref:`Vector2` **node_get_pos** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_node_get_state: - -- :ref:`Variant` **node_get_state** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_node_get_type: - -- :ref:`int` **node_get_type** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_node_remove: - -- void **node_remove** **(** :ref:`int` shader_type, :ref:`int` id **)** - -.. _class_ShaderGraph_node_set_pos: - -- void **node_set_pos** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Vector2` pos **)** - -.. _class_ShaderGraph_node_set_state: - -- void **node_set_state** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Variant` state **)** - -.. _class_ShaderGraph_rgb_const_node_get_value: - -- :ref:`Color` **rgb_const_node_get_value** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_rgb_const_node_set_value: - -- void **rgb_const_node_set_value** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Color` value **)** - -.. _class_ShaderGraph_rgb_input_node_get_value: - -- :ref:`Color` **rgb_input_node_get_value** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_rgb_input_node_set_value: - -- void **rgb_input_node_set_value** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Color` value **)** - -.. _class_ShaderGraph_rgb_op_node_get_op: - -- :ref:`int` **rgb_op_node_get_op** **(** :ref:`int` shader_type, :ref:`float` id **)** const - -.. _class_ShaderGraph_rgb_op_node_set_op: - -- void **rgb_op_node_set_op** **(** :ref:`int` shader_type, :ref:`float` id, :ref:`int` op **)** - -.. _class_ShaderGraph_scalar_const_node_get_value: - -- :ref:`float` **scalar_const_node_get_value** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_scalar_const_node_set_value: - -- void **scalar_const_node_set_value** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`float` value **)** - -.. _class_ShaderGraph_scalar_func_node_get_function: - -- :ref:`int` **scalar_func_node_get_function** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_scalar_func_node_set_function: - -- void **scalar_func_node_set_function** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`int` func **)** - -.. _class_ShaderGraph_scalar_input_node_get_value: - -- :ref:`float` **scalar_input_node_get_value** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_scalar_input_node_set_value: - -- void **scalar_input_node_set_value** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`float` value **)** - -.. _class_ShaderGraph_scalar_op_node_get_op: - -- :ref:`int` **scalar_op_node_get_op** **(** :ref:`int` shader_type, :ref:`float` id **)** const - -.. _class_ShaderGraph_scalar_op_node_set_op: - -- void **scalar_op_node_set_op** **(** :ref:`int` shader_type, :ref:`float` id, :ref:`int` op **)** - -.. _class_ShaderGraph_texture_input_node_get_value: - -- :ref:`Texture` **texture_input_node_get_value** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_texture_input_node_set_value: - -- void **texture_input_node_set_value** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Texture` value **)** - -.. _class_ShaderGraph_texture_node_get_filter_size: - -- :ref:`int` **texture_node_get_filter_size** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_texture_node_get_filter_strength: - -- :ref:`float` **texture_node_get_filter_strength** **(** :ref:`int` shader_type, :ref:`float` id **)** const - -.. _class_ShaderGraph_texture_node_set_filter_size: - -- void **texture_node_set_filter_size** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`int` filter_size **)** - -.. _class_ShaderGraph_texture_node_set_filter_strength: - -- void **texture_node_set_filter_strength** **(** :ref:`int` shader_type, :ref:`float` id, :ref:`float` filter_strength **)** - -.. _class_ShaderGraph_vec_const_node_get_value: - -- :ref:`Vector3` **vec_const_node_get_value** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_vec_const_node_set_value: - -- void **vec_const_node_set_value** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Vector3` value **)** - -.. _class_ShaderGraph_vec_func_node_get_function: - -- :ref:`int` **vec_func_node_get_function** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_vec_func_node_set_function: - -- void **vec_func_node_set_function** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`int` func **)** - -.. _class_ShaderGraph_vec_input_node_get_value: - -- :ref:`Vector3` **vec_input_node_get_value** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_vec_input_node_set_value: - -- void **vec_input_node_set_value** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Vector3` value **)** - -.. _class_ShaderGraph_vec_op_node_get_op: - -- :ref:`int` **vec_op_node_get_op** **(** :ref:`int` shader_type, :ref:`float` id **)** const - -.. _class_ShaderGraph_vec_op_node_set_op: - -- void **vec_op_node_set_op** **(** :ref:`int` shader_type, :ref:`float` id, :ref:`int` op **)** - -.. _class_ShaderGraph_vec_scalar_op_node_get_op: - -- :ref:`int` **vec_scalar_op_node_get_op** **(** :ref:`int` shader_type, :ref:`float` id **)** const - -.. _class_ShaderGraph_vec_scalar_op_node_set_op: - -- void **vec_scalar_op_node_set_op** **(** :ref:`int` shader_type, :ref:`float` id, :ref:`int` op **)** - -.. _class_ShaderGraph_xform_const_node_get_value: - -- :ref:`Transform` **xform_const_node_get_value** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_xform_const_node_set_value: - -- void **xform_const_node_set_value** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Transform` value **)** - -.. _class_ShaderGraph_xform_input_node_get_value: - -- :ref:`Transform` **xform_input_node_get_value** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_xform_input_node_set_value: - -- void **xform_input_node_set_value** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`Transform` value **)** - -.. _class_ShaderGraph_xform_vec_mult_node_get_no_translation: - -- :ref:`bool` **xform_vec_mult_node_get_no_translation** **(** :ref:`int` shader_type, :ref:`int` id **)** const - -.. _class_ShaderGraph_xform_vec_mult_node_set_no_translation: - -- void **xform_vec_mult_node_set_no_translation** **(** :ref:`int` shader_type, :ref:`int` id, :ref:`bool` disable **)** - - diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index 8b4928f9e..faacca914 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -18,15 +18,15 @@ Brief Description Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shader` | :ref:`get_shader` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_shader_param` **(** :ref:`String` param **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shader` **(** :ref:`Shader` shader **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shader_param` **(** :ref:`String` param, :ref:`Variant` value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shader` | :ref:`get_shader` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_shader_param` **(** :ref:`String` param **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shader` **(** :ref:`Shader` shader **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shader_param` **(** :ref:`String` param, :ref:`Variant` value **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- @@ -37,7 +37,7 @@ Member Function Description .. _class_ShaderMaterial_get_shader_param: -- :ref:`Variant` **get_shader_param** **(** :ref:`String` param **)** const +- void **get_shader_param** **(** :ref:`String` param **)** const .. _class_ShaderMaterial_set_shader: diff --git a/classes/class_shape.rst b/classes/class_shape.rst index 7d9e354de..1fdd856b1 100644 --- a/classes/class_shape.rst +++ b/classes/class_shape.rst @@ -8,7 +8,7 @@ Shape **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`SphereShape`, :ref:`PlaneShape`, :ref:`CapsuleShape`, :ref:`BoxShape`, :ref:`ConvexPolygonShape`, :ref:`RayShape`, :ref:`ConcavePolygonShape` +**Inherited By:** :ref:`SphereShape`, :ref:`CapsuleShape`, :ref:`BoxShape`, :ref:`ConvexPolygonShape`, :ref:`PlaneShape`, :ref:`RayShape`, :ref:`ConcavePolygonShape` **Category:** Core diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index 6c5ec48d8..d7476b451 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -20,19 +20,24 @@ Base class for all 2D Shapes. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide` **(** :ref:`Matrix32` local_xform, :ref:`Shape2D` with_shape, :ref:`Matrix32` shape_xform **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`collide_and_get_contacts` **(** :ref:`Matrix32` local_xform, :ref:`Shape2D` with_shape, :ref:`Matrix32` shape_xform **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_motion` **(** :ref:`Matrix32` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Matrix32` shape_xform, :ref:`Vector2` shape_motion **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`collide_with_motion_and_get_contacts` **(** :ref:`Matrix32` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Matrix32` shape_xform, :ref:`Vector2` shape_motion **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_custom_solver_bias` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_solver_bias` **(** :ref:`float` bias **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`collide` **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`collide_and_get_contacts` **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`collide_with_motion` **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`collide_with_motion_and_get_contacts` **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_custom_solver_bias` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_solver_bias` **(** :ref:`float` bias **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **custom_solver_bias** Description ----------- @@ -44,7 +49,7 @@ Member Function Description .. _class_Shape2D_collide: -- :ref:`bool` **collide** **(** :ref:`Matrix32` local_xform, :ref:`Shape2D` with_shape, :ref:`Matrix32` shape_xform **)** +- :ref:`bool` **collide** **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** Return whether this shape is colliding with another. @@ -52,7 +57,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th .. _class_Shape2D_collide_and_get_contacts: -- :ref:`Variant` **collide_and_get_contacts** **(** :ref:`Matrix32` local_xform, :ref:`Shape2D` with_shape, :ref:`Matrix32` shape_xform **)** +- :ref:`Variant` **collide_and_get_contacts** **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** Return a list of the points where this shape touches another. If there are no collisions, the list is empty. @@ -60,7 +65,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th .. _class_Shape2D_collide_with_motion: -- :ref:`bool` **collide_with_motion** **(** :ref:`Matrix32` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Matrix32` shape_xform, :ref:`Vector2` shape_motion **)** +- :ref:`bool` **collide_with_motion** **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** Return whether this shape would collide with another, if a given movement was applied. @@ -68,7 +73,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th .. _class_Shape2D_collide_with_motion_and_get_contacts: -- :ref:`Variant` **collide_with_motion_and_get_contacts** **(** :ref:`Matrix32` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Matrix32` shape_xform, :ref:`Vector2` shape_motion **)** +- :ref:`Variant` **collide_with_motion_and_get_contacts** **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** Return a list of the points where this shape would touch another, if a given movement was applied. If there are no collisions, the list is empty. diff --git a/classes/class_shortcut.rst b/classes/class_shortcut.rst index fbdbff695..7ab090ad0 100644 --- a/classes/class_shortcut.rst +++ b/classes/class_shortcut.rst @@ -30,6 +30,11 @@ Member Functions | void | :ref:`set_shortcut` **(** :ref:`InputEvent` event **)** | +--------------------------------------+--------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`InputEvent` **shortcut** + Member Function Description --------------------------- diff --git a/classes/class_skybox.rst b/classes/class_skybox.rst new file mode 100644 index 000000000..b5e61a740 --- /dev/null +++ b/classes/class_skybox.rst @@ -0,0 +1,54 @@ +.. 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_SkyBox: + +SkyBox +====== + +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`ImageSkyBox` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_radiance_size` **(** **)** const | ++------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`set_radiance_size` **(** :ref:`int` size **)** | ++------------------------+---------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`int` **radiance_size** + +Numeric Constants +----------------- + +- **RADIANCE_SIZE_256** = **0** +- **RADIANCE_SIZE_512** = **1** +- **RADIANCE_SIZE_1024** = **2** +- **RADIANCE_SIZE_2048** = **3** +- **RADIANCE_SIZE_MAX** = **4** + +Member Function Description +--------------------------- + +.. _class_SkyBox_get_radiance_size: + +- :ref:`int` **get_radiance_size** **(** **)** const + +.. _class_SkyBox_set_radiance_size: + +- void **set_radiance_size** **(** :ref:`int` size **)** + + diff --git a/classes/class_slider.rst b/classes/class_slider.rst index ba1fbcd9f..aebf7951f 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -30,6 +30,13 @@ Member Functions | void | :ref:`set_ticks_on_borders` **(** :ref:`bool` ticks_on_border **)** | +--------------------------+----------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **focus_mode** +- :ref:`int` **tick_count** +- :ref:`bool` **ticks_on_borders** + Description ----------- diff --git a/classes/class_sliderjoint.rst b/classes/class_sliderjoint.rst index e9f0fb0cd..330369f3f 100644 --- a/classes/class_sliderjoint.rst +++ b/classes/class_sliderjoint.rst @@ -24,6 +24,32 @@ Member Functions | void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **angular_limit/damping** +- :ref:`float` **angular_limit/lower_angle** +- :ref:`float` **angular_limit/restitution** +- :ref:`float` **angular_limit/softness** +- :ref:`float` **angular_limit/upper_angle** +- :ref:`float` **angular_motion/damping** +- :ref:`float` **angular_motion/restitution** +- :ref:`float` **angular_motion/softness** +- :ref:`float` **angular_ortho/damping** +- :ref:`float` **angular_ortho/restitution** +- :ref:`float` **angular_ortho/softness** +- :ref:`float` **linear_limit/damping** +- :ref:`float` **linear_limit/lower_distance** +- :ref:`float` **linear_limit/restitution** +- :ref:`float` **linear_limit/softness** +- :ref:`float` **linear_limit/upper_distance** +- :ref:`float` **linear_motion/damping** +- :ref:`float` **linear_motion/restitution** +- :ref:`float` **linear_motion/softness** +- :ref:`float` **linear_ortho/damping** +- :ref:`float` **linear_ortho/restitution** +- :ref:`float` **linear_ortho/softness** + Numeric Constants ----------------- diff --git a/classes/class_soundplayer2d.rst b/classes/class_soundplayer2d.rst deleted file mode 100644 index c60d52204..000000000 --- a/classes/class_soundplayer2d.rst +++ /dev/null @@ -1,55 +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_SoundPlayer2D: - -SoundPlayer2D -============= - -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`SamplePlayer2D` - -**Category:** Core - -Brief Description ------------------ - -Base class for playing spatial 2D sound. - -Member Functions ----------------- - -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ - -Numeric Constants ------------------ - -- **PARAM_VOLUME_DB** = **0** -- **PARAM_PITCH_SCALE** = **1** -- **PARAM_ATTENUATION_MIN_DISTANCE** = **2** -- **PARAM_ATTENUATION_MAX_DISTANCE** = **3** -- **PARAM_ATTENUATION_DISTANCE_EXP** = **4** -- **PARAM_MAX** = **5** - -Description ------------ - -Base class for playing spatial 2D sound. - -Member Function Description ---------------------------- - -.. _class_SoundPlayer2D_get_param: - -- :ref:`float` **get_param** **(** :ref:`int` param **)** const - -.. _class_SoundPlayer2D_set_param: - -- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** - - diff --git a/classes/class_soundroomparams.rst b/classes/class_soundroomparams.rst deleted file mode 100644 index e31fc4174..000000000 --- a/classes/class_soundroomparams.rst +++ /dev/null @@ -1,62 +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_SoundRoomParams: - -SoundRoomParams -=============== - -**Inherits:** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - -Member Functions ----------------- - -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_reverb_mode` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_forcing_params_to_all_sources` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_force_params_to_all_sources` **(** :ref:`bool` enabled **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_reverb_mode` **(** :ref:`int` reverb_mode **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - -Member Function Description ---------------------------- - -.. _class_SoundRoomParams_get_param: - -- :ref:`float` **get_param** **(** :ref:`int` param **)** const - -.. _class_SoundRoomParams_get_reverb_mode: - -- :ref:`int` **get_reverb_mode** **(** **)** const - -.. _class_SoundRoomParams_is_forcing_params_to_all_sources: - -- :ref:`bool` **is_forcing_params_to_all_sources** **(** **)** - -.. _class_SoundRoomParams_set_force_params_to_all_sources: - -- void **set_force_params_to_all_sources** **(** :ref:`bool` enabled **)** - -.. _class_SoundRoomParams_set_param: - -- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** - -.. _class_SoundRoomParams_set_reverb_mode: - -- void **set_reverb_mode** **(** :ref:`int` reverb_mode **)** - - diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index 50eaffc25..9a0691d53 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -8,7 +8,7 @@ Spatial **Inherits:** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`Joint`, :ref:`RayCast`, :ref:`VehicleWheel`, :ref:`Camera`, :ref:`BoneAttachment`, :ref:`CollisionShape`, :ref:`Path`, :ref:`VisualInstance`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`RemoteTransform`, :ref:`SpatialPlayer`, :ref:`WorldEnvironment`, :ref:`PathFollow`, :ref:`NavigationMeshInstance`, :ref:`Listener`, :ref:`InverseKinematics`, :ref:`VisibilityNotifier`, :ref:`Navigation`, :ref:`CollisionPolygon`, :ref:`GridMap`, :ref:`Skeleton`, :ref:`CollisionObject` +**Inherited By:** :ref:`Joint`, :ref:`RayCast`, :ref:`Camera`, :ref:`BoneAttachment`, :ref:`CollisionShape`, :ref:`Path`, :ref:`VisualInstance`, :ref:`VehicleWheel`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`RemoteTransform`, :ref:`CollisionObject`, :ref:`WorldEnvironment`, :ref:`Listener`, :ref:`PathFollow`, :ref:`NavigationMeshInstance`, :ref:`VisibilityNotifier`, :ref:`Navigation`, :ref:`CollisionPolygon`, :ref:`GridMap`, :ref:`Skeleton` **Category:** Core @@ -45,14 +45,16 @@ Member Functions +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`hide` **(** **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hidden` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_visible` **(** **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`look_at` **(** :ref:`Vector3` target, :ref:`Vector3` up **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`look_at_from_pos` **(** :ref:`Vector3` pos, :ref:`Vector3` target, :ref:`Vector3` up **)** | @@ -73,14 +75,14 @@ Member Functions +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_global_transform` **(** :ref:`Transform` global **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hidden` **(** :ref:`bool` hidden **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_identity` **(** **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ignore_transform_notification` **(** :ref:`bool` enabled **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_rotation` **(** :ref:`Vector3` rotation_rad **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_rotation_deg` **(** :ref:`Vector3` rotation_deg **)** | @@ -91,6 +93,8 @@ Member Functions +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_translation` **(** :ref:`Vector3` translation **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_visible` **(** :ref:`bool` arg0 **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`show` **(** **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`translate` **(** :ref:`Vector3` offset **)** | @@ -103,6 +107,17 @@ Signals - **visibility_changed** **(** **)** +Member Variables +---------------- + +- :ref:`Transform` **global_transform** +- :ref:`Vector3` **rotation** +- :ref:`Vector3` **rotation_deg** +- :ref:`Vector3` **scale** +- :ref:`Transform` **transform** +- :ref:`Vector3` **translation** +- :ref:`bool` **visible** + Numeric Constants ----------------- @@ -173,10 +188,6 @@ Return the local transform, relative to the bone parent. - void **hide** **(** **)** -.. _class_Spatial_is_hidden: - -- :ref:`bool` **is_hidden** **(** **)** const - .. _class_Spatial_is_local_transform_notification_enabled: - :ref:`bool` **is_local_transform_notification_enabled** **(** **)** const @@ -185,10 +196,18 @@ Return the local transform, relative to the bone parent. - :ref:`bool` **is_set_as_toplevel** **(** **)** const +.. _class_Spatial_is_transform_notification_enabled: + +- :ref:`bool` **is_transform_notification_enabled** **(** **)** const + .. _class_Spatial_is_visible: - :ref:`bool` **is_visible** **(** **)** const +.. _class_Spatial_is_visible_in_tree: + +- :ref:`bool` **is_visible_in_tree** **(** **)** const + .. _class_Spatial_look_at: - void **look_at** **(** :ref:`Vector3` target, :ref:`Vector3` up **)** @@ -231,10 +250,6 @@ Return the local transform, relative to the bone parent. Set the transform globally, relative to worldspace. -.. _class_Spatial_set_hidden: - -- void **set_hidden** **(** :ref:`bool` hidden **)** - .. _class_Spatial_set_identity: - void **set_identity** **(** **)** @@ -247,6 +262,10 @@ Set the transform globally, relative to worldspace. - void **set_notify_local_transform** **(** :ref:`bool` enable **)** +.. _class_Spatial_set_notify_transform: + +- void **set_notify_transform** **(** :ref:`bool` enable **)** + .. _class_Spatial_set_rotation: - void **set_rotation** **(** :ref:`Vector3` rotation_rad **)** @@ -269,6 +288,10 @@ Set the transform locally, relative to the parent spatial node. - void **set_translation** **(** :ref:`Vector3` translation **)** +.. _class_Spatial_set_visible: + +- void **set_visible** **(** :ref:`bool` arg0 **)** + .. _class_Spatial_show: - void **show** **(** **)** diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst new file mode 100644 index 000000000..82f225a61 --- /dev/null +++ b/classes/class_spatialmaterial.rst @@ -0,0 +1,588 @@ +.. 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_SpatialMaterial: + +SpatialMaterial +=============== + +**Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_albedo` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_anisotropy` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_billboard_mode` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_mode` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_clearcoat` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_clearcoat_gloss` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cull_mode` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_depth_draw_mode` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_detail_blend_mode` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_detail_uv` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_diffuse_mode` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_emission` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_emission_energy` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_feature` **(** :ref:`int` feature **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_flag` **(** :ref:`int` arg0 **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_height_scale` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_line_width` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_metalness` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_normal_scale` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_particles_anim_h_frames` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_particles_anim_loop` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_particles_anim_v_frames` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_size` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_refraction` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_refraction_roughness` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rim` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rim_tint` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_roughness` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_specular` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_specular_mode` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_subsurface_scattering_strength` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** :ref:`Texture` param **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_uv1_offset` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_uv1_scale` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_uv2_offset` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_uv2_scale` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_albedo` **(** :ref:`Color` albedo **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anisotropy` **(** :ref:`float` anisotropy **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_billboard_mode` **(** :ref:`int` mode **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_mode` **(** :ref:`int` blend_mode **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clearcoat` **(** :ref:`float` clearcoat **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clearcoat_gloss` **(** :ref:`float` clearcoat_gloss **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cull_mode` **(** :ref:`int` cull_mode **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_depth_draw_mode` **(** :ref:`int` depth_draw_mode **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_detail_blend_mode` **(** :ref:`int` detail_blend_mode **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_detail_uv` **(** :ref:`int` detail_uv **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_diffuse_mode` **(** :ref:`int` diffuse_mode **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission` **(** :ref:`Color` emission **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_energy` **(** :ref:`float` emission_energy **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_feature` **(** :ref:`int` feature, :ref:`bool` enable **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` enable **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_height_scale` **(** :ref:`float` height_scale **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_line_width` **(** :ref:`float` line_width **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_metalness` **(** :ref:`float` metalness **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal_scale` **(** :ref:`float` normal_scale **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_particles_anim_h_frames` **(** :ref:`int` frames **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_particles_anim_loop` **(** :ref:`int` frames **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_particles_anim_v_frames` **(** :ref:`int` frames **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_size` **(** :ref:`float` point_size **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_refraction` **(** :ref:`float` refraction **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_refraction_roughness` **(** :ref:`float` refraction_roughness **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rim` **(** :ref:`float` rim **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rim_tint` **(** :ref:`float` rim_tint **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_roughness` **(** :ref:`float` roughness **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_specular` **(** :ref:`Color` specular **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_specular_mode` **(** :ref:`int` specular_mode **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subsurface_scattering_strength` **(** :ref:`float` strength **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Texture` param, :ref:`Object` texture **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv1_offset` **(** :ref:`Vector2` offset **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv1_scale` **(** :ref:`Vector2` scale **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv2_offset` **(** :ref:`Vector2` offset **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv2_scale` **(** :ref:`Vector2` scale **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Color` **albedo_color** +- :ref:`Texture` **albedo_texture** +- :ref:`float` **anisotropy_anisotropy** +- :ref:`bool` **anisotropy_enabled** +- :ref:`Texture` **anisotropy_flowmap** +- :ref:`bool` **ao_enabled** +- :ref:`Texture` **ao_texture** +- :ref:`float` **clearcoat_amount** +- :ref:`bool` **clearcoat_enabled** +- :ref:`float` **clearcoat_gloss** +- :ref:`Texture` **clearcoat_texture** +- :ref:`Texture` **detail_albedo** +- :ref:`int` **detail_blend_mode** +- :ref:`bool` **detail_enabled** +- :ref:`Texture` **detail_mask** +- :ref:`Texture` **detail_normal** +- :ref:`int` **detail_uv_layer** +- :ref:`Color` **emission_color** +- :ref:`bool` **emission_enabled** +- :ref:`float` **emission_energy** +- :ref:`Texture` **emission_texture** +- :ref:`bool` **flags_fixed_size** +- :ref:`bool` **flags_on_top** +- :ref:`bool` **flags_transparent** +- :ref:`bool` **flags_unshaded** +- :ref:`bool` **flags_use_point_size** +- :ref:`bool` **height_enabled** +- :ref:`float` **height_scale** +- :ref:`Texture` **height_texture** +- :ref:`bool` **normal_enabled** +- :ref:`float` **normal_scale** +- :ref:`Texture` **normal_texture** +- :ref:`int` **params_billboard_mode** +- :ref:`int` **params_blend_mode** +- :ref:`int` **params_cull_mode** +- :ref:`int` **params_depth_draw_mode** +- :ref:`int` **params_diffuse_mode** +- :ref:`float` **params_line_width** +- :ref:`float` **params_point_size** +- :ref:`int` **particles_anim_h_frames** +- :ref:`bool` **particles_anim_loop** +- :ref:`int` **particles_anim_v_frames** +- :ref:`float` **refraction_displacement** +- :ref:`bool` **refraction_enabled** +- :ref:`float` **refraction_roughness** +- :ref:`Texture` **refraction_texture** +- :ref:`float` **rim_amount** +- :ref:`bool` **rim_enabled** +- :ref:`Texture` **rim_texture** +- :ref:`float` **rim_tint** +- :ref:`Color` **specular_color** +- :ref:`float` **specular_metalness** +- :ref:`int` **specular_mode** +- :ref:`float` **specular_roughness** +- :ref:`Texture` **specular_texture** +- :ref:`bool` **subsurf_scatter_enabled** +- :ref:`float` **subsurf_scatter_strength** +- :ref:`Texture` **subsurf_scatter_texture** +- :ref:`Vector2` **uv1_offset** +- :ref:`Vector2` **uv1_scale** +- :ref:`Vector2` **uv2_offset** +- :ref:`Vector2` **uv2_scale** +- :ref:`bool` **vertex_color_is_srgb** +- :ref:`bool` **vertex_color_use_as_albedo** + +Numeric Constants +----------------- + +- **TEXTURE_ALBEDO** = **0** +- **TEXTURE_SPECULAR** = **1** +- **TEXTURE_EMISSION** = **2** +- **TEXTURE_NORMAL** = **3** +- **TEXTURE_RIM** = **4** +- **TEXTURE_CLEARCOAT** = **5** +- **TEXTURE_FLOWMAP** = **6** +- **TEXTURE_AMBIENT_OCCLUSION** = **7** +- **TEXTURE_HEIGHT** = **8** +- **TEXTURE_SUBSURFACE_SCATTERING** = **9** +- **TEXTURE_REFRACTION** = **10** +- **TEXTURE_REFRACTION_ROUGHNESS** = **11** +- **TEXTURE_DETAIL_MASK** = **12** +- **TEXTURE_DETAIL_ALBEDO** = **13** +- **TEXTURE_DETAIL_NORMAL** = **14** +- **TEXTURE_MAX** = **15** +- **DETAIL_UV_1** = **0** +- **DETAIL_UV_2** = **1** +- **FEATURE_TRANSPARENT** = **0** +- **FEATURE_EMISSION** = **1** +- **FEATURE_NORMAL_MAPPING** = **2** +- **FEATURE_RIM** = **3** +- **FEATURE_CLEARCOAT** = **4** +- **FEATURE_ANISOTROPY** = **5** +- **FEATURE_AMBIENT_OCCLUSION** = **6** +- **FEATURE_HEIGHT_MAPPING** = **7** +- **FEATURE_SUBSURACE_SCATTERING** = **8** +- **FEATURE_REFRACTION** = **9** +- **FEATURE_DETAIL** = **10** +- **FEATURE_MAX** = **11** +- **BLEND_MODE_MIX** = **0** +- **BLEND_MODE_ADD** = **1** +- **BLEND_MODE_SUB** = **2** +- **BLEND_MODE_MUL** = **3** +- **DEPTH_DRAW_OPAQUE_ONLY** = **0** +- **DEPTH_DRAW_ALWAYS** = **1** +- **DEPTH_DRAW_DISABLED** = **2** +- **DEPTH_DRAW_ALPHA_OPAQUE_PREPASS** = **3** +- **CULL_BACK** = **0** +- **CULL_FRONT** = **1** +- **CULL_DISABLED** = **2** +- **FLAG_UNSHADED** = **0** +- **FLAG_ONTOP** = **1** +- **FLAG_ALBEDO_FROM_VERTEX_COLOR** = **2** +- **FLAG_SRGB_VERTEX_COLOR** = **3** +- **FLAG_USE_POINT_SIZE** = **4** +- **FLAG_FIXED_SIZE** = **5** +- **FLAG_MAX** = **6** +- **DIFFUSE_LAMBERT** = **0** +- **DIFFUSE_LAMBERT_WRAP** = **1** +- **DIFFUSE_OREN_NAYAR** = **2** +- **DIFFUSE_BURLEY** = **3** +- **SPECULAR_MODE_METALLIC** = **0** +- **SPECULAR_MODE_SPECULAR** = **1** +- **BILLBOARD_DISABLED** = **0** +- **BILLBOARD_ENABLED** = **1** +- **BILLBOARD_FIXED_Y** = **2** +- **BILLBOARD_PARTICLES** = **3** + +Member Function Description +--------------------------- + +.. _class_SpatialMaterial_get_albedo: + +- :ref:`Color` **get_albedo** **(** **)** const + +.. _class_SpatialMaterial_get_anisotropy: + +- :ref:`float` **get_anisotropy** **(** **)** const + +.. _class_SpatialMaterial_get_billboard_mode: + +- :ref:`int` **get_billboard_mode** **(** **)** const + +.. _class_SpatialMaterial_get_blend_mode: + +- :ref:`int` **get_blend_mode** **(** **)** const + +.. _class_SpatialMaterial_get_clearcoat: + +- :ref:`float` **get_clearcoat** **(** **)** const + +.. _class_SpatialMaterial_get_clearcoat_gloss: + +- :ref:`float` **get_clearcoat_gloss** **(** **)** const + +.. _class_SpatialMaterial_get_cull_mode: + +- :ref:`int` **get_cull_mode** **(** **)** const + +.. _class_SpatialMaterial_get_depth_draw_mode: + +- :ref:`int` **get_depth_draw_mode** **(** **)** const + +.. _class_SpatialMaterial_get_detail_blend_mode: + +- :ref:`int` **get_detail_blend_mode** **(** **)** const + +.. _class_SpatialMaterial_get_detail_uv: + +- :ref:`int` **get_detail_uv** **(** **)** const + +.. _class_SpatialMaterial_get_diffuse_mode: + +- :ref:`int` **get_diffuse_mode** **(** **)** const + +.. _class_SpatialMaterial_get_emission: + +- :ref:`Color` **get_emission** **(** **)** const + +.. _class_SpatialMaterial_get_emission_energy: + +- :ref:`float` **get_emission_energy** **(** **)** const + +.. _class_SpatialMaterial_get_feature: + +- :ref:`bool` **get_feature** **(** :ref:`int` feature **)** const + +.. _class_SpatialMaterial_get_flag: + +- :ref:`bool` **get_flag** **(** :ref:`int` arg0 **)** const + +.. _class_SpatialMaterial_get_height_scale: + +- :ref:`float` **get_height_scale** **(** **)** const + +.. _class_SpatialMaterial_get_line_width: + +- :ref:`float` **get_line_width** **(** **)** const + +.. _class_SpatialMaterial_get_metalness: + +- :ref:`float` **get_metalness** **(** **)** const + +.. _class_SpatialMaterial_get_normal_scale: + +- :ref:`float` **get_normal_scale** **(** **)** const + +.. _class_SpatialMaterial_get_particles_anim_h_frames: + +- :ref:`int` **get_particles_anim_h_frames** **(** **)** const + +.. _class_SpatialMaterial_get_particles_anim_loop: + +- :ref:`int` **get_particles_anim_loop** **(** **)** const + +.. _class_SpatialMaterial_get_particles_anim_v_frames: + +- :ref:`int` **get_particles_anim_v_frames** **(** **)** const + +.. _class_SpatialMaterial_get_point_size: + +- :ref:`float` **get_point_size** **(** **)** const + +.. _class_SpatialMaterial_get_refraction: + +- :ref:`float` **get_refraction** **(** **)** const + +.. _class_SpatialMaterial_get_refraction_roughness: + +- :ref:`float` **get_refraction_roughness** **(** **)** const + +.. _class_SpatialMaterial_get_rim: + +- :ref:`float` **get_rim** **(** **)** const + +.. _class_SpatialMaterial_get_rim_tint: + +- :ref:`float` **get_rim_tint** **(** **)** const + +.. _class_SpatialMaterial_get_roughness: + +- :ref:`float` **get_roughness** **(** **)** const + +.. _class_SpatialMaterial_get_specular: + +- :ref:`Color` **get_specular** **(** **)** const + +.. _class_SpatialMaterial_get_specular_mode: + +- :ref:`int` **get_specular_mode** **(** **)** const + +.. _class_SpatialMaterial_get_subsurface_scattering_strength: + +- :ref:`float` **get_subsurface_scattering_strength** **(** **)** const + +.. _class_SpatialMaterial_get_texture: + +- :ref:`Texture` **get_texture** **(** :ref:`Texture` param **)** const + +.. _class_SpatialMaterial_get_uv1_offset: + +- :ref:`Vector2` **get_uv1_offset** **(** **)** const + +.. _class_SpatialMaterial_get_uv1_scale: + +- :ref:`Vector2` **get_uv1_scale** **(** **)** const + +.. _class_SpatialMaterial_get_uv2_offset: + +- :ref:`Vector2` **get_uv2_offset** **(** **)** const + +.. _class_SpatialMaterial_get_uv2_scale: + +- :ref:`Vector2` **get_uv2_scale** **(** **)** const + +.. _class_SpatialMaterial_set_albedo: + +- void **set_albedo** **(** :ref:`Color` albedo **)** + +.. _class_SpatialMaterial_set_anisotropy: + +- void **set_anisotropy** **(** :ref:`float` anisotropy **)** + +.. _class_SpatialMaterial_set_billboard_mode: + +- void **set_billboard_mode** **(** :ref:`int` mode **)** + +.. _class_SpatialMaterial_set_blend_mode: + +- void **set_blend_mode** **(** :ref:`int` blend_mode **)** + +.. _class_SpatialMaterial_set_clearcoat: + +- void **set_clearcoat** **(** :ref:`float` clearcoat **)** + +.. _class_SpatialMaterial_set_clearcoat_gloss: + +- void **set_clearcoat_gloss** **(** :ref:`float` clearcoat_gloss **)** + +.. _class_SpatialMaterial_set_cull_mode: + +- void **set_cull_mode** **(** :ref:`int` cull_mode **)** + +.. _class_SpatialMaterial_set_depth_draw_mode: + +- void **set_depth_draw_mode** **(** :ref:`int` depth_draw_mode **)** + +.. _class_SpatialMaterial_set_detail_blend_mode: + +- void **set_detail_blend_mode** **(** :ref:`int` detail_blend_mode **)** + +.. _class_SpatialMaterial_set_detail_uv: + +- void **set_detail_uv** **(** :ref:`int` detail_uv **)** + +.. _class_SpatialMaterial_set_diffuse_mode: + +- void **set_diffuse_mode** **(** :ref:`int` diffuse_mode **)** + +.. _class_SpatialMaterial_set_emission: + +- void **set_emission** **(** :ref:`Color` emission **)** + +.. _class_SpatialMaterial_set_emission_energy: + +- void **set_emission_energy** **(** :ref:`float` emission_energy **)** + +.. _class_SpatialMaterial_set_feature: + +- void **set_feature** **(** :ref:`int` feature, :ref:`bool` enable **)** + +.. _class_SpatialMaterial_set_flag: + +- void **set_flag** **(** :ref:`int` flag, :ref:`bool` enable **)** + +.. _class_SpatialMaterial_set_height_scale: + +- void **set_height_scale** **(** :ref:`float` height_scale **)** + +.. _class_SpatialMaterial_set_line_width: + +- void **set_line_width** **(** :ref:`float` line_width **)** + +.. _class_SpatialMaterial_set_metalness: + +- void **set_metalness** **(** :ref:`float` metalness **)** + +.. _class_SpatialMaterial_set_normal_scale: + +- void **set_normal_scale** **(** :ref:`float` normal_scale **)** + +.. _class_SpatialMaterial_set_particles_anim_h_frames: + +- void **set_particles_anim_h_frames** **(** :ref:`int` frames **)** + +.. _class_SpatialMaterial_set_particles_anim_loop: + +- void **set_particles_anim_loop** **(** :ref:`int` frames **)** + +.. _class_SpatialMaterial_set_particles_anim_v_frames: + +- void **set_particles_anim_v_frames** **(** :ref:`int` frames **)** + +.. _class_SpatialMaterial_set_point_size: + +- void **set_point_size** **(** :ref:`float` point_size **)** + +.. _class_SpatialMaterial_set_refraction: + +- void **set_refraction** **(** :ref:`float` refraction **)** + +.. _class_SpatialMaterial_set_refraction_roughness: + +- void **set_refraction_roughness** **(** :ref:`float` refraction_roughness **)** + +.. _class_SpatialMaterial_set_rim: + +- void **set_rim** **(** :ref:`float` rim **)** + +.. _class_SpatialMaterial_set_rim_tint: + +- void **set_rim_tint** **(** :ref:`float` rim_tint **)** + +.. _class_SpatialMaterial_set_roughness: + +- void **set_roughness** **(** :ref:`float` roughness **)** + +.. _class_SpatialMaterial_set_specular: + +- void **set_specular** **(** :ref:`Color` specular **)** + +.. _class_SpatialMaterial_set_specular_mode: + +- void **set_specular_mode** **(** :ref:`int` specular_mode **)** + +.. _class_SpatialMaterial_set_subsurface_scattering_strength: + +- void **set_subsurface_scattering_strength** **(** :ref:`float` strength **)** + +.. _class_SpatialMaterial_set_texture: + +- void **set_texture** **(** :ref:`Texture` param, :ref:`Object` texture **)** + +.. _class_SpatialMaterial_set_uv1_offset: + +- void **set_uv1_offset** **(** :ref:`Vector2` offset **)** + +.. _class_SpatialMaterial_set_uv1_scale: + +- void **set_uv1_scale** **(** :ref:`Vector2` scale **)** + +.. _class_SpatialMaterial_set_uv2_offset: + +- void **set_uv2_offset** **(** :ref:`Vector2` offset **)** + +.. _class_SpatialMaterial_set_uv2_scale: + +- void **set_uv2_scale** **(** :ref:`Vector2` scale **)** + + diff --git a/classes/class_spatialplayer.rst b/classes/class_spatialplayer.rst deleted file mode 100644 index 030b055ab..000000000 --- a/classes/class_spatialplayer.rst +++ /dev/null @@ -1,52 +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_SpatialPlayer: - -SpatialPlayer -============= - -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`SpatialStreamPlayer`, :ref:`SpatialSamplePlayer` - -**Category:** Core - -Brief Description ------------------ - - - -Member Functions ----------------- - -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ - -Numeric Constants ------------------ - -- **PARAM_VOLUME_DB** = **0** -- **PARAM_PITCH_SCALE** = **1** -- **PARAM_ATTENUATION_MIN_DISTANCE** = **2** -- **PARAM_ATTENUATION_MAX_DISTANCE** = **3** -- **PARAM_ATTENUATION_DISTANCE_EXP** = **4** -- **PARAM_EMISSION_CONE_DEGREES** = **5** -- **PARAM_EMISSION_CONE_ATTENUATION_DB** = **6** -- **PARAM_MAX** = **7** - -Member Function Description ---------------------------- - -.. _class_SpatialPlayer_get_param: - -- :ref:`float` **get_param** **(** :ref:`int` param **)** const - -.. _class_SpatialPlayer_set_param: - -- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** - - diff --git a/classes/class_spatialsampleplayer.rst b/classes/class_spatialsampleplayer.rst deleted file mode 100644 index eedee0c5a..000000000 --- a/classes/class_spatialsampleplayer.rst +++ /dev/null @@ -1,92 +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_SpatialSamplePlayer: - -SpatialSamplePlayer -=================== - -**Inherits:** :ref:`SpatialPlayer` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - -Member Functions ----------------- - -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_polyphony` **(** **)** const | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SampleLibrary` | :ref:`get_sample_library` **(** **)** const | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_voice_active` **(** :ref:`int` voice **)** const | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`play` **(** :ref:`String` sample, :ref:`int` voice=-2 **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_polyphony` **(** :ref:`int` voices **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sample_library` **(** :ref:`SampleLibrary` library **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop_all` **(** **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop_voice` **(** :ref:`int` voice **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voice_set_pitch_scale` **(** :ref:`int` voice, :ref:`float` ratio **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voice_set_volume_scale_db` **(** :ref:`int` voice, :ref:`float` db **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Numeric Constants ------------------ - -- **INVALID_VOICE** = **-1** -- **NEXT_VOICE** = **-2** - -Member Function Description ---------------------------- - -.. _class_SpatialSamplePlayer_get_polyphony: - -- :ref:`int` **get_polyphony** **(** **)** const - -.. _class_SpatialSamplePlayer_get_sample_library: - -- :ref:`SampleLibrary` **get_sample_library** **(** **)** const - -.. _class_SpatialSamplePlayer_is_voice_active: - -- :ref:`bool` **is_voice_active** **(** :ref:`int` voice **)** const - -.. _class_SpatialSamplePlayer_play: - -- :ref:`int` **play** **(** :ref:`String` sample, :ref:`int` voice=-2 **)** - -.. _class_SpatialSamplePlayer_set_polyphony: - -- void **set_polyphony** **(** :ref:`int` voices **)** - -.. _class_SpatialSamplePlayer_set_sample_library: - -- void **set_sample_library** **(** :ref:`SampleLibrary` library **)** - -.. _class_SpatialSamplePlayer_stop_all: - -- void **stop_all** **(** **)** - -.. _class_SpatialSamplePlayer_stop_voice: - -- void **stop_voice** **(** :ref:`int` voice **)** - -.. _class_SpatialSamplePlayer_voice_set_pitch_scale: - -- void **voice_set_pitch_scale** **(** :ref:`int` voice, :ref:`float` ratio **)** - -.. _class_SpatialSamplePlayer_voice_set_volume_scale_db: - -- void **voice_set_volume_scale_db** **(** :ref:`int` voice, :ref:`float` db **)** - - diff --git a/classes/class_spatialsound2dserver.rst b/classes/class_spatialsound2dserver.rst deleted file mode 100644 index 16e1d5538..000000000 --- a/classes/class_spatialsound2dserver.rst +++ /dev/null @@ -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_SpatialSound2DServer: - -SpatialSound2DServer -==================== - -**Inherits:** :ref:`Object` - -**Inherited By:** :ref:`SpatialSound2DServerSW` - -**Category:** Core - -Brief Description ------------------ - -Server for Spatial 2D Sound. - -Description ------------ - -Server for Spatial 2D Sound. - diff --git a/classes/class_spatialsoundserver.rst b/classes/class_spatialsoundserver.rst deleted file mode 100644 index 845a21e97..000000000 --- a/classes/class_spatialsoundserver.rst +++ /dev/null @@ -1,19 +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_SpatialSoundServer: - -SpatialSoundServer -================== - -**Inherits:** :ref:`Object` - -**Inherited By:** :ref:`SpatialSoundServerSW` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_spatialstreamplayer.rst b/classes/class_spatialstreamplayer.rst deleted file mode 100644 index 547ae50ee..000000000 --- a/classes/class_spatialstreamplayer.rst +++ /dev/null @@ -1,170 +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_SpatialStreamPlayer: - -SpatialStreamPlayer -=================== - -**Inherits:** :ref:`SpatialPlayer` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - -Member Functions ----------------- - -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_buffering_msec` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_length` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_loop_count` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_loop_restart_time` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pos` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioStream` | :ref:`get_stream` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_stream_name` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume_db` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_autoplay` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_loop` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_paused` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` offset=0 **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek_pos` **(** :ref:`float` time **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autoplay` **(** :ref:`bool` enabled **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_buffering_msec` **(** :ref:`int` msec **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop` **(** :ref:`bool` enabled **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop_restart_time` **(** :ref:`float` secs **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_paused` **(** :ref:`bool` paused **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume` **(** :ref:`float` volume **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume_db` **(** :ref:`float` db **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - -Member Function Description ---------------------------- - -.. _class_SpatialStreamPlayer_get_buffering_msec: - -- :ref:`int` **get_buffering_msec** **(** **)** const - -.. _class_SpatialStreamPlayer_get_length: - -- :ref:`float` **get_length** **(** **)** const - -.. _class_SpatialStreamPlayer_get_loop_count: - -- :ref:`int` **get_loop_count** **(** **)** const - -.. _class_SpatialStreamPlayer_get_loop_restart_time: - -- :ref:`float` **get_loop_restart_time** **(** **)** const - -.. _class_SpatialStreamPlayer_get_pos: - -- :ref:`float` **get_pos** **(** **)** const - -.. _class_SpatialStreamPlayer_get_stream: - -- :ref:`AudioStream` **get_stream** **(** **)** const - -.. _class_SpatialStreamPlayer_get_stream_name: - -- :ref:`String` **get_stream_name** **(** **)** const - -.. _class_SpatialStreamPlayer_get_volume: - -- :ref:`float` **get_volume** **(** **)** const - -.. _class_SpatialStreamPlayer_get_volume_db: - -- :ref:`float` **get_volume_db** **(** **)** const - -.. _class_SpatialStreamPlayer_has_autoplay: - -- :ref:`bool` **has_autoplay** **(** **)** const - -.. _class_SpatialStreamPlayer_has_loop: - -- :ref:`bool` **has_loop** **(** **)** const - -.. _class_SpatialStreamPlayer_is_paused: - -- :ref:`bool` **is_paused** **(** **)** const - -.. _class_SpatialStreamPlayer_is_playing: - -- :ref:`bool` **is_playing** **(** **)** const - -.. _class_SpatialStreamPlayer_play: - -- void **play** **(** :ref:`float` offset=0 **)** - -.. _class_SpatialStreamPlayer_seek_pos: - -- void **seek_pos** **(** :ref:`float` time **)** - -.. _class_SpatialStreamPlayer_set_autoplay: - -- void **set_autoplay** **(** :ref:`bool` enabled **)** - -.. _class_SpatialStreamPlayer_set_buffering_msec: - -- void **set_buffering_msec** **(** :ref:`int` msec **)** - -.. _class_SpatialStreamPlayer_set_loop: - -- void **set_loop** **(** :ref:`bool` enabled **)** - -.. _class_SpatialStreamPlayer_set_loop_restart_time: - -- void **set_loop_restart_time** **(** :ref:`float` secs **)** - -.. _class_SpatialStreamPlayer_set_paused: - -- void **set_paused** **(** :ref:`bool` paused **)** - -.. _class_SpatialStreamPlayer_set_stream: - -- void **set_stream** **(** :ref:`AudioStream` stream **)** - -.. _class_SpatialStreamPlayer_set_volume: - -- void **set_volume** **(** :ref:`float` volume **)** - -.. _class_SpatialStreamPlayer_set_volume_db: - -- void **set_volume_db** **(** :ref:`float` db **)** - -.. _class_SpatialStreamPlayer_stop: - -- void **stop** **(** **)** - - diff --git a/classes/class_sphereshape.rst b/classes/class_sphereshape.rst index 03d5bda12..5fe6b969a 100644 --- a/classes/class_sphereshape.rst +++ b/classes/class_sphereshape.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_radius` **(** :ref:`float` radius **)** | +----------------------------+------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **radius** + Member Function Description --------------------------- diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index ce65edcd5..9492881e4 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -34,6 +34,13 @@ Member Functions | void | :ref:`set_suffix` **(** :ref:`String` suffix **)** | +------------------------------+------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`bool` **editable** +- :ref:`String` **prefix** +- :ref:`String` **suffix** + Description ----------- diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index 0d8d1a8a6..761315273 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -39,6 +39,13 @@ Signals - **dragged** **(** :ref:`int` offset **)** +Member Variables +---------------- + +- :ref:`bool` **collapsed** +- :ref:`int` **dragger_visibility** +- :ref:`int` **split_offset** + Numeric Constants ----------------- @@ -58,7 +65,7 @@ Member Function Description - :ref:`int` **get_dragger_visibility** **(** **)** const -Return visibility of the split dragger(One of :ref:`DRAGGER_VISIBLE`, :ref:`DRAGGER_HIDDEN` or :ref:`DRAGGER_HIDDEN_COLLAPSED`). +Return visibility of the split dragger (one of :ref:`DRAGGER_VISIBLE`, :ref:`DRAGGER_HIDDEN` or :ref:`DRAGGER_HIDDEN_COLLAPSED`). .. _class_SplitContainer_get_split_offset: @@ -82,7 +89,7 @@ Set if the split must be collapsed. - void **set_dragger_visibility** **(** :ref:`int` mode **)** -Set visibility of the split dragger(*mode* must be one of :ref:`DRAGGER_VISIBLE`, :ref:`DRAGGER_HIDDEN` or :ref:`DRAGGER_HIDDEN_COLLAPSED`). +Set visibility of the split dragger (*mode* must be one of :ref:`DRAGGER_VISIBLE`, :ref:`DRAGGER_HIDDEN` or :ref:`DRAGGER_HIDDEN_COLLAPSED`). .. _class_SplitContainer_set_split_offset: diff --git a/classes/class_spotlight.rst b/classes/class_spotlight.rst index 741584a2f..3067e3767 100644 --- a/classes/class_spotlight.rst +++ b/classes/class_spotlight.rst @@ -15,6 +15,14 @@ Brief Description Spotlight :ref:`Light`, such as a reflector spotlight or a lantern. +Member Variables +---------------- + +- :ref:`float` **spot_angle** +- :ref:`float` **spot_angle_attenuation** +- :ref:`float` **spot_attenuation** +- :ref:`float` **spot_range** + Description ----------- diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index 6773c5de6..deb034252 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -23,8 +23,6 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_hframes` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_modulate` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_offset` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | @@ -51,8 +49,6 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------+ | void | :ref:`set_hframes` **(** :ref:`int` hframes **)** | +--------------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_modulate` **(** :ref:`Color` modulate **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------+ | void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | +--------------------------------+---------------------------------------------------------------------------------------------------+ | void | :ref:`set_region` **(** :ref:`bool` enabled **)** | @@ -70,6 +66,20 @@ Signals - **frame_changed** **(** **)** - **texture_changed** **(** **)** +Member Variables +---------------- + +- :ref:`bool` **centered** +- :ref:`bool` **flip_h** +- :ref:`bool` **flip_v** +- :ref:`int` **frame** +- :ref:`int` **hframes** +- :ref:`Vector2` **offset** +- :ref:`bool` **region** +- :ref:`Rect2` **region_rect** +- :ref:`Texture` **texture** +- :ref:`int` **vframes** + Description ----------- @@ -90,12 +100,6 @@ Return the texture frame for a sprite-sheet, works when vframes or hframes are g Return the amount of horizontal frames. See :ref:`set_hframes`. -.. _class_Sprite_get_modulate: - -- :ref:`Color` **get_modulate** **(** **)** const - -Return color modulation for the sprite. All sprite pixels are multiplied by this color. - .. _class_Sprite_get_offset: - :ref:`Vector2` **get_offset** **(** **)** const @@ -174,12 +178,6 @@ Set the texture frame for a sprite-sheet, works when vframes or hframes are grea Set the amount of horizontal frames and converts the sprite into a sprite-sheet. This is useful for animation. -.. _class_Sprite_set_modulate: - -- void **set_modulate** **(** :ref:`Color` modulate **)** - -Set color modulation for the sprite. All sprite pixels are multiplied by this color. Color may contain rgb values above 1 to achieve a highlight effect. - .. _class_Sprite_set_offset: - void **set_offset** **(** :ref:`Vector2` offset **)** diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index 164cba7da..d938aa5b3 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -49,6 +49,16 @@ Signals - **frame_changed** **(** **)** +Member Variables +---------------- + +- :ref:`int` **frame** +- :ref:`int` **hframes** +- :ref:`bool` **region** +- :ref:`Rect2` **region_rect** +- :ref:`Texture` **texture** +- :ref:`int` **vframes** + Member Function Description --------------------------- diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index 124ac4596..02b30fb82 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -64,6 +64,21 @@ Member Functions | void | :ref:`set_pixel_size` **(** :ref:`float` pixel_size **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **alpha_cut** +- :ref:`int` **axis** +- :ref:`bool` **centered** +- :ref:`bool` **flip_h** +- :ref:`bool` **flip_v** +- :ref:`Color` **modulate** +- :ref:`Vector2` **offset** +- :ref:`float` **opacity** +- :ref:`float` **pixel_size** +- :ref:`bool` **shaded** +- :ref:`bool` **transparent** + Numeric Constants ----------------- diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index a97e86d52..7a0c0086c 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -50,6 +50,12 @@ Member Functions | void | :ref:`set_frame` **(** :ref:`String` anim, :ref:`int` idx, :ref:`Object` txt **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Array` **animations** +- :ref:`Array` **frames** + Description ----------- diff --git a/classes/class_staticbody.rst b/classes/class_staticbody.rst index d85a9f18b..1239db820 100644 --- a/classes/class_staticbody.rst +++ b/classes/class_staticbody.rst @@ -36,6 +36,14 @@ Member Functions | void | :ref:`set_friction` **(** :ref:`float` friction **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **bounce** +- :ref:`Vector3` **constant_angular_velocity** +- :ref:`Vector3` **constant_linear_velocity** +- :ref:`float` **friction** + Description ----------- diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index 8323fd6aa..10ed604b9 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -36,6 +36,14 @@ Member Functions | void | :ref:`set_friction` **(** :ref:`float` friction **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **bounce** +- :ref:`float` **constant_angular_velocity** +- :ref:`Vector2` **constant_linear_velocity** +- :ref:`float` **friction** + Description ----------- diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 7d1462383..1b9724c06 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -20,71 +20,71 @@ Abstraction and base class for stream-based protocols. Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_16` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_32` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_64` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_8` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_bytes` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_data` **(** :ref:`int` bytes **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_double` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_float` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_partial_data` **(** :ref:`int` bytes **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string` **(** :ref:`int` bytes **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_u16` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_u32` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_u64` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_u8` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_utf8_string` **(** :ref:`int` bytes **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_var` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_big_endian_enabled` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_16` **(** :ref:`int` val **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_32` **(** :ref:`int` val **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_64` **(** :ref:`int` val **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_8` **(** :ref:`int` val **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`put_data` **(** :ref:`RawArray` data **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_double` **(** :ref:`float` val **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_float` **(** :ref:`float` val **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`put_partial_data` **(** :ref:`RawArray` data **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_u16` **(** :ref:`int` val **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_u32` **(** :ref:`int` val **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_u64` **(** :ref:`int` val **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_u8` **(** :ref:`int` val **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_utf8_string` **(** :ref:`String` val **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_var` **(** :ref:`Variant` val **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_big_endian` **(** :ref:`bool` enable **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_16` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_32` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_64` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_8` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_bytes` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_data` **(** :ref:`int` bytes **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_double` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_float` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_partial_data` **(** :ref:`int` bytes **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_string` **(** :ref:`int` bytes **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_u16` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_u32` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_u64` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_u8` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_utf8_string` **(** :ref:`int` bytes **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_var` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_big_endian_enabled` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_16` **(** :ref:`int` val **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_32` **(** :ref:`int` val **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_64` **(** :ref:`int` val **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_8` **(** :ref:`int` val **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`put_data` **(** :ref:`PoolByteArray` data **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_double` **(** :ref:`float` val **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_float` **(** :ref:`float` val **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`put_partial_data` **(** :ref:`PoolByteArray` data **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_u16` **(** :ref:`int` val **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_u32` **(** :ref:`int` val **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_u64` **(** :ref:`int` val **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_u8` **(** :ref:`int` val **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_utf8_string` **(** :ref:`String` val **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_var` **(** :ref:`Variant` val **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_big_endian` **(** :ref:`bool` enable **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -222,7 +222,7 @@ Put a signed byte into the stream. .. _class_StreamPeer_put_data: -- :ref:`int` **put_data** **(** :ref:`RawArray` data **)** +- :ref:`int` **put_data** **(** :ref:`PoolByteArray` data **)** Send a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an Error code. @@ -240,7 +240,7 @@ Put a single-precision float into the stream. .. _class_StreamPeer_put_partial_data: -- :ref:`Array` **put_partial_data** **(** :ref:`RawArray` data **)** +- :ref:`Array` **put_partial_data** **(** :ref:`PoolByteArray` data **)** Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an Error code and an integer, describing how much data was actually sent. diff --git a/classes/class_streampeerbuffer.rst b/classes/class_streampeerbuffer.rst index 7b143bd5c..98177c7dd 100644 --- a/classes/class_streampeerbuffer.rst +++ b/classes/class_streampeerbuffer.rst @@ -18,23 +18,23 @@ Brief Description Member Functions ---------------- -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`StreamPeerBuffer` | :ref:`duplicate` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`get_data_array` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_pos` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_size` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` size **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`int` pos **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_data_array` **(** :ref:`RawArray` data **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StreamPeerBuffer` | :ref:`duplicate` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_data_array` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_pos` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_size` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` size **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`int` pos **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_data_array` **(** :ref:`PoolByteArray` data **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- @@ -49,7 +49,7 @@ Member Function Description .. _class_StreamPeerBuffer_get_data_array: -- :ref:`RawArray` **get_data_array** **(** **)** const +- :ref:`PoolByteArray` **get_data_array** **(** **)** const .. _class_StreamPeerBuffer_get_pos: @@ -69,6 +69,6 @@ Member Function Description .. _class_StreamPeerBuffer_set_data_array: -- void **set_data_array** **(** :ref:`RawArray` data **)** +- void **set_data_array** **(** :ref:`PoolByteArray` data **)** diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index 53437160e..d223bfbcf 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -18,15 +18,15 @@ SSL Stream peer. Member Functions ---------------- -+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`accept` **(** :ref:`StreamPeer` stream **)** | -+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`connect` **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** | -+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect` **(** **)** | -+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_status` **(** **)** const | -+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`accept_stream` **(** :ref:`StreamPeer` stream **)** | ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`connect_to_stream` **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** | ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_from_stream` **(** **)** | ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_status` **(** **)** const | ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -44,19 +44,19 @@ SSL Stream peer. This object can be used to connect to SSL servers. Member Function Description --------------------------- -.. _class_StreamPeerSSL_accept: +.. _class_StreamPeerSSL_accept_stream: -- Error **accept** **(** :ref:`StreamPeer` stream **)** +- Error **accept_stream** **(** :ref:`StreamPeer` stream **)** -.. _class_StreamPeerSSL_connect: +.. _class_StreamPeerSSL_connect_to_stream: -- Error **connect** **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** +- Error **connect_to_stream** **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** Connect to a peer using an underlying :ref:`StreamPeer` "stream", when "validate_certs" is true, :ref:`StreamPeerSSL` will validate that the certificate presented by the peer matches the "for_hostname". -.. _class_StreamPeerSSL_disconnect: +.. _class_StreamPeerSSL_disconnect_from_stream: -- void **disconnect** **(** **)** +- void **disconnect_from_stream** **(** **)** Disconnect from host. diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index 469894533..13d12061d 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -18,19 +18,19 @@ TCP Stream peer. Member Functions ---------------- -+------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`connect` **(** :ref:`String` host, :ref:`int` port **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connected_host` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connected_port` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_status` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connected` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_from_host` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_connected_host` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connected_port` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_status` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connected_to_host` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -48,15 +48,15 @@ TCP Stream peer. This object can be used to connect to TCP servers, or also is r Member Function Description --------------------------- -.. _class_StreamPeerTCP_connect: +.. _class_StreamPeerTCP_connect_to_host: -- :ref:`int` **connect** **(** :ref:`String` host, :ref:`int` port **)** +- :ref:`int` **connect_to_host** **(** :ref:`String` host, :ref:`int` port **)** Connect to the specified host:port pair. A hostname will be resolved if valid. Returns :ref:`OK` on success or :ref:`FAILED` on failure. -.. _class_StreamPeerTCP_disconnect: +.. _class_StreamPeerTCP_disconnect_from_host: -- void **disconnect** **(** **)** +- void **disconnect_from_host** **(** **)** Disconnect from host. @@ -78,10 +78,8 @@ Return the port of this peer. Return the status of the connection, one of STATUS\_\* enum. -.. _class_StreamPeerTCP_is_connected: +.. _class_StreamPeerTCP_is_connected_to_host: -- :ref:`bool` **is_connected** **(** **)** const - -Return whether this peer is connected. Returns true while connecting and connected. +- :ref:`bool` **is_connected_to_host** **(** **)** const diff --git a/classes/class_streamplayer.rst b/classes/class_streamplayer.rst deleted file mode 100644 index d71d16adb..000000000 --- a/classes/class_streamplayer.rst +++ /dev/null @@ -1,230 +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_StreamPlayer: - -StreamPlayer -============ - -**Inherits:** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Base class for audio stream playback. - -Member Functions ----------------- - -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_buffering_msec` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_length` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_loop_count` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_loop_restart_time` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pos` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioStream` | :ref:`get_stream` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_stream_name` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume_db` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_autoplay` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_loop` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_paused` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` offset=0 **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek_pos` **(** :ref:`float` time **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autoplay` **(** :ref:`bool` enabled **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_buffering_msec` **(** :ref:`int` msec **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop` **(** :ref:`bool` enabled **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop_restart_time` **(** :ref:`float` secs **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_paused` **(** :ref:`bool` paused **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume` **(** :ref:`float` volume **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume_db` **(** :ref:`float` db **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - -Signals -------- - -- **finished** **(** **)** - -Description ------------ - -Base class for audio stream playback. Audio stream players inherit from it. - -Member Function Description ---------------------------- - -.. _class_StreamPlayer_get_buffering_msec: - -- :ref:`int` **get_buffering_msec** **(** **)** const - -Return the size of the audio buffer. - -.. _class_StreamPlayer_get_length: - -- :ref:`float` **get_length** **(** **)** const - -Return the length of the stream, in seconds. - -.. _class_StreamPlayer_get_loop_count: - -- :ref:`int` **get_loop_count** **(** **)** const - -Return the number of times the playback has looped. - -.. _class_StreamPlayer_get_loop_restart_time: - -- :ref:`float` **get_loop_restart_time** **(** **)** const - -Return the point in time the stream will rewind to, when looping. - -.. _class_StreamPlayer_get_pos: - -- :ref:`float` **get_pos** **(** **)** const - -Return the playback position, in seconds. - -.. _class_StreamPlayer_get_stream: - -- :ref:`AudioStream` **get_stream** **(** **)** const - -Return the currently assigned stream. - -.. _class_StreamPlayer_get_stream_name: - -- :ref:`String` **get_stream_name** **(** **)** const - -Return the name of the currently assigned stream. This is not the file name, but a field inside the file. If no stream is assigned, if returns "". - -.. _class_StreamPlayer_get_volume: - -- :ref:`float` **get_volume** **(** **)** const - -Return the playback volume for this player. - -.. _class_StreamPlayer_get_volume_db: - -- :ref:`float` **get_volume_db** **(** **)** const - -Return the playback volume for this player, in decibels. - -.. _class_StreamPlayer_has_autoplay: - -- :ref:`bool` **has_autoplay** **(** **)** const - -Return whether this player will start playing as soon as it enters the scene tree. - -.. _class_StreamPlayer_has_loop: - -- :ref:`bool` **has_loop** **(** **)** const - -Return whether the stream will be restarted at the end. - -.. _class_StreamPlayer_is_paused: - -- :ref:`bool` **is_paused** **(** **)** const - -Return whether the playback is currently paused. - -.. _class_StreamPlayer_is_playing: - -- :ref:`bool` **is_playing** **(** **)** const - -Return whether this player is playing. - -.. _class_StreamPlayer_play: - -- void **play** **(** :ref:`float` offset=0 **)** - -Play the currently assigned stream, starting from a given position (in seconds). - -.. _class_StreamPlayer_seek_pos: - -- void **seek_pos** **(** :ref:`float` time **)** - -Set the playback position, in seconds. - -.. _class_StreamPlayer_set_autoplay: - -- void **set_autoplay** **(** :ref:`bool` enabled **)** - -Set whether this player will start playing as soon as it enters the scene tree. - -.. _class_StreamPlayer_set_buffering_msec: - -- void **set_buffering_msec** **(** :ref:`int` msec **)** - -Set the size (in milliseconds) of the audio buffer. A long audio buffer protects better against slowdowns, but responds worse to changes (in volume, stream played...). A shorter buffer takes less time to respond to changes, but may stutter if the application suffers some slowdown. - -Default is 500 milliseconds. - -.. _class_StreamPlayer_set_loop: - -- void **set_loop** **(** :ref:`bool` enabled **)** - -Set whether the stream will be restarted at the end. - -.. _class_StreamPlayer_set_loop_restart_time: - -- void **set_loop_restart_time** **(** :ref:`float` secs **)** - -Set the point in time the stream will rewind to, when looping. - -.. _class_StreamPlayer_set_paused: - -- void **set_paused** **(** :ref:`bool` paused **)** - -Pause stream playback. - -.. _class_StreamPlayer_set_stream: - -- void **set_stream** **(** :ref:`AudioStream` stream **)** - -Set the :ref:`EventStream` this player will play. - -.. _class_StreamPlayer_set_volume: - -- void **set_volume** **(** :ref:`float` volume **)** - -Set the playback volume for this player. This is a float between 0.0 (silent) and 1.0 (full volume). Values over 1.0 will amplify sound even more, but may introduce distortion. Negative values will just invert the output waveform, which produces no audible difference. - -.. _class_StreamPlayer_set_volume_db: - -- void **set_volume_db** **(** :ref:`float` db **)** - -Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for overamplifying (see :ref:`set_volume`) still apply. - -.. _class_StreamPlayer_stop: - -- void **stop** **(** **)** - -Stop the playback. - - diff --git a/classes/class_streamtexture.rst b/classes/class_streamtexture.rst new file mode 100644 index 000000000..1d909353a --- /dev/null +++ b/classes/class_streamtexture.rst @@ -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_StreamTexture: + +StreamTexture +============= + +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_load_path` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`load` **(** :ref:`String` path **)** | ++------------------------------+--------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`String` **load_path** + +Member Function Description +--------------------------- + +.. _class_StreamTexture_get_load_path: + +- :ref:`String` **get_load_path** **(** **)** const + +.. _class_StreamTexture_load: + +- :ref:`int` **load** **(** :ref:`String` path **)** + + diff --git a/classes/class_string.rst b/classes/class_string.rst index d85bcb5d7..664f02566 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -16,131 +16,183 @@ Built-in string class. Member Functions ---------------- -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`basename` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`begins_with` **(** :ref:`String` text **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`bigrams` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`c_escape` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`c_unescape` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`capitalize` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`casecmp_to` **(** :ref:`String` to **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ends_with` **(** :ref:`String` text **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase` **(** :ref:`int` pos, :ref:`int` chars **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`extension` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find` **(** :ref:`String` what, :ref:`int` from=0 **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_last` **(** :ref:`String` what **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`findn` **(** :ref:`String` what, :ref:`int` from=0 **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_dir` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hash` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hex_to_int` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`insert` **(** :ref:`int` pos, :ref:`String` what **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_abs_path` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_rel_path` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_subsequence_of` **(** :ref:`String` text **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_subsequence_ofi` **(** :ref:`String` text **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_float` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_html_color` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_identifier` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_integer` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_ip_address` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`json_escape` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`left` **(** :ref:`int` pos **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`length` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`match` **(** :ref:`String` expr **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`matchn` **(** :ref:`String` expr **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`md5_buffer` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`md5_text` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`nocasecmp_to` **(** :ref:`String` to **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`ord_at` **(** :ref:`int` at **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`pad_decimals` **(** :ref:`int` digits **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`pad_zeros` **(** :ref:`int` digits **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`percent_decode` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`percent_encode` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`plus_file` **(** :ref:`String` file **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`replace` **(** :ref:`String` what, :ref:`String` forwhat **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`replacen` **(** :ref:`String` what, :ref:`String` forwhat **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rfind` **(** :ref:`String` what, :ref:`int` from=-1 **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rfindn` **(** :ref:`String` what, :ref:`int` from=-1 **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`right` **(** :ref:`int` pos **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`sha256_buffer` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`sha256_text` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`similarity` **(** :ref:`String` text **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`split` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RealArray` | :ref:`split_floats` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`strip_edges` **(** :ref:`bool` left=True, :ref:`bool` right=True **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`substr` **(** :ref:`int` from, :ref:`int` len **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`to_ascii` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`to_float` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_int` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_lower` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_upper` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`to_utf8` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`xml_escape` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`xml_unescape` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`bool` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`int` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`float` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Vector2` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Rect2` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Vector3` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Transform2D` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Plane` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Quat` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Rect3` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Basis` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Transform` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Color` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`NodePath` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`RID` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`InputEvent` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Dictionary` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Array` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolByteArray` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolIntArray` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolRealArray` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolStringArray` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolVector2Array` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolVector3Array` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolColorArray` from **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`begins_with` **(** :ref:`String` text **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`bigrams` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`c_escape` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`c_unescape` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`capitalize` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`casecmp_to` **(** :ref:`String` to **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`ends_with` **(** :ref:`String` text **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase` **(** :ref:`int` pos, :ref:`int` chars **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find` **(** :ref:`String` what, :ref:`int` from=0 **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_last` **(** :ref:`String` what **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`findn` **(** :ref:`String` what, :ref:`int` from=0 **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`format` **(** var values, :ref:`String` placeholder={_} **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_dir` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_basename` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_extension` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hash` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hex_to_int` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`insert` **(** :ref:`int` pos, :ref:`String` what **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_abs_path` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_rel_path` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_subsequence_of` **(** :ref:`String` text **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_subsequence_ofi` **(** :ref:`String` text **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_float` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_html_color` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_identifier` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_integer` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_ip_address` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`json_escape` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`left` **(** :ref:`int` pos **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`length` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`match` **(** :ref:`String` expr **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`matchn` **(** :ref:`String` expr **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`md5_buffer` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`md5_text` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`nocasecmp_to` **(** :ref:`String` to **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`ord_at` **(** :ref:`int` at **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`pad_decimals` **(** :ref:`int` digits **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`pad_zeros` **(** :ref:`int` digits **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`percent_decode` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`percent_encode` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`plus_file` **(** :ref:`String` file **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`replace` **(** :ref:`String` what, :ref:`String` forwhat **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`replacen` **(** :ref:`String` what, :ref:`String` forwhat **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rfind` **(** :ref:`String` what, :ref:`int` from=-1 **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rfindn` **(** :ref:`String` what, :ref:`int` from=-1 **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`right` **(** :ref:`int` pos **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`sha256_buffer` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`sha256_text` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`similarity` **(** :ref:`String` text **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`split` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`split_floats` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`strip_edges` **(** :ref:`bool` left=True, :ref:`bool` right=True **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`substr` **(** :ref:`int` from, :ref:`int` len **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`to_ascii` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`to_float` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_int` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`to_lower` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`to_upper` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`to_utf8` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`xml_escape` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`xml_unescape` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -150,11 +202,105 @@ This is the built-in string class (and the one used by GDScript). It supports Un Member Function Description --------------------------- -.. _class_String_basename: +.. _class_String_String: -- :ref:`String` **basename** **(** **)** +- :ref:`String` **String** **(** :ref:`bool` from **)** -If the string is a path to a file, return the path to the file without the extension. +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`int` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`float` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`Vector2` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`Rect2` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`Vector3` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`Transform2D` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`Plane` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`Quat` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`Rect3` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`Basis` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`Transform` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`Color` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`NodePath` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`RID` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`InputEvent` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`Dictionary` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`Array` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`PoolByteArray` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`PoolIntArray` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`PoolRealArray` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`PoolStringArray` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`PoolVector2Array` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`PoolVector3Array` from **)** + +.. _class_String_String: + +- :ref:`String` **String** **(** :ref:`PoolColorArray` from **)** .. _class_String_begins_with: @@ -164,7 +310,7 @@ Return true if the strings begins with the given string. .. _class_String_bigrams: -- :ref:`StringArray` **bigrams** **(** **)** +- :ref:`PoolStringArray` **bigrams** **(** **)** Return the bigrams (pairs of consecutive letters) of this string. @@ -210,12 +356,6 @@ Return true if the strings ends with the given string. Erase ``chars`` characters from the string starting from ``pos``. -.. _class_String_extension: - -- :ref:`String` **extension** **(** **)** - -If the string is a path to a file, return the extension. - .. _class_String_find: - :ref:`int` **find** **(** :ref:`String` what, :ref:`int` from=0 **)** @@ -234,12 +374,28 @@ Find the last occurrence of a substring, return the starting position of the sub Find the first occurrence of a substring but search as case-insensitive, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. +.. _class_String_format: + +- :ref:`String` **format** **(** var values, :ref:`String` placeholder={_} **)** + .. _class_String_get_base_dir: - :ref:`String` **get_base_dir** **(** **)** If the string is a path to a file, return the base directory. +.. _class_String_get_basename: + +- :ref:`String` **get_basename** **(** **)** + +If the string is a path to a file, return the path to the file without the extension. + +.. _class_String_get_extension: + +- :ref:`String` **get_extension** **(** **)** + +If the string is a path to a file, return the extension. + .. _class_String_get_file: - :ref:`String` **get_file** **(** **)** @@ -350,7 +506,7 @@ Do a simple case insensitive expression match, using ? and \* wildcards (see :re .. _class_String_md5_buffer: -- :ref:`RawArray` **md5_buffer** **(** **)** +- :ref:`PoolByteArray` **md5_buffer** **(** **)** Return the MD5 hash of the string as an array of bytes. @@ -434,7 +590,7 @@ Return the right side of the string from a given position. .. _class_String_sha256_buffer: -- :ref:`RawArray` **sha256_buffer** **(** **)** +- :ref:`PoolByteArray` **sha256_buffer** **(** **)** .. _class_String_sha256_text: @@ -450,13 +606,13 @@ Return the similarity index of the text compared to this string. 1 means totally .. _class_String_split: -- :ref:`StringArray` **split** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** +- :ref:`PoolStringArray` **split** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return :ref:`"One","Two","Three"` if split by ",". .. _class_String_split_floats: -- :ref:`RealArray` **split_floats** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** +- :ref:`PoolRealArray` **split_floats** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return :ref:`1,2.5,3` if split by ",". @@ -474,9 +630,9 @@ Return part of the string from the position ``from``, with length ``len``. .. _class_String_to_ascii: -- :ref:`RawArray` **to_ascii** **(** **)** +- :ref:`PoolByteArray` **to_ascii** **(** **)** -Convert the String (which is a character array) to RawArray (which is an array of bytes). The conversion is speeded up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters. +Convert the String (which is a character array) to PoolByteArray (which is an array of bytes). The conversion is speeded up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters. .. _class_String_to_float: @@ -504,9 +660,9 @@ Return the string converted to uppercase. .. _class_String_to_utf8: -- :ref:`RawArray` **to_utf8** **(** **)** +- :ref:`PoolByteArray` **to_utf8** **(** **)** -Convert the String (which is an array of characters) to RawArray (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii(). +Convert the String (which is an array of characters) to PoolByteArray (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii(). .. _class_String_xml_escape: diff --git a/classes/class_stringarray.rst b/classes/class_stringarray.rst deleted file mode 100644 index 6b9ca3815..000000000 --- a/classes/class_stringarray.rst +++ /dev/null @@ -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_StringArray: - -StringArray -=========== - -**Category:** Built-In Types - -Brief Description ------------------ - -String Array. - -Member Functions ----------------- - -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`StringArray` **(** :ref:`Array` from **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`String` string **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`StringArray` array **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`String` string **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`String` string **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`String` string **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - -Description ------------ - -String Array. Array of strings. Can only contain strings. Optimized for memory usage, can't fragment the memory. - -Member Function Description ---------------------------- - -.. _class_StringArray_StringArray: - -- :ref:`StringArray` **StringArray** **(** :ref:`Array` from **)** - -Create from a generic array. - -.. _class_StringArray_append: - -- void **append** **(** :ref:`String` string **)** - -Append an element at the end of the array (alias of :ref:`push_back`). - -.. _class_StringArray_append_array: - -- void **append_array** **(** :ref:`StringArray` array **)** - -Append an :ref:`StringArray` at the end of this array. - -.. _class_StringArray_insert: - -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`String` string **)** - -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_StringArray_invert: - -- void **invert** **(** **)** - -Reverse the order of the elements in the array (so first element will now be the last). - -.. _class_StringArray_push_back: - -- void **push_back** **(** :ref:`String` string **)** - -Append a string element at end of the array. - -.. _class_StringArray_remove: - -- void **remove** **(** :ref:`int` idx **)** - -Remove an element from the array by index. - -.. _class_StringArray_resize: - -- void **resize** **(** :ref:`int` idx **)** - -Set the size of the :ref:`StringArray`. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. - -.. _class_StringArray_set: - -- void **set** **(** :ref:`int` idx, :ref:`String` string **)** - -Change the :ref:`String` at the given index. - -.. _class_StringArray_size: - -- :ref:`int` **size** **(** **)** - -Return the size of the array. - - diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index 9172009b1..a1a2b9b5b 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -8,7 +8,7 @@ StyleBox **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`StyleBoxImageMask`, :ref:`StyleBoxFlat`, :ref:`StyleBoxTexture`, :ref:`StyleBoxEmpty` +**Inherited By:** :ref:`StyleBoxFlat`, :ref:`StyleBoxTexture`, :ref:`StyleBoxEmpty` **Category:** Core @@ -38,6 +38,14 @@ Member Functions | :ref:`bool` | :ref:`test_mask` **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **content_margin_bottom** +- :ref:`float` **content_margin_left** +- :ref:`float` **content_margin_right** +- :ref:`float` **content_margin_top** + Description ----------- diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index 71621dd2d..a891f9474 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -44,6 +44,16 @@ Member Functions | void | :ref:`set_light_color` **(** :ref:`Color` color **)** | +----------------------------+----------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Color` **bg_color** +- :ref:`bool` **border_blend** +- :ref:`int` **border_size** +- :ref:`Color` **dark_color** +- :ref:`bool` **draw_bg** +- :ref:`Color` **light_color** + Description ----------- diff --git a/classes/class_styleboximagemask.rst b/classes/class_styleboximagemask.rst deleted file mode 100644 index 969a10b3f..000000000 --- a/classes/class_styleboximagemask.rst +++ /dev/null @@ -1,79 +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_StyleBoxImageMask: - -StyleBoxImageMask -================= - -**Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Image mask based StyleBox, for mask test. - -Member Functions ----------------- - -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_expand` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_expand_margin_size` **(** :ref:`int` margin **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_image` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand` **(** :ref:`bool` expand **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_size` **(** :ref:`int` margin, :ref:`float` size **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_image` **(** :ref:`Image` image **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Description ------------ - -This StyleBox is similar to :ref:`StyleBoxTexture`, but only meant to be used for mask testing. It takes an image and applies stretch rules to determine if the point clicked is masked or not. - -Member Function Description ---------------------------- - -.. _class_StyleBoxImageMask_get_expand: - -- :ref:`bool` **get_expand** **(** **)** const - -Return whether the expand property is set(default). When expanding, the image will use the same rules as :ref:`StyleBoxTexture` for expand. If not expanding, the image will always be tested at its original size. - -.. _class_StyleBoxImageMask_get_expand_margin_size: - -- :ref:`float` **get_expand_margin_size** **(** :ref:`int` margin **)** const - -Return the expand margin size (from enum MARGIN\_\*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand. - -.. _class_StyleBoxImageMask_get_image: - -- :ref:`Image` **get_image** **(** **)** const - -Return the image used for mask testing. (see :ref:`set_image`). - -.. _class_StyleBoxImageMask_set_expand: - -- void **set_expand** **(** :ref:`bool` expand **)** - -Set the expand property (default). When expanding, the image will use the same rules as :ref:`StyleBoxTexture` for expand. If not expanding, the image will always be tested at its original size. - -.. _class_StyleBoxImageMask_set_expand_margin_size: - -- void **set_expand_margin_size** **(** :ref:`int` margin, :ref:`float` size **)** - -Set an expand margin size (from enum MARGIN\_\*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand. - -.. _class_StyleBoxImageMask_set_image: - -- void **set_image** **(** :ref:`Image` image **)** - -Set the image used for mask testing. Pixels (converted to grey) that have a value, less than 0.5 will fail the test. - - diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index a13baaee2..bd5911064 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -49,6 +49,22 @@ Signals - **texture_changed** **(** **)** +Member Variables +---------------- + +- :ref:`bool` **draw_center** +- :ref:`float` **expand_margin_bottom** +- :ref:`float` **expand_margin_left** +- :ref:`float` **expand_margin_right** +- :ref:`float` **expand_margin_top** +- :ref:`float` **margin_bottom** +- :ref:`float` **margin_left** +- :ref:`float` **margin_right** +- :ref:`float` **margin_top** +- :ref:`Color` **modulate_color** +- :ref:`Rect2` **region_rect** +- :ref:`Texture` **texture** + Description ----------- diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index fc45a8397..01e606b27 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -18,43 +18,43 @@ Helper tool to create geometry. Member Functions ---------------- -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bones` **(** :ref:`IntArray` bones **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color` **(** :ref:`Color` color **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_index` **(** :ref:`int` index **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_normal` **(** :ref:`Vector3` normal **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_smooth_group` **(** :ref:`bool` smooth **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tangent` **(** :ref:`Plane` tangent **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_triangle_fan` **(** :ref:`Vector3Array` vertexes, :ref:`Vector2Array` uvs=Vector2Array([]), :ref:`ColorArray` colors=ColorArray([ColorArray]), :ref:`Vector2Array` uv2s=Vector2Array([]), :ref:`Vector3Array` normals=Vector3Array([]), :ref:`Array` tangents=Array() **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_uv` **(** :ref:`Vector2` uv **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_uv2` **(** :ref:`Vector2` uv2 **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_vertex` **(** :ref:`Vector3` vertex **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_weights` **(** :ref:`RealArray` weights **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`begin` **(** :ref:`int` primitive **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`commit` **(** :ref:`Mesh` existing=NULL **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`deindex` **(** **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`generate_normals` **(** **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`index` **(** **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bones` **(** :ref:`PoolIntArray` bones **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_color` **(** :ref:`Color` color **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_index` **(** :ref:`int` index **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_normal` **(** :ref:`Vector3` normal **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_smooth_group` **(** :ref:`bool` smooth **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_tangent` **(** :ref:`Plane` tangent **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_triangle_fan` **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`PoolColorArray` colors=PoolColorArray([PoolColorArray]), :ref:`PoolVector2Array` uv2s=PoolVector2Array([]), :ref:`PoolVector3Array` normals=PoolVector3Array([]), :ref:`Array` tangents=Array() **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_uv` **(** :ref:`Vector2` uv **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_uv2` **(** :ref:`Vector2` uv2 **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_vertex` **(** :ref:`Vector3` vertex **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_weights` **(** :ref:`PoolRealArray` weights **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`begin` **(** :ref:`int` primitive **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`commit` **(** :ref:`Mesh` existing=NULL **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`deindex` **(** **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`generate_normals` **(** **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`index` **(** **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material` **(** :ref:`Material` material **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -66,7 +66,7 @@ Member Function Description .. _class_SurfaceTool_add_bones: -- void **add_bones** **(** :ref:`IntArray` bones **)** +- void **add_bones** **(** :ref:`PoolIntArray` bones **)** .. _class_SurfaceTool_add_color: @@ -90,7 +90,7 @@ Member Function Description .. _class_SurfaceTool_add_triangle_fan: -- void **add_triangle_fan** **(** :ref:`Vector3Array` vertexes, :ref:`Vector2Array` uvs=Vector2Array([]), :ref:`ColorArray` colors=ColorArray([ColorArray]), :ref:`Vector2Array` uv2s=Vector2Array([]), :ref:`Vector3Array` normals=Vector3Array([]), :ref:`Array` tangents=Array() **)** +- void **add_triangle_fan** **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`PoolColorArray` colors=PoolColorArray([PoolColorArray]), :ref:`PoolVector2Array` uv2s=PoolVector2Array([]), :ref:`PoolVector3Array` normals=PoolVector3Array([]), :ref:`Array` tangents=Array() **)** .. _class_SurfaceTool_add_uv: @@ -106,7 +106,7 @@ Member Function Description .. _class_SurfaceTool_add_weights: -- void **add_weights** **(** :ref:`RealArray` weights **)** +- void **add_weights** **(** :ref:`PoolRealArray` weights **)** .. _class_SurfaceTool_begin: diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 782259683..175cc8ff1 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -18,43 +18,57 @@ Tabbed Container. Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_tabs_visible` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_current_tab` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_current_tab_control` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Popup` | :ref:`get_popup` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_align` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_tab_control` **(** :ref:`int` idx **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_count` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_tab` **(** :ref:`int` tab_idx **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_popup` **(** :ref:`Popup` popup **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_align` **(** :ref:`int` align **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tabs_visible` **(** :ref:`bool` visible **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_tabs_visible` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_current_tab` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_current_tab_control` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Popup` | :ref:`get_popup` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_previous_tab` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_align` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_tab_control` **(** :ref:`int` idx **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_count` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_tab` **(** :ref:`int` tab_idx **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_popup` **(** :ref:`Popup` popup **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_align` **(** :ref:`int` align **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tabs_visible` **(** :ref:`bool` visible **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **pre_popup_pressed** **(** **)** - **tab_changed** **(** :ref:`int` tab **)** +- **tab_selected** **(** :ref:`int` tab **)** + +Member Variables +---------------- + +- :ref:`int` **current_tab** +- :ref:`int` **tab_align** +- :ref:`bool` **tabs_visible** Description ----------- @@ -76,7 +90,7 @@ Return whether the tabs should be visible or hidden. - :ref:`int` **get_current_tab** **(** **)** const -Return the current tab that is being showed. +Return the current tab index that is being shown. .. _class_TabContainer_get_current_tab_control: @@ -86,6 +100,12 @@ Return the current tab that is being showed. - :ref:`Popup` **get_popup** **(** **)** const +.. _class_TabContainer_get_previous_tab: + +- :ref:`int` **get_previous_tab** **(** **)** const + +Return the previous tab index that was being shown. + .. _class_TabContainer_get_tab_align: - :ref:`int` **get_tab_align** **(** **)** const @@ -96,12 +116,18 @@ Return tab alignment, from the ALIGN\_\* enum. - :ref:`Control` **get_tab_control** **(** :ref:`int` idx **)** const +Return the current tab control that is being shown. + .. _class_TabContainer_get_tab_count: - :ref:`int` **get_tab_count** **(** **)** const Return the amount of tabs. +.. _class_TabContainer_get_tab_disabled: + +- :ref:`bool` **get_tab_disabled** **(** :ref:`int` tab_idx **)** const + .. _class_TabContainer_get_tab_icon: - :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** const @@ -128,6 +154,10 @@ Bring a tab (and the Control it represents) to the front, and hide the rest. Set tab alignment, from the ALIGN\_\* enum. Moves tabs to the left, right or center. +.. _class_TabContainer_set_tab_disabled: + +- void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** + .. _class_TabContainer_set_tab_icon: - void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index 7dfe2500f..a00c754bd 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -18,31 +18,35 @@ Tabs Control. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tab` **(** :ref:`String` title, :ref:`Texture` icon **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`ensure_tab_visible` **(** :ref:`int` idx **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_current_tab` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_align` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_count` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_tab` **(** :ref:`int` tab_idx **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_tab` **(** :ref:`int` tab_idx **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_align` **(** :ref:`int` align **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_tab` **(** :ref:`String` title, :ref:`Texture` icon **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`ensure_tab_visible` **(** :ref:`int` idx **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_current_tab` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_align` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_count` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_tab` **(** :ref:`int` tab_idx **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_tab` **(** :ref:`int` tab_idx **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_align` **(** :ref:`int` align **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -51,6 +55,11 @@ Signals - **tab_changed** **(** :ref:`int` tab **)** - **tab_close** **(** :ref:`int` tab **)** +Member Variables +---------------- + +- :ref:`int` **current_tab** + Numeric Constants ----------------- @@ -89,6 +98,10 @@ Member Function Description - :ref:`int` **get_tab_count** **(** **)** const +.. _class_Tabs_get_tab_disabled: + +- :ref:`bool` **get_tab_disabled** **(** :ref:`int` tab_idx **)** const + .. _class_Tabs_get_tab_icon: - :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** const @@ -109,6 +122,10 @@ Member Function Description - void **set_tab_align** **(** :ref:`int` align **)** +.. _class_Tabs_set_tab_disabled: + +- void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** + .. _class_Tabs_set_tab_icon: - void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** diff --git a/classes/class_tcp_server.rst b/classes/class_tcp_server.rst index a501441d1..16d723bda 100644 --- a/classes/class_tcp_server.rst +++ b/classes/class_tcp_server.rst @@ -18,15 +18,15 @@ TCP Server. Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connection_available` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`listen` **(** :ref:`int` port, :ref:`StringArray` accepted_hosts=StringArray([]) **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`take_connection` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connection_available` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*" **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`take_connection` **(** **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -44,9 +44,15 @@ Return true if a connection is available for taking. .. _class_TCP_Server_listen: -- :ref:`int` **listen** **(** :ref:`int` port, :ref:`StringArray` accepted_hosts=StringArray([]) **)** +- :ref:`int` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*" **)** -Listen on a port using protocol, alternatively give a white-list of accepted hosts. +Listen on the "port" binding to "bind_address". + +If "bind_address" is set as "\*" (default), the server will listen on all available addresses (both IPv4 and IPv6). + +If "bind_address" is set as "0.0.0.0" (for IPv4) or "::" (for IPv6), the server will listen on all available addresses matching that IP type. + +If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc), the server will only listen on the interface with that addresses (or fail if no interface with the given address exists). .. _class_TCP_Server_stop: diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 79b99c6df..375c4247a 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -18,101 +18,97 @@ Multiline text editing control. Member Functions ---------------- -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color_region` **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_keyword_color` **(** :ref:`String` keyword, :ref:`Color` color **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_colors` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_undo_history` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`copy` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`cursor_get_blink_enabled` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cursor_get_blink_speed` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`cursor_get_column` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`cursor_get_line` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`cursor_is_block_mode` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_blink_enabled` **(** :ref:`bool` enable **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_blink_speed` **(** :ref:`float` blink_speed **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_block_mode` **(** :ref:`bool` enable **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_column` **(** :ref:`int` column, :ref:`bool` adjust_viewport=false **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_line` **(** :ref:`int` line, :ref:`bool` adjust_viewport=false **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cut` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_line` **(** :ref:`int` line **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_line_count` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_from_column` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_from_line` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_selection_text` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_to_column` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_to_line` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_word_under_cursor` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`insert_text_at_cursor` **(** :ref:`String` text **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_highlight_all_occurrences_enabled` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selection_active` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_show_line_numbers_enabled` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_syntax_coloring_enabled` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`menu_option` **(** :ref:`int` arg0 **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`paste` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`redo` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`IntArray` | :ref:`search` **(** :ref:`String` flags, :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select_all` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_bg_color` **(** :ref:`Color` color **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_highlight_all_occurrences` **(** :ref:`bool` enable **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_chars` **(** :ref:`int` amount **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_readonly` **(** :ref:`bool` enable **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_show_line_numbers` **(** :ref:`bool` enable **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_symbol_color` **(** :ref:`Color` color **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_syntax_coloring` **(** :ref:`bool` enable **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`String` text **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_wrap` **(** :ref:`bool` enable **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`undo` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_color_region` **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_keyword_color` **(** :ref:`String` keyword, :ref:`Color` color **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_colors` **(** **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_undo_history` **(** **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`copy` **(** **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`cursor_get_blink_enabled` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`cursor_get_blink_speed` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`cursor_get_column` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`cursor_get_line` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`cursor_is_block_mode` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_blink_enabled` **(** :ref:`bool` enable **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_blink_speed` **(** :ref:`float` blink_speed **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_block_mode` **(** :ref:`bool` enable **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_column` **(** :ref:`int` column, :ref:`bool` adjust_viewport=false **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_line` **(** :ref:`int` line, :ref:`bool` adjust_viewport=false **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cut` **(** **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_line` **(** :ref:`int` line **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_line_count` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_from_column` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_from_line` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_selection_text` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_to_column` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_to_line` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_word_under_cursor` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`insert_text_at_cursor` **(** :ref:`String` text **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_highlight_all_occurrences_enabled` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selection_active` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_show_line_numbers_enabled` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_syntax_coloring_enabled` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`menu_option` **(** :ref:`int` arg0 **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`paste` **(** **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`redo` **(** **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`search` **(** :ref:`String` flags, :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select_all` **(** **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_highlight_all_occurrences` **(** :ref:`bool` enable **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_chars` **(** :ref:`int` amount **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_readonly` **(** :ref:`bool` enable **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_show_line_numbers` **(** :ref:`bool` enable **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_syntax_coloring` **(** :ref:`bool` enable **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`String` text **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_wrap` **(** :ref:`bool` enable **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`undo` **(** **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -123,6 +119,16 @@ Signals - **symbol_lookup** **(** :ref:`String` symbol, :ref:`int` row, :ref:`int` column **)** - **text_changed** **(** **)** +Member Variables +---------------- + +- :ref:`bool` **caret_blink** +- :ref:`float` **caret_blink_speed** +- :ref:`bool` **caret_block_mode** +- :ref:`bool` **highlight_all_occurrences** +- :ref:`bool` **show_line_numbers** +- :ref:`bool` **syntax_highlighting** + Numeric Constants ----------------- @@ -341,7 +347,7 @@ Perform redo operation. .. _class_TextEdit_search: -- :ref:`IntArray` **search** **(** :ref:`String` flags, :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line **)** const +- :ref:`PoolIntArray` **search** **(** :ref:`String` flags, :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line **)** const Perform a search inside the text. Search flags can be specified in the SEARCH\_\* enum. @@ -357,12 +363,6 @@ Perform selection, from line/column to line/column. Select all the text. -.. _class_TextEdit_set_custom_bg_color: - -- void **set_custom_bg_color** **(** :ref:`Color` color **)** - -Set a custom background color. A background color with alpha==0 disables this. - .. _class_TextEdit_set_highlight_all_occurrences: - void **set_highlight_all_occurrences** **(** :ref:`bool` enable **)** @@ -387,12 +387,6 @@ Set the text editor as read-only. Text can be displayed but not edited. Set to enable showing line numbers. -.. _class_TextEdit_set_symbol_color: - -- void **set_symbol_color** **(** :ref:`Color` color **)** - -Set the color for symbols. - .. _class_TextEdit_set_syntax_coloring: - void **set_syntax_coloring** **(** :ref:`bool` enable **)** diff --git a/classes/class_texture.rst b/classes/class_texture.rst index a64643385..e0d1e3ecd 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -8,7 +8,7 @@ Texture **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`RenderTargetTexture`, :ref:`AtlasTexture`, :ref:`ImageTexture`, :ref:`LargeTexture` +**Inherited By:** :ref:`CurveTexture`, :ref:`AtlasTexture`, :ref:`GradientTexture`, :ref:`ViewportTexture`, :ref:`StreamTexture`, :ref:`ImageTexture`, :ref:`LargeTexture` **Category:** Core @@ -31,8 +31,6 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_height` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_rid` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_size` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_width` **(** **)** const | @@ -86,12 +84,6 @@ Return the current texture flags. Return the texture height. -.. _class_Texture_get_rid: - -- :ref:`RID` **get_rid** **(** **)** const - -Return the texture RID as used in the :ref:`VisualServer`. - .. _class_Texture_get_size: - :ref:`Vector2` **get_size** **(** **)** const diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index 25d4cdf82..cf47b770b 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -23,35 +23,58 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_disabled_texture` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_expand` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_focused_texture` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_hover_texture` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_modulate` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_normal_texture` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_pressed_texture` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_texture_scale` **(** **)** const | +| :ref:`int` | :ref:`get_stretch_mode` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_click_mask` **(** :ref:`BitMap` mask **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_disabled_texture` **(** :ref:`Texture` texture **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand` **(** :ref:`bool` p_expand **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_focused_texture` **(** :ref:`Texture` texture **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_hover_texture` **(** :ref:`Texture` texture **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_modulate` **(** :ref:`Color` color **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_normal_texture` **(** :ref:`Texture` texture **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_pressed_texture` **(** :ref:`Texture` texture **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_scale` **(** :ref:`Vector2` scale **)** | +| void | :ref:`set_stretch_mode` **(** :ref:`int` p_mode **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`bool` **expand** +- :ref:`int` **stretch_mode** +- :ref:`BitMap` **texture_click_mask** +- :ref:`Texture` **texture_disabled** +- :ref:`Texture` **texture_focused** +- :ref:`Texture` **texture_hover** +- :ref:`Texture` **texture_normal** +- :ref:`Texture` **texture_pressed** + +Numeric Constants +----------------- + +- **STRETCH_SCALE** = **0** +- **STRETCH_TILE** = **1** +- **STRETCH_KEEP** = **2** +- **STRETCH_KEEP_CENTERED** = **3** +- **STRETCH_KEEP_ASPECT** = **4** +- **STRETCH_KEEP_ASPECT_CENTERED** = **5** +- **STRETCH_KEEP_ASPECT_COVERED** = **6** + Description ----------- @@ -70,6 +93,10 @@ Member Function Description - :ref:`Texture` **get_disabled_texture** **(** **)** const +.. _class_TextureButton_get_expand: + +- :ref:`bool` **get_expand** **(** **)** const + .. _class_TextureButton_get_focused_texture: - :ref:`Texture` **get_focused_texture** **(** **)** const @@ -78,10 +105,6 @@ Member Function Description - :ref:`Texture` **get_hover_texture** **(** **)** const -.. _class_TextureButton_get_modulate: - -- :ref:`Color` **get_modulate** **(** **)** const - .. _class_TextureButton_get_normal_texture: - :ref:`Texture` **get_normal_texture** **(** **)** const @@ -90,9 +113,9 @@ Member Function Description - :ref:`Texture` **get_pressed_texture** **(** **)** const -.. _class_TextureButton_get_texture_scale: +.. _class_TextureButton_get_stretch_mode: -- :ref:`Vector2` **get_texture_scale** **(** **)** const +- :ref:`int` **get_stretch_mode** **(** **)** const .. _class_TextureButton_set_click_mask: @@ -102,6 +125,10 @@ Member Function Description - void **set_disabled_texture** **(** :ref:`Texture` texture **)** +.. _class_TextureButton_set_expand: + +- void **set_expand** **(** :ref:`bool` p_expand **)** + .. _class_TextureButton_set_focused_texture: - void **set_focused_texture** **(** :ref:`Texture` texture **)** @@ -110,10 +137,6 @@ Member Function Description - void **set_hover_texture** **(** :ref:`Texture` texture **)** -.. _class_TextureButton_set_modulate: - -- void **set_modulate** **(** :ref:`Color` color **)** - .. _class_TextureButton_set_normal_texture: - void **set_normal_texture** **(** :ref:`Texture` texture **)** @@ -122,8 +145,8 @@ Member Function Description - void **set_pressed_texture** **(** :ref:`Texture` texture **)** -.. _class_TextureButton_set_texture_scale: +.. _class_TextureButton_set_stretch_mode: -- void **set_texture_scale** **(** :ref:`Vector2` scale **)** +- void **set_stretch_mode** **(** :ref:`int` p_mode **)** diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index 44ef185e7..28f384d24 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -48,6 +48,17 @@ Member Functions | void | :ref:`set_under_texture` **(** :ref:`Object` tex **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **fill_mode** +- :ref:`Vector2` **radial_center_offset** +- :ref:`float` **radial_fill_degrees** +- :ref:`float` **radial_initial_angle** +- :ref:`Texture` **texture_over** +- :ref:`Texture` **texture_progress** +- :ref:`Texture` **texture_under** + Numeric Constants ----------------- diff --git a/classes/class_textureframe.rst b/classes/class_texturerect.rst similarity index 57% rename from classes/class_textureframe.rst rename to classes/class_texturerect.rst index 7c28cab23..7a06fa9cc 100644 --- a/classes/class_textureframe.rst +++ b/classes/class_texturerect.rst @@ -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_TextureFrame: +.. _class_TextureRect: -TextureFrame -============ +TextureRect +=========== **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` @@ -18,23 +18,26 @@ Control Frame that draws a texture. Member Functions ---------------- -+------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_modulate` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_stretch_mode` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_texture` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_expand` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand` **(** :ref:`bool` enable **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_modulate` **(** :ref:`Color` modulate **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stretch_mode` **(** :ref:`int` stretch_mode **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Object` texture **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------+ ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_stretch_mode` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_texture` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_expand` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand` **(** :ref:`bool` enable **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stretch_mode` **(** :ref:`int` stretch_mode **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Object` texture **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`bool` **expand** +- :ref:`int` **stretch_mode** +- :ref:`Texture` **texture** Numeric Constants ----------------- @@ -46,6 +49,7 @@ Numeric Constants - **STRETCH_KEEP_CENTERED** = **4** - **STRETCH_KEEP_ASPECT** = **5** - **STRETCH_KEEP_ASPECT_CENTERED** = **6** +- **STRETCH_KEEP_ASPECT_COVERED** = **7** Description ----------- @@ -55,35 +59,27 @@ Control frame that simply draws an assigned texture. It can stretch or not. It's Member Function Description --------------------------- -.. _class_TextureFrame_get_modulate: - -- :ref:`Color` **get_modulate** **(** **)** const - -.. _class_TextureFrame_get_stretch_mode: +.. _class_TextureRect_get_stretch_mode: - :ref:`int` **get_stretch_mode** **(** **)** const -.. _class_TextureFrame_get_texture: +.. _class_TextureRect_get_texture: - :ref:`Object` **get_texture** **(** **)** const -.. _class_TextureFrame_has_expand: +.. _class_TextureRect_has_expand: - :ref:`bool` **has_expand** **(** **)** const -.. _class_TextureFrame_set_expand: +.. _class_TextureRect_set_expand: - void **set_expand** **(** :ref:`bool` enable **)** -.. _class_TextureFrame_set_modulate: - -- void **set_modulate** **(** :ref:`Color` modulate **)** - -.. _class_TextureFrame_set_stretch_mode: +.. _class_TextureRect_set_stretch_mode: - void **set_stretch_mode** **(** :ref:`int` stretch_mode **)** -.. _class_TextureFrame_set_texture: +.. _class_TextureRect_set_texture: - void **set_texture** **(** :ref:`Object` texture **)** diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 66e03f74d..9fe45bcf1 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -18,67 +18,72 @@ Theme for controls. Member Functions ---------------- -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_color` **(** :ref:`String` name, :ref:`String` type **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_constant` **(** :ref:`String` name, :ref:`String` type **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_font` **(** :ref:`String` name, :ref:`String` type **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_icon` **(** :ref:`String` name, :ref:`String` type **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_stylebox` **(** :ref:`String` name, :ref:`String` type **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`copy_default_theme` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_color_list` **(** :ref:`String` type **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_constant_list` **(** :ref:`String` type **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_default_font` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_font_list` **(** :ref:`String` type **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_icon_list` **(** :ref:`String` type **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_stylebox_list` **(** :ref:`String` type **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_stylebox_types` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_type_list` **(** :ref:`String` type **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`String` name, :ref:`String` type, :ref:`Color` color **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constant` **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_font` **(** :ref:`Object` font **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_font` **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`String` name, :ref:`String` type, :ref:`Texture` texture **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stylebox` **(** :ref:`String` name, :ref:`String` type, :ref:`StyleBox` texture **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_color` **(** :ref:`String` name, :ref:`String` type **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_constant` **(** :ref:`String` name, :ref:`String` type **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_font` **(** :ref:`String` name, :ref:`String` type **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_icon` **(** :ref:`String` name, :ref:`String` type **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_stylebox` **(** :ref:`String` name, :ref:`String` type **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`copy_default_theme` **(** **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_color_list` **(** :ref:`String` type **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_constant_list` **(** :ref:`String` type **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_default_font` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_font_list` **(** :ref:`String` type **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_icon_list` **(** :ref:`String` type **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_stylebox_list` **(** :ref:`String` type **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_stylebox_types` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_type_list` **(** :ref:`String` type **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`String` name, :ref:`String` type, :ref:`Color` color **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constant` **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_font` **(** :ref:`Object` font **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_font` **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon` **(** :ref:`String` name, :ref:`String` type, :ref:`Texture` texture **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stylebox` **(** :ref:`String` name, :ref:`String` type, :ref:`StyleBox` texture **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Font` **default_font** Description ----------- @@ -120,7 +125,7 @@ Member Function Description .. _class_Theme_get_color_list: -- :ref:`StringArray` **get_color_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_color_list** **(** :ref:`String` type **)** const .. _class_Theme_get_constant: @@ -128,7 +133,7 @@ Member Function Description .. _class_Theme_get_constant_list: -- :ref:`StringArray` **get_constant_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_constant_list** **(** :ref:`String` type **)** const .. _class_Theme_get_default_font: @@ -140,7 +145,7 @@ Member Function Description .. _class_Theme_get_font_list: -- :ref:`StringArray` **get_font_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_font_list** **(** :ref:`String` type **)** const .. _class_Theme_get_icon: @@ -148,7 +153,7 @@ Member Function Description .. _class_Theme_get_icon_list: -- :ref:`StringArray` **get_icon_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_icon_list** **(** :ref:`String` type **)** const .. _class_Theme_get_stylebox: @@ -156,15 +161,15 @@ Member Function Description .. _class_Theme_get_stylebox_list: -- :ref:`StringArray` **get_stylebox_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_stylebox_list** **(** :ref:`String` type **)** const .. _class_Theme_get_stylebox_types: -- :ref:`StringArray` **get_stylebox_types** **(** **)** const +- :ref:`PoolStringArray` **get_stylebox_types** **(** **)** const .. _class_Theme_get_type_list: -- :ref:`StringArray` **get_type_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_type_list** **(** :ref:`String` type **)** const .. _class_Theme_has_color: diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index c1b2ec370..afb9251fe 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -18,99 +18,120 @@ Node for 2D tile-based games. Member Functions ---------------- -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell` **(** :ref:`int` x, :ref:`int` y **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_cell_size` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cellv` **(** :ref:`Vector2` pos **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_center_x` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_center_y` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_collision_bounce` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_collision_friction` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_use_kinematic` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`get_custom_transform` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_half_offset` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_occluder_light_mask` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_quadrant_size` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tile_origin` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TileSet` | :ref:`get_tileset` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_used_cells` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_cell_transposed` **(** :ref:`int` x, :ref:`int` y **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_cell_x_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_cell_y_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_y_sort_mode_enabled` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`map_to_world` **(** :ref:`Vector2` mappos, :ref:`bool` ignore_half_ofs=false **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell` **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_size` **(** :ref:`Vector2` size **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cellv` **(** :ref:`Vector2` pos, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_center_x` **(** :ref:`bool` enable **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_center_y` **(** :ref:`bool` enable **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_bounce` **(** :ref:`float` value **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_friction` **(** :ref:`float` value **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` mask **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_use_kinematic` **(** :ref:`bool` use_kinematic **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_transform` **(** :ref:`Matrix32` custom_transform **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_half_offset` **(** :ref:`int` half_offset **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_occluder_light_mask` **(** :ref:`int` mask **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_quadrant_size` **(** :ref:`int` size **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tile_origin` **(** :ref:`int` origin **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tileset` **(** :ref:`TileSet` tileset **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_y_sort_mode` **(** :ref:`bool` enable **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`world_to_map` **(** :ref:`Vector2` worldpos **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cell` **(** :ref:`int` x, :ref:`int` y **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_cell_size` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cellv` **(** :ref:`Vector2` pos **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_center_x` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_center_y` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_collision_bounce` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_collision_friction` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_use_kinematic` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_custom_transform` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_half_offset` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mode` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_occluder_light_mask` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_quadrant_size` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tile_origin` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TileSet` | :ref:`get_tileset` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_used_cells` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_cell_transposed` **(** :ref:`int` x, :ref:`int` y **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_cell_x_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_cell_y_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_y_sort_mode_enabled` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`map_to_world` **(** :ref:`Vector2` mappos, :ref:`bool` ignore_half_ofs=false **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell` **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_size` **(** :ref:`Vector2` size **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cellv` **(** :ref:`Vector2` pos, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_center_x` **(** :ref:`bool` enable **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_center_y` **(** :ref:`bool` enable **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_bounce` **(** :ref:`float` value **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_friction` **(** :ref:`float` value **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` mask **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_use_kinematic` **(** :ref:`bool` use_kinematic **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_transform` **(** :ref:`Transform2D` custom_transform **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_half_offset` **(** :ref:`int` half_offset **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mode` **(** :ref:`int` mode **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_occluder_light_mask` **(** :ref:`int` mask **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_quadrant_size` **(** :ref:`int` size **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tile_origin` **(** :ref:`int` origin **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tileset` **(** :ref:`TileSet` tileset **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_y_sort_mode` **(** :ref:`bool` enable **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`world_to_map` **(** :ref:`Vector2` worldpos **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **settings_changed** **(** **)** +Member Variables +---------------- + +- :ref:`Transform2D` **cell_custom_transform** +- :ref:`int` **cell_half_offset** +- :ref:`int` **cell_quadrant_size** +- :ref:`Vector2` **cell_size** +- :ref:`int` **cell_tile_origin** +- :ref:`bool` **cell_y_sort** +- :ref:`float` **collision_bounce** +- :ref:`float` **collision_friction** +- :ref:`int` **collision_layers** +- :ref:`int` **collision_mask** +- :ref:`bool` **collision_use_kinematic** +- :ref:`int` **mode** +- :ref:`int` **occluder_light_mask** +- :ref:`Object` **tile_data** +- :ref:`TileSet` **tile_set** + Numeric Constants ----------------- @@ -203,7 +224,7 @@ Return whether the tilemap handles collisions as a kinematic body. .. _class_TileMap_get_custom_transform: -- :ref:`Matrix32` **get_custom_transform** **(** **)** const +- :ref:`Transform2D` **get_custom_transform** **(** **)** const Return the custom transform matrix. @@ -247,6 +268,10 @@ Return the current tileset. Return an array of all cells containing a tile from the tileset (i.e. a tile index different from -1). +.. _class_TileMap_get_used_rect: + +- :ref:`Rect2` **get_used_rect** **(** **)** + .. _class_TileMap_is_cell_transposed: - :ref:`bool` **is_cell_transposed** **(** :ref:`int` x, :ref:`int` y **)** const @@ -353,7 +378,7 @@ Set the tilemap to handle collisions as a kinematic body (enabled) or a static b .. _class_TileMap_set_custom_transform: -- void **set_custom_transform** **(** :ref:`Matrix32` custom_transform **)** +- void **set_custom_transform** **(** :ref:`Transform2D` custom_transform **)** Set custom transform matrix, to use in combination with the custom orientation mode. diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index 5e1a14d0a..8ab673346 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -18,67 +18,67 @@ Tile library for tilemaps. Member Functions ---------------- -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_tile` **(** :ref:`int` id **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_tile_by_name` **(** :ref:`String` name **)** const | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_last_unused_tile_id` **(** **)** const | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_tiles_ids` **(** **)** const | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_tile` **(** :ref:`int` id **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`OccluderPolygon2D` | :ref:`tile_get_light_occluder` **(** :ref:`int` id **)** const | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`CanvasItemMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** const | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tile_get_name` **(** :ref:`int` id **)** const | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NavigationPolygon` | :ref:`tile_get_navigation_polygon` **(** :ref:`int` id **)** const | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_navigation_polygon_offset` **(** :ref:`int` id **)** const | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_occluder_offset` **(** :ref:`int` id **)** const | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`tile_get_region` **(** :ref:`int` id **)** const | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`tile_get_shape` **(** :ref:`int` id **)** const | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_shape_offset` **(** :ref:`int` id **)** const | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`tile_get_shapes` **(** :ref:`int` id **)** const | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tile_get_texture` **(** :ref:`int` id **)** const | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_texture_offset` **(** :ref:`int` id **)** const | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_material` **(** :ref:`int` id, :ref:`CanvasItemMaterial` material **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_name` **(** :ref:`int` id, :ref:`String` name **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_navigation_polygon_offset` **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_occluder_offset` **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_region` **(** :ref:`int` id, :ref:`Rect2` region **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape` **(** :ref:`int` id, :ref:`Shape2D` shape **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape_offset` **(** :ref:`int` id, :ref:`Vector2` shape_offset **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_texture` **(** :ref:`int` id, :ref:`Texture` texture **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_texture_offset` **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_tile` **(** :ref:`int` id **)** | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_tile_by_name` **(** :ref:`String` name **)** const | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_last_unused_tile_id` **(** **)** const | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_tiles_ids` **(** **)** const | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_tile` **(** :ref:`int` id **)** | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`OccluderPolygon2D` | :ref:`tile_get_light_occluder` **(** :ref:`int` id **)** const | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ShaderMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** const | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`tile_get_name` **(** :ref:`int` id **)** const | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NavigationPolygon` | :ref:`tile_get_navigation_polygon` **(** :ref:`int` id **)** const | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_navigation_polygon_offset` **(** :ref:`int` id **)** const | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_occluder_offset` **(** :ref:`int` id **)** const | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`tile_get_region` **(** :ref:`int` id **)** const | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape2D` | :ref:`tile_get_shape` **(** :ref:`int` id **)** const | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_shape_offset` **(** :ref:`int` id **)** const | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`tile_get_shapes` **(** :ref:`int` id **)** const | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`tile_get_texture` **(** :ref:`int` id **)** const | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_texture_offset` **(** :ref:`int` id **)** const | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_material` **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_name` **(** :ref:`int` id, :ref:`String` name **)** | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_navigation_polygon_offset` **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_occluder_offset` **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_region` **(** :ref:`int` id, :ref:`Rect2` region **)** | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape` **(** :ref:`int` id, :ref:`Shape2D` shape **)** | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape_offset` **(** :ref:`int` id, :ref:`Vector2` shape_offset **)** | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_texture` **(** :ref:`int` id, :ref:`Texture` texture **)** | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_texture_offset` **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -134,7 +134,7 @@ Return the light occluder of the tile. .. _class_TileSet_tile_get_material: -- :ref:`CanvasItemMaterial` **tile_get_material** **(** :ref:`int` id **)** const +- :ref:`ShaderMaterial` **tile_get_material** **(** :ref:`int` id **)** const Return the material of the tile. @@ -206,7 +206,7 @@ Set a light occluder for the tile. .. _class_TileSet_tile_set_material: -- void **tile_set_material** **(** :ref:`int` id, :ref:`CanvasItemMaterial` material **)** +- void **tile_set_material** **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** Set the material of the tile. diff --git a/classes/class_timer.rst b/classes/class_timer.rst index 4bd507b9f..ab88e0dc7 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -27,16 +27,18 @@ Member Functions +----------------------------+------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_autostart` **(** **)** const | +----------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_one_shot` **(** **)** const | +----------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` active **)** | +| :ref:`bool` | :ref:`is_paused` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_stopped` **(** **)** const | +----------------------------+------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_autostart` **(** :ref:`bool` enable **)** | +----------------------------+------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_one_shot` **(** :ref:`bool` enable **)** | +----------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_paused` **(** :ref:`bool` paused **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_timer_process_mode` **(** :ref:`int` mode **)** | +----------------------------+------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_wait_time` **(** :ref:`float` time_sec **)** | @@ -51,6 +53,14 @@ Signals - **timeout** **(** **)** +Member Variables +---------------- + +- :ref:`bool` **autostart** +- :ref:`bool` **one_shot** +- :ref:`int` **process_mode** +- :ref:`float` **wait_time** + Numeric Constants ----------------- @@ -89,23 +99,21 @@ Return the wait time in seconds. Return true if set to automatically start when entering the scene. -.. _class_Timer_is_active: - -- :ref:`bool` **is_active** **(** **)** const - -Return if the timer is active or not. - .. _class_Timer_is_one_shot: - :ref:`bool` **is_one_shot** **(** **)** const Return true if configured as one-shot. -.. _class_Timer_set_active: +.. _class_Timer_is_paused: -- void **set_active** **(** :ref:`bool` active **)** +- :ref:`bool` **is_paused** **(** **)** const -Set whether the timer is active or not. An inactive timer will be paused until it is activated again. +Return if the timer is paused or not. + +.. _class_Timer_is_stopped: + +- :ref:`bool` **is_stopped** **(** **)** const .. _class_Timer_set_autostart: @@ -119,6 +127,12 @@ Set to automatically start when entering the scene. Set as one-shot. If enabled, the timer will stop after timeout, otherwise it will automatically restart. +.. _class_Timer_set_paused: + +- void **set_paused** **(** :ref:`bool` paused **)** + +Set whether the timer is paused or not. A paused timer will be inactive until it is unpaused again. + .. _class_Timer_set_timer_process_mode: - void **set_timer_process_mode** **(** :ref:`int` mode **)** diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index 4044f5058..a2a9b5bbf 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -23,6 +23,8 @@ Member Functions +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_bitmask` **(** **)** const | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_shape` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_texture` **(** **)** const | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_texture_pressed` **(** **)** const | @@ -33,12 +35,22 @@ Member Functions +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_pressed` **(** **)** const | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shape_centered` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shape_visible` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_action` **(** :ref:`String` action **)** | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bitmask` **(** :ref:`Object` bitmask **)** | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_passby_press` **(** :ref:`bool` enabled **)** | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape` **(** :ref:`Object` shape **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape_centered` **(** :ref:`bool` bool **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape_visible` **(** :ref:`bool` bool **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture` **(** :ref:`Object` texture **)** | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture_pressed` **(** :ref:`Object` texture_pressed **)** | @@ -52,6 +64,19 @@ Signals - **pressed** **(** **)** - **released** **(** **)** +Member Variables +---------------- + +- :ref:`String` **action** +- :ref:`BitMap` **bitmask** +- :ref:`Texture` **normal** +- :ref:`bool` **passby_press** +- :ref:`Texture` **pressed** +- :ref:`Shape2D` **shape** +- :ref:`bool` **shape_centered** +- :ref:`bool` **shape_visible** +- :ref:`int` **visibility_mode** + Member Function Description --------------------------- @@ -63,6 +88,10 @@ Member Function Description - :ref:`Object` **get_bitmask** **(** **)** const +.. _class_TouchScreenButton_get_shape: + +- :ref:`Object` **get_shape** **(** **)** const + .. _class_TouchScreenButton_get_texture: - :ref:`Object` **get_texture** **(** **)** const @@ -83,6 +112,14 @@ Member Function Description - :ref:`bool` **is_pressed** **(** **)** const +.. _class_TouchScreenButton_is_shape_centered: + +- :ref:`bool` **is_shape_centered** **(** **)** const + +.. _class_TouchScreenButton_is_shape_visible: + +- :ref:`bool` **is_shape_visible** **(** **)** const + .. _class_TouchScreenButton_set_action: - void **set_action** **(** :ref:`String` action **)** @@ -95,6 +132,18 @@ Member Function Description - void **set_passby_press** **(** :ref:`bool` enabled **)** +.. _class_TouchScreenButton_set_shape: + +- void **set_shape** **(** :ref:`Object` shape **)** + +.. _class_TouchScreenButton_set_shape_centered: + +- void **set_shape_centered** **(** :ref:`bool` bool **)** + +.. _class_TouchScreenButton_set_shape_visible: + +- void **set_shape_visible** **(** :ref:`bool` bool **)** + .. _class_TouchScreenButton_set_texture: - void **set_texture** **(** :ref:`Object` texture **)** diff --git a/classes/class_transform.rst b/classes/class_transform.rst index 69f1f122b..bccc77d43 100644 --- a/classes/class_transform.rst +++ b/classes/class_transform.rst @@ -19,13 +19,13 @@ Member Functions +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform` | :ref:`Transform` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`Transform` **(** :ref:`Matrix3` basis, :ref:`Vector3` origin **)** | +| :ref:`Transform` | :ref:`Transform` **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`Transform` **(** :ref:`Matrix32` from **)** | +| :ref:`Transform` | :ref:`Transform` **(** :ref:`Transform2D` from **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform` | :ref:`Transform` **(** :ref:`Quat` from **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`Transform` **(** :ref:`Matrix3` from **)** | +| :ref:`Transform` | :ref:`Transform` **(** :ref:`Basis` from **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform` | :ref:`affine_inverse` **(** **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -49,13 +49,13 @@ Member Functions Member Variables ---------------- -- :ref:`Matrix3` **basis** - The basis contains 3 [Vector3]. X axis, Y axis, and Z axis. +- :ref:`Basis` **basis** - The basis is a matrix containing 3 [Vector3] as its columns: X axis, Y axis, and Z axis. These vectors can be interpreted as the basis vectors of local coordinate system travelling with the object. - :ref:`Vector3` **origin** - The origin of the transform. Which is the translation offset. Description ----------- -Transform is used to store transformations, including translations. It consists of a Matrix3 "basis" and Vector3 "origin". Transform is used to represent transformations of any object in space. It is similar to a 4x3 matrix. +Transform is used to store translation, rotation and scaling transformations. It consists of a Basis "basis" and Vector3 "origin". Transform is used to represent transformations of objects in space, and as such, determine their position, orientation and scale. It is similar to a 3x4 matrix. Member Function Description --------------------------- @@ -64,43 +64,43 @@ Member Function Description - :ref:`Transform` **Transform** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** -Construct the Transform from four Vector3. Each axis creates the basis. +Construct the Transform from four Vector3. Each axis corresponds to local basis vectors (some of which may be scaled). .. _class_Transform_Transform: -- :ref:`Transform` **Transform** **(** :ref:`Matrix3` basis, :ref:`Vector3` origin **)** +- :ref:`Transform` **Transform** **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** -Construct the Transform from a Matrix3 and Vector3. +Construct the Transform from a Basis and Vector3. .. _class_Transform_Transform: -- :ref:`Transform` **Transform** **(** :ref:`Matrix32` from **)** +- :ref:`Transform` **Transform** **(** :ref:`Transform2D` from **)** -Construct the Transform from a Matrix32. +Construct the Transform from a Transform2D. .. _class_Transform_Transform: - :ref:`Transform` **Transform** **(** :ref:`Quat` from **)** -Construct the Transform from a Quat. The origin will be Vector3(0, 0, 0) +Construct the Transform from a Quat. The origin will be Vector3(0, 0, 0). .. _class_Transform_Transform: -- :ref:`Transform` **Transform** **(** :ref:`Matrix3` from **)** +- :ref:`Transform` **Transform** **(** :ref:`Basis` from **)** -Construct the Transform from a Matrix3. The origin will be Vector3(0, 0, 0) +Construct the Transform from a Basis. The origin will be Vector3(0, 0, 0). .. _class_Transform_affine_inverse: - :ref:`Transform` **affine_inverse** **(** **)** -Returns the inverse of the transfrom, even if the transform has scale or the axis vectors are not orthogonal. +Returns the inverse of the transfrom, under the assumption that the transformation is composed of rotation, scaling and translation. .. _class_Transform_inverse: - :ref:`Transform` **inverse** **(** **)** -Returns the inverse of the transform. +Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling). .. _class_Transform_looking_at: @@ -118,25 +118,25 @@ Returns a transfrom with the basis orthogonal (90 degrees), and normalized axis - :ref:`Transform` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** -Rotate the transform locally. This introduces an additional pre-rotation to the transform, changing the basis to basis \* Matrix3(axis, phi). +Rotate the transform around given axis by phi. The axis must be a normalized vector. .. _class_Transform_scaled: - :ref:`Transform` **scaled** **(** :ref:`Vector3` scale **)** -Scale the transform locally. +Scale the transform by the specified 3D scaling factors. .. _class_Transform_translated: - :ref:`Transform` **translated** **(** :ref:`Vector3` ofs **)** -Translate the transform locally. +Translate the transform by the specified displacement. .. _class_Transform_xform: - var **xform** **(** var v **)** -Transforms vector "v" by this transform. +Transforms the given vector "v" by this transform. .. _class_Transform_xform_inv: diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst new file mode 100644 index 000000000..fc53a7c01 --- /dev/null +++ b/classes/class_transform2d.rst @@ -0,0 +1,140 @@ +.. 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_Transform2D: + +Transform2D +=========== + +**Category:** Built-In Types + +Brief Description +----------------- + +3x2 Matrix for 2D transforms. + +Member Functions +---------------- + ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Transform` from **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`float` rot, :ref:`Vector2` pos **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`affine_inverse` **(** **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`basis_xform` **(** var v **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`basis_xform_inv` **(** var v **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_origin` **(** **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation` **(** **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scale` **(** **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`interpolate_with` **(** :ref:`Transform2D` m, :ref:`float` c **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`inverse` **(** **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`orthonormalized` **(** **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`rotated` **(** :ref:`float` phi **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`scaled` **(** :ref:`Vector2` scale **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`translated` **(** :ref:`Vector2` offset **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`xform` **(** var v **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`xform_inv` **(** var v **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Vector2` **o** +- :ref:`Vector2` **x** +- :ref:`Vector2` **y** + +Description +----------- + +3x2 Matrix for 2D transforms. + +Member Function Description +--------------------------- + +.. _class_Transform2D_Transform2D: + +- :ref:`Transform2D` **Transform2D** **(** :ref:`Transform` from **)** + +.. _class_Transform2D_Transform2D: + +- :ref:`Transform2D` **Transform2D** **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** + +.. _class_Transform2D_Transform2D: + +- :ref:`Transform2D` **Transform2D** **(** :ref:`float` rot, :ref:`Vector2` pos **)** + +.. _class_Transform2D_affine_inverse: + +- :ref:`Transform2D` **affine_inverse** **(** **)** + +Return the inverse of the matrix. + +.. _class_Transform2D_basis_xform: + +- :ref:`Transform2D` **basis_xform** **(** var v **)** + +.. _class_Transform2D_basis_xform_inv: + +- :ref:`Transform2D` **basis_xform_inv** **(** var v **)** + +.. _class_Transform2D_get_origin: + +- :ref:`Vector2` **get_origin** **(** **)** + +.. _class_Transform2D_get_rotation: + +- :ref:`float` **get_rotation** **(** **)** + +.. _class_Transform2D_get_scale: + +- :ref:`Vector2` **get_scale** **(** **)** + +.. _class_Transform2D_interpolate_with: + +- :ref:`Transform2D` **interpolate_with** **(** :ref:`Transform2D` m, :ref:`float` c **)** + +.. _class_Transform2D_inverse: + +- :ref:`Transform2D` **inverse** **(** **)** + +.. _class_Transform2D_orthonormalized: + +- :ref:`Transform2D` **orthonormalized** **(** **)** + +.. _class_Transform2D_rotated: + +- :ref:`Transform2D` **rotated** **(** :ref:`float` phi **)** + +.. _class_Transform2D_scaled: + +- :ref:`Transform2D` **scaled** **(** :ref:`Vector2` scale **)** + +.. _class_Transform2D_translated: + +- :ref:`Transform2D` **translated** **(** :ref:`Vector2` offset **)** + +.. _class_Transform2D_xform: + +- :ref:`Transform2D` **xform** **(** var v **)** + +.. _class_Transform2D_xform_inv: + +- :ref:`Transform2D` **xform_inv** **(** var v **)** + + diff --git a/classes/class_translation.rst b/classes/class_translation.rst index 31fb0a5e8..15d7257b4 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -20,21 +20,27 @@ Language Translation. Member Functions ---------------- -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_message` **(** :ref:`String` src_message, :ref:`String` xlated_message **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_message` **(** :ref:`String` src_message **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_locale` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_message` **(** :ref:`String` src_message **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_message_count` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_message_list` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_locale` **(** :ref:`String` locale **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_message` **(** :ref:`String` src_message, :ref:`String` xlated_message **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_message` **(** :ref:`String` src_message **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_locale` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_message` **(** :ref:`String` src_message **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_message_count` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_message_list` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_locale` **(** :ref:`String` locale **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`String` **locale** +- :ref:`PoolStringArray` **messages** Description ----------- @@ -74,7 +80,7 @@ Return a message for translation. .. _class_Translation_get_message_list: -- :ref:`StringArray` **get_message_list** **(** **)** const +- :ref:`PoolStringArray` **get_message_list** **(** **)** const Return all the messages (keys). diff --git a/classes/class_tree.rst b/classes/class_tree.rst index e6786bf8e..6cd8aaa15 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -63,8 +63,6 @@ Member Functions +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_single_select_cell_editing_only_when_already_selected` **(** **)** const | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_delayed_text_editor_enabled` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_folding_hidden` **(** **)** const | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_allow_rmb_select` **(** :ref:`bool` allow **)** | @@ -79,8 +77,6 @@ Member Functions +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_columns` **(** :ref:`int` amount **)** | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_delayed_text_editor` **(** :ref:`bool` enable **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_drop_mode_flags` **(** :ref:`int` flags **)** | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_hide_folding` **(** :ref:`bool` hide **)** | @@ -270,10 +266,6 @@ Get the column number of the current selection. Get whether the editing of a cell should only happen when it is already selected. -.. _class_Tree_is_delayed_text_editor_enabled: - -- :ref:`bool` **is_delayed_text_editor_enabled** **(** **)** const - .. _class_Tree_is_folding_hidden: - :ref:`bool` **is_folding_hidden** **(** **)** const @@ -316,10 +308,6 @@ Set whether the column titles visibility. Set the amount of columns. -.. _class_Tree_set_delayed_text_editor: - -- void **set_delayed_text_editor** **(** :ref:`bool` enable **)** - .. _class_Tree_set_drop_mode_flags: - void **set_drop_mode_flags** **(** :ref:`int` flags **)** diff --git a/classes/class_spatialsoundserversw.rst b/classes/class_trianglemesh.rst similarity index 54% rename from classes/class_spatialsoundserversw.rst rename to classes/class_trianglemesh.rst index 2673539a7..b8d850a90 100644 --- a/classes/class_spatialsoundserversw.rst +++ b/classes/class_trianglemesh.rst @@ -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_SpatialSoundServerSW: +.. _class_TriangleMesh: -SpatialSoundServerSW -==================== +TriangleMesh +============ -**Inherits:** :ref:`SpatialSoundServer` **<** :ref:`Object` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core diff --git a/classes/class_tween.rst b/classes/class_tween.rst index 1c31d14eb..fcf5ff368 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -18,71 +18,76 @@ Node useful for animations with unknown start and end points. Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`follow_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`follow_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_runtime` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_speed` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tween_process_mode` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_callback` **(** :ref:`Object` object, :ref:`float` times_in_sec, :ref:`String` callback, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL, :ref:`Variant` arg5=NULL **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_deferred_callback` **(** :ref:`Object` object, :ref:`float` times_in_sec, :ref:`String` callback, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL, :ref:`Variant` arg5=NULL **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_repeat` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove_all` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`reset` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`reset_all` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`resume` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`resume_all` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`seek` **(** :ref:`float` time **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` active **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_repeat` **(** :ref:`bool` repeat **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_speed` **(** :ref:`float` speed **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tween_process_mode` **(** :ref:`int` mode **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`start` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`stop` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`stop_all` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`targeting_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`targeting_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, :ref:`Variant` final_val, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tell` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`follow_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`follow_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_runtime` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_speed_scale` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tween_process_mode` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`interpolate_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL, :ref:`Variant` arg5=NULL **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`interpolate_deferred_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL, :ref:`Variant` arg5=NULL **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`interpolate_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`interpolate_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_active` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_repeat` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`remove` **(** :ref:`Object` object, :ref:`String` key="" **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`remove_all` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`reset` **(** :ref:`Object` object, :ref:`String` key="" **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`reset_all` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`resume` **(** :ref:`Object` object, :ref:`String` key="" **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`resume_all` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`seek` **(** :ref:`float` time **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` active **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_repeat` **(** :ref:`bool` repeat **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_speed_scale` **(** :ref:`float` speed **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tween_process_mode` **(** :ref:`int` mode **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`start` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`stop` **(** :ref:`Object` object, :ref:`String` key="" **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`stop_all` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`targeting_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`targeting_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tell` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -- **tween_complete** **(** :ref:`Object` object, :ref:`String` key **)** -- **tween_start** **(** :ref:`Object` object, :ref:`String` key **)** +- **tween_completed** **(** :ref:`Object` object, :ref:`String` key **)** +- **tween_started** **(** :ref:`Object` object, :ref:`String` key **)** - **tween_step** **(** :ref:`Object` object, :ref:`String` key, :ref:`float` elapsed, :ref:`Object` value **)** +Member Variables +---------------- + +- :ref:`int` **playback_process_mode** + Numeric Constants ----------------- @@ -119,26 +124,26 @@ Because it is easy to get it wrong, here is a quick usage example: Some of the methods of this class require a property name. You can get the property name by hovering over the property in the inspector of the editor. -Many of the methods accept ``trans_type`` and ``ease_type``. The first accepts an TRANS\_\* constant, and refers to the way the timing of the animation is handled (you might want to see ``http://easings.net/`` for some examples). The second accepts an EASE\_\* constant, and controls the where ``trans_type`` is applied to the interpolation (in the begining, the end, or both). If you don't know which transision and easing to pick, you can try different TRANS\_\* constants with EASE_IN_OUT, and use the one that looks best. +Many of the methods accept ``trans_type`` and ``ease_type``. The first accepts an TRANS\_\* constant, and refers to the way the timing of the animation is handled (you might want to see ``http://easings.net/`` for some examples). The second accepts an EASE\_\* constant, and controls the where ``trans_type`` is applied to the interpolation (in the beginning, the end, or both). If you don't know which transision and easing to pick, you can try different TRANS\_\* constants with EASE_IN_OUT, and use the one that looks best. Member Function Description --------------------------- .. _class_Tween_follow_method: -- :ref:`bool` **follow_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **follow_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** -Follow ``method`` of ``object`` and apply the returned value on ``target_method`` of ``target``, beginning from ``initial_val`` for ``times_in_sec`` seconds, ``delay`` later. Methods are animated by calling them with consequitive values. +Follow ``method`` of ``object`` and apply the returned value on ``target_method`` of ``target``, beginning from ``initial_val`` for ``duration`` seconds, ``delay`` later. Methods are animated by calling them with consequitive values. -``trans_type`` accepts TRANS\_\* constants, and is the way the animation is interpolated, while ``ease_type`` accepts EASE\_\* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description. +``trans_type`` accepts TRANS\_\* constants, and is the way the animation is interpolated, while ``ease_type`` accepts EASE\_\* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. .. _class_Tween_follow_property: -- :ref:`bool` **follow_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **follow_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** -Follow ``property`` of ``object`` and apply it on ``target_property`` of ``target``, beginning from ``initial_val`` for ``times_in_sec`` seconds, ``delay`` seconds later. Note that ``target:target_property`` would equal ``object:property`` at the end of the tween. +Follow ``property`` of ``object`` and apply it on ``target_property`` of ``target``, beginning from ``initial_val`` for ``duration`` seconds, ``delay`` seconds later. Note that ``target:target_property`` would equal ``object:property`` at the end of the tween. -``trans_type`` accepts TRANS\_\* constants, and is the way the animation is interpolated, while ``ease_type`` accepts EASE\_\* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description. +``trans_type`` accepts TRANS\_\* constants, and is the way the animation is interpolated, while ``ease_type`` accepts EASE\_\* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. .. _class_Tween_get_runtime: @@ -146,9 +151,9 @@ Follow ``property`` of ``object`` and apply it on ``target_property`` of ``targe Returns the time needed for all tweens to end in seconds, measured from the start. Thus, if you have two tweens, one ending 10 seconds after the start and the other - 20 seconds, it would return 20 seconds, as by that time all tweens would have finished. -.. _class_Tween_get_speed: +.. _class_Tween_get_speed_scale: -- :ref:`float` **get_speed** **(** **)** const +- :ref:`float` **get_speed_scale** **(** **)** const Returns the speed that has been set from editor GUI or :ref:`set_repeat`. @@ -160,31 +165,31 @@ Returns the process mode that has been set from editor GUI or :ref:`set_tween_pr .. _class_Tween_interpolate_callback: -- :ref:`bool` **interpolate_callback** **(** :ref:`Object` object, :ref:`float` times_in_sec, :ref:`String` callback, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL, :ref:`Variant` arg5=NULL **)** +- :ref:`bool` **interpolate_callback** **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL, :ref:`Variant` arg5=NULL **)** -Call ``callback`` of ``object`` after ``times_in_sec``. ``arg1``-``arg5`` are arguments to be passed to the callback. +Call ``callback`` of ``object`` after ``duration``. ``arg1``-``arg5`` are arguments to be passed to the callback. .. _class_Tween_interpolate_deferred_callback: -- :ref:`bool` **interpolate_deferred_callback** **(** :ref:`Object` object, :ref:`float` times_in_sec, :ref:`String` callback, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL, :ref:`Variant` arg5=NULL **)** +- :ref:`bool` **interpolate_deferred_callback** **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL, :ref:`Variant` arg5=NULL **)** -Call ``callback`` of ``object`` after ``times_in_sec`` on the main thread (similar to :ref:`methog Object.call_deferred). [code`arg1``-``arg5`` are arguments to be passed to the callback. +Call ``callback`` of ``object`` after ``duration`` on the main thread (similar to :ref:`methog Object.call_deferred). [code`arg1``-``arg5`` are arguments to be passed to the callback. .. _class_Tween_interpolate_method: -- :ref:`bool` **interpolate_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **interpolate_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** -Animate ``method`` of ``object`` from ``initial_val`` to ``final_val`` for ``times_in_sec`` seconds, ``delay`` seconds later. Methods are animated by calling them with consecuitive values. +Animate ``method`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are animated by calling them with consecuitive values. -``trans_type`` accepts TRANS\_\* constants, and is the way the animation is interpolated, while ``ease_type`` accepts EASE\_\* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description. +``trans_type`` accepts TRANS\_\* constants, and is the way the animation is interpolated, while ``ease_type`` accepts EASE\_\* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. .. _class_Tween_interpolate_property: -- :ref:`bool` **interpolate_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **interpolate_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** -Animate ``property`` of ``object`` from ``initial_val`` to ``final_val`` for ``times_in_sec`` seconds, ``delay`` seconds later. +Animate ``property`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. -``trans_type`` accepts TRANS\_\* constants, and is the way the animation is interpolated, while ``ease_type`` accepts EASE\_\* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description. +``trans_type`` accepts TRANS\_\* constants, and is the way the animation is interpolated, while ``ease_type`` accepts EASE\_\* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. .. _class_Tween_is_active: @@ -252,9 +257,9 @@ Activate/deactivate the tween. You can use this for pausing animations, though : Make the tween repeat after all tweens have finished. -.. _class_Tween_set_speed: +.. _class_Tween_set_speed_scale: -- void **set_speed** **(** :ref:`float` speed **)** +- void **set_speed_scale** **(** :ref:`float` speed **)** Set the speed multiplier of the tween. Set it to 1 for normal speed, 2 for two times nromal speed, and 0.5 for half of the normal speed. Setting it to 0 would pause the animation, but you might consider using :ref:`set_active` or :ref:`stop_all` and :ref:`resume_all` for this. @@ -284,19 +289,19 @@ Stop animating all tweens. .. _class_Tween_targeting_method: -- :ref:`bool` **targeting_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **targeting_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** -Animate ``method`` of ``object`` from the value returned by ``initial.initial_method`` to ``final_val`` for ``times_in_sec`` seconds, ``delay`` seconds later. Methods are animated by calling them with consecuitive values. +Animate ``method`` of ``object`` from the value returned by ``initial.initial_method`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are animated by calling them with consecuitive values. -``trans_type`` accepts TRANS\_\* constants, and is the way the animation is interpolated, while ``ease_type`` accepts EASE\_\* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description. +``trans_type`` accepts TRANS\_\* constants, and is the way the animation is interpolated, while ``ease_type`` accepts EASE\_\* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. .. _class_Tween_targeting_property: -- :ref:`bool` **targeting_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, :ref:`Variant` final_val, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **targeting_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** -Animate ``property`` of ``object`` from the current value of the ``initial_val`` property of ``initial`` to ``final_val`` for ``times_in_sec`` seconds, ``delay`` seconds later. +Animate ``property`` of ``object`` from the current value of the ``initial_val`` property of ``initial`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. -``trans_type`` accepts TRANS\_\* constants, and is the way the animation is interpolated, while ``ease_type`` accepts EASE\_\* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description. +``trans_type`` accepts TRANS\_\* constants, and is the way the animation is interpolated, while ``ease_type`` accepts EASE\_\* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. .. _class_Tween_tell: diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index add7e2af3..6e6569af0 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -54,7 +54,7 @@ Description Helper to maange UndoRedo in the editor or custom tools. It works by storing calls to functions in both 'do' an 'undo' lists. -Common behavior is to create an action, then add do/undo calls to functions or property changes, then commiting the action. +Common behavior is to create an action, then add do/undo calls to functions or property changes, then committing the action. Member Function Description --------------------------- @@ -125,7 +125,7 @@ Get the name of the current action. - :ref:`int` **get_version** **(** **)** const -Get the version, each time a new action is commited, the version number of the UndoRedo is increased automatically. +Get the version, each time a new action is committed, the version number of the UndoRedo is increased automatically. This is useful mostly to check if something changed from a saved version. diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index ec748f66a..aa660448c 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -27,6 +27,10 @@ Member Functions +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angle_to_point` **(** :ref:`Vector2` to **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`aspect` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`bounce` **(** :ref:`Vector2` n **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`clamped` **(** :ref:`float` length **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`cubic_interpolate` **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` t **)** | @@ -39,10 +43,6 @@ Member Functions +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`floor` **(** **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`floorf` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_aspect` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length` **(** **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length_squared` **(** **)** | @@ -51,11 +51,11 @@ Member Functions +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`normalized` **(** **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`reflect` **(** :ref:`Vector2` vec **)** | +| :ref:`Vector2` | :ref:`reflect` **(** :ref:`Vector2` n **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`rotated` **(** :ref:`float` phi **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`slide` **(** :ref:`Vector2` vec **)** | +| :ref:`Vector2` | :ref:`slide` **(** :ref:`Vector2` n **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`snapped` **(** :ref:`Vector2` by **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -108,6 +108,18 @@ Returns the angle in radians between the two vectors. Returns the angle in radians between the line connecting the two points and the x coordinate. +.. _class_Vector2_aspect: + +- :ref:`float` **aspect** **(** **)** + +Returns the ratio of X to Y. + +.. _class_Vector2_bounce: + +- :ref:`Vector2` **bounce** **(** :ref:`Vector2` n **)** + +Bounce returns the vector "bounced off" from the given plane, specified by its normal vector. + .. _class_Vector2_clamped: - :ref:`Vector2` **clamped** **(** :ref:`float` length **)** @@ -142,18 +154,6 @@ Returns the dot product with vector "b". Remove the fractional part of x and y. -.. _class_Vector2_floorf: - -- :ref:`Vector2` **floorf** **(** **)** - -Remove the fractional part of x and y. - -.. _class_Vector2_get_aspect: - -- :ref:`float` **get_aspect** **(** **)** - -Returns the ratio of X to Y. - .. _class_Vector2_length: - :ref:`float` **length** **(** **)** @@ -180,9 +180,9 @@ Returns a normalized vector to unit length. .. _class_Vector2_reflect: -- :ref:`Vector2` **reflect** **(** :ref:`Vector2` vec **)** +- :ref:`Vector2` **reflect** **(** :ref:`Vector2` n **)** -Like "slide", but reflects the Vector instead of continuing along the wall. +Reflects the vector along the given plane, specified by its normal vector. .. _class_Vector2_rotated: @@ -192,9 +192,9 @@ Rotates the vector by "phi" radians. .. _class_Vector2_slide: -- :ref:`Vector2` **slide** **(** :ref:`Vector2` vec **)** +- :ref:`Vector2` **slide** **(** :ref:`Vector2` n **)** -Slides the vector by the other vector. +Slide returns the component of the vector along the given plane, specified by its normal vector. .. _class_Vector2_snapped: diff --git a/classes/class_vector2array.rst b/classes/class_vector2array.rst deleted file mode 100644 index 7e14da69b..000000000 --- a/classes/class_vector2array.rst +++ /dev/null @@ -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_Vector2Array: - -Vector2Array -============ - -**Category:** Built-In Types - -Brief Description ------------------ - -An Array of Vector2. - -Member Functions ----------------- - -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`Vector2Array` **(** :ref:`Array` from **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`Vector2` vector2 **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`Vector2Array` array **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`Vector2` vector2 **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - -Description ------------ - -An Array specifically designed to hold Vector2. - -Member Function Description ---------------------------- - -.. _class_Vector2Array_Vector2Array: - -- :ref:`Vector2Array` **Vector2Array** **(** :ref:`Array` from **)** - -Construct a new :ref:`Vector2Array`. Optionally, you can pass in an Array that will be converted. - -.. _class_Vector2Array_append: - -- void **append** **(** :ref:`Vector2` vector2 **)** - -Append an element at the end of the array (alias of :ref:`push_back`). - -.. _class_Vector2Array_append_array: - -- void **append_array** **(** :ref:`Vector2Array` array **)** - -Append an :ref:`Vector2Array` at the end of this array. - -.. _class_Vector2Array_insert: - -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** - -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_Vector2Array_invert: - -- void **invert** **(** **)** - -Reverse the order of the elements in the array (so first element will now be the last). - -.. _class_Vector2Array_push_back: - -- void **push_back** **(** :ref:`Vector2` vector2 **)** - -Insert a :ref:`Vector2` at the end. - -.. _class_Vector2Array_remove: - -- void **remove** **(** :ref:`int` idx **)** - -Remove an element from the array by index. - -.. _class_Vector2Array_resize: - -- void **resize** **(** :ref:`int` idx **)** - -Set the size of the Vector2Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. - -.. _class_Vector2Array_set: - -- void **set** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** - -Change the :ref:`Vector2` at the given index. - -.. _class_Vector2Array_size: - -- :ref:`int` **size** **(** **)** - -Return the size of the array. - - diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index df9115b79..4c3891c83 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -21,6 +21,10 @@ Member Functions +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`abs` **(** **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angle_to` **(** :ref:`Vector3` to **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`bounce` **(** :ref:`Vector3` n **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`ceil` **(** **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`cross` **(** :ref:`Vector3` b **)** | @@ -49,14 +53,18 @@ Member Functions +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`normalized` **(** **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`reflect` **(** :ref:`Vector3` by **)** | +| :ref:`Basis` | :ref:`outer` **(** :ref:`Vector3` b **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`reflect` **(** :ref:`Vector3` n **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`slide` **(** :ref:`Vector3` by **)** | +| :ref:`Vector3` | :ref:`slide` **(** :ref:`Vector3` n **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`snapped` **(** :ref:`float` by **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`to_diagonal_matrix` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -92,6 +100,16 @@ Returns a Vector3 with the given components. Returns a new vector with all components in absolute values (e.g. positive). +.. _class_Vector3_angle_to: + +- :ref:`float` **angle_to** **(** :ref:`Vector3` to **)** + +.. _class_Vector3_bounce: + +- :ref:`Vector3` **bounce** **(** :ref:`Vector3` n **)** + +Bounce returns the vector "bounced off" from the given plane, specified by its normal vector. + .. _class_Vector3_ceil: - :ref:`Vector3` **ceil** **(** **)** @@ -176,23 +194,29 @@ Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the smallest. Return a copy of the normalized vector to unit length. This is the same as v / v.length(). +.. _class_Vector3_outer: + +- :ref:`Basis` **outer** **(** :ref:`Vector3` b **)** + +Return the outer product with b. + .. _class_Vector3_reflect: -- :ref:`Vector3` **reflect** **(** :ref:`Vector3` by **)** +- :ref:`Vector3` **reflect** **(** :ref:`Vector3` n **)** -Like "slide", but reflects the Vector instead of continuing along the wall. +Reflects the vector along the given plane, specified by its normal vector. .. _class_Vector3_rotated: - :ref:`Vector3` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** -Rotates the vector around some axis by phi radians. +Rotates the vector around some axis by phi radians. The axis must be a normalized vector. .. _class_Vector3_slide: -- :ref:`Vector3` **slide** **(** :ref:`Vector3` by **)** +- :ref:`Vector3` **slide** **(** :ref:`Vector3` n **)** -Slides the vector along a wall. +Slide returns the component of the vector along the given plane, specified by its normal vector. .. _class_Vector3_snapped: @@ -200,4 +224,10 @@ Slides the vector along a wall. Return a copy of the vector, snapped to the lowest neared multiple. +.. _class_Vector3_to_diagonal_matrix: + +- :ref:`Basis` **to_diagonal_matrix** **(** **)** + +Return a diagonal matrix with the vector as main diagonal. + diff --git a/classes/class_vector3array.rst b/classes/class_vector3array.rst deleted file mode 100644 index dad69d82a..000000000 --- a/classes/class_vector3array.rst +++ /dev/null @@ -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_Vector3Array: - -Vector3Array -============ - -**Category:** Built-In Types - -Brief Description ------------------ - -An Array of Vector3. - -Member Functions ----------------- - -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3Array` | :ref:`Vector3Array` **(** :ref:`Array` from **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`Vector3` vector3 **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`Vector3Array` array **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`Vector3` vector3 **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - -Description ------------ - -An Array specifically designed to hold Vector3. - -Member Function Description ---------------------------- - -.. _class_Vector3Array_Vector3Array: - -- :ref:`Vector3Array` **Vector3Array** **(** :ref:`Array` from **)** - -Construct a new Vector3Array. Optionally, you can pass in an Array that will be converted. - -.. _class_Vector3Array_append: - -- void **append** **(** :ref:`Vector3` vector3 **)** - -Append an element at the end of the array (alias of :ref:`push_back`). - -.. _class_Vector3Array_append_array: - -- void **append_array** **(** :ref:`Vector3Array` array **)** - -Append an :ref:`Vector3Array` at the end of this array. - -.. _class_Vector3Array_insert: - -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** - -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_Vector3Array_invert: - -- void **invert** **(** **)** - -Reverse the order of the elements in the array (so first element will now be the last). - -.. _class_Vector3Array_push_back: - -- void **push_back** **(** :ref:`Vector3` vector3 **)** - -Insert a Vector3 at the end. - -.. _class_Vector3Array_remove: - -- void **remove** **(** :ref:`int` idx **)** - -Remove an element from the array by index. - -.. _class_Vector3Array_resize: - -- void **resize** **(** :ref:`int` idx **)** - -Set the size of the Vector3Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. - -.. _class_Vector3Array_set: - -- void **set** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** - -Change the :ref:`Vector3` at the given index. - -.. _class_Vector3Array_size: - -- :ref:`int` **size** **(** **)** - -Return the size of the array. - - diff --git a/classes/class_vehiclebody.rst b/classes/class_vehiclebody.rst index 8db73e814..74feafec6 100644 --- a/classes/class_vehiclebody.rst +++ b/classes/class_vehiclebody.rst @@ -42,6 +42,15 @@ Member Functions | void | :ref:`set_steering` **(** :ref:`float` steering **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **brake** +- :ref:`float` **engine_force** +- :ref:`float` **friction** +- :ref:`float` **mass** +- :ref:`float` **steering** + Member Function Description --------------------------- diff --git a/classes/class_vehiclewheel.rst b/classes/class_vehiclewheel.rst index 93ea847b8..c2cb3472c 100644 --- a/classes/class_vehiclewheel.rst +++ b/classes/class_vehiclewheel.rst @@ -60,6 +60,20 @@ Member Functions | void | :ref:`set_use_as_traction` **(** :ref:`bool` enable **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`float` **damping_compression** +- :ref:`float` **damping_relaxation** +- :ref:`float` **suspension_max_force** +- :ref:`float` **suspension_stiffness** +- :ref:`float` **suspension_travel** +- :ref:`bool` **use_as_steering** +- :ref:`bool` **use_as_traction** +- :ref:`float` **wheel_friction_slip** +- :ref:`float` **wheel_radius** +- :ref:`float` **wheel_rest_length** + Member Function Description --------------------------- diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index 79359cb61..ae91bf1ac 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -64,6 +64,16 @@ Member Functions | void | :ref:`stop` **(** **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **audio_track** +- :ref:`bool` **autoplay** +- :ref:`bool` **expand** +- :ref:`bool` **paused** +- :ref:`VideoStream` **stream** +- :ref:`float` **volume_db** + Description ----------- diff --git a/classes/class_videostream.rst b/classes/class_videostream.rst index 239b4c75d..fc522ade4 100644 --- a/classes/class_videostream.rst +++ b/classes/class_videostream.rst @@ -8,8 +8,6 @@ VideoStream **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VideoStreamTheora` - **Category:** Core Brief Description diff --git a/classes/class_videostreamtheora.rst b/classes/class_videostreamtheora.rst deleted file mode 100644 index 054c41640..000000000 --- a/classes/class_videostreamtheora.rst +++ /dev/null @@ -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_VideoStreamTheora: - -VideoStreamTheora -================= - -**Inherits:** :ref:`VideoStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 66482409a..9703a6ad7 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -18,134 +18,178 @@ Creates a sub-view into the screen. Member Functions ---------------- -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`find_world` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`find_world_2d` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Camera` | :ref:`get_camera` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`get_canvas_transform` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`get_final_transform` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`get_global_canvas_transform` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_mouse_pos` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_physics_object_picking` **(** **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_render_target_clear_on_new_frame` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_render_target_filter` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_render_target_gen_mipmaps` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RenderTargetTexture` | :ref:`get_render_target_texture` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_render_target_update_mode` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_render_target_vflip` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_screen_capture` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size_override` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_viewport` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_visible_rect` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`get_world` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui_has_modal_stack` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_transparent_background` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input` **(** :ref:`InputEvent` local_event **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_audio_listener` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_audio_listener_2d` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_input_disabled` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_set_as_render_target` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_size_override_enabled` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_size_override_stretch_enabled` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_own_world` **(** **)** const | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_screen_capture` **(** **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`render_target_clear` **(** **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_audio_listener` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_audio_listener_2d` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_render_target` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_canvas_transform` **(** :ref:`Matrix32` xform **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_input` **(** :ref:`bool` disable **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_canvas_transform` **(** :ref:`Matrix32` xform **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_physics_object_picking` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rect` **(** :ref:`Rect2` rect **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_render_target_clear_on_new_frame` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_render_target_filter` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_render_target_gen_mipmaps` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_render_target_to_screen_rect` **(** :ref:`Rect2` rect **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_render_target_update_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_render_target_vflip` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size_override` **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2(-1, -1), :ref:`Vector2` margin=Vector2(0, 0) **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size_override_stretch` **(** :ref:`bool` enabled **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transparent_background` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_own_world` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_world` **(** :ref:`World` world **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_world_2d` **(** :ref:`World2D` world_2d **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unhandled_input` **(** :ref:`InputEvent` local_event **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_worlds` **(** **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_pos **)** | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World` | :ref:`find_world` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`find_world_2d` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Camera` | :ref:`get_camera` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_clear_on_new_frame` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_final_transform` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_global_canvas_transform` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_hdr` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_mouse_pos` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_msaa` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_physics_object_picking` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_screen_capture` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_atlas_size` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size_override` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ViewportTexture` | :ref:`get_texture` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_update_mode` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_vflip` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_viewport_rid` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_visible_rect` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World` | :ref:`get_world` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gui_has_modal_stack` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_transparent_background` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`input` **(** :ref:`InputEvent` local_event **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_3d_disabled` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_audio_listener` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_audio_listener_2d` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_input_disabled` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_size_override_enabled` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_size_override_stretch_enabled` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_own_world` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_screen_capture` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_audio_listener` **(** :ref:`bool` enable **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_audio_listener_2d` **(** :ref:`bool` enable **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_attach_to_screen_rect` **(** :ref:`Rect2` rect **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_canvas_transform` **(** :ref:`Transform2D` xform **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clear_on_new_frame` **(** :ref:`bool` enable **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_3d` **(** :ref:`bool` disable **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_input` **(** :ref:`bool` disable **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_canvas_transform` **(** :ref:`Transform2D` xform **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hdr` **(** :ref:`bool` enable **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_msaa` **(** :ref:`int` msaa **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_physics_object_picking` **(** :ref:`bool` enable **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant, :ref:`int` subdiv **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_atlas_size` **(** :ref:`int` size **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size_override` **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2(-1, -1), :ref:`Vector2` margin=Vector2(0, 0) **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size_override_stretch` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transparent_background` **(** :ref:`bool` enable **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_update_mode` **(** :ref:`int` mode **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_own_world` **(** :ref:`bool` enable **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vflip` **(** :ref:`bool` enable **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_world` **(** :ref:`World` world **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_world_2d` **(** :ref:`World2D` world_2d **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unhandled_input` **(** :ref:`InputEvent` local_event **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_worlds` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_pos **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **size_changed** **(** **)** +Member Variables +---------------- + +- :ref:`bool` **audio_listener_enable_2d** +- :ref:`bool` **audio_listener_enable_3d** +- :ref:`bool` **disable_3d** +- :ref:`bool` **gui_disable_input** +- :ref:`bool` **hdr** +- :ref:`int` **msaa** +- :ref:`bool` **own_world** +- :ref:`bool` **physics_object_picking** +- :ref:`bool` **render_target_clear_on_new_frame** +- :ref:`int` **render_target_update_mode** +- :ref:`bool` **render_target_v_flip** +- :ref:`int` **shadow_atlas_quad_0** +- :ref:`int` **shadow_atlas_quad_1** +- :ref:`int` **shadow_atlas_quad_2** +- :ref:`int` **shadow_atlas_quad_3** +- :ref:`int` **shadow_atlas_size** +- :ref:`Rect2` **size** +- :ref:`bool` **transparent_bg** +- :ref:`World` **world** + Numeric Constants ----------------- -- **RENDER_TARGET_UPDATE_DISABLED** = **0** --- Do not update the render target. -- **RENDER_TARGET_UPDATE_ONCE** = **1** --- Update the render target once, then switch to ``RENDER_TARGET_UPDATE_DISABLED`` -- **RENDER_TARGET_UPDATE_WHEN_VISIBLE** = **2** --- Update the render target only when it is visible. This is the default value. -- **RENDER_TARGET_UPDATE_ALWAYS** = **3** --- Update the render target always. +- **UPDATE_DISABLED** = **0** --- Do not update the render target. +- **UPDATE_ONCE** = **1** --- Update the render target once, then switch to ``UPDATE_DISABLED`` +- **UPDATE_WHEN_VISIBLE** = **2** --- Update the render target only when it is visible. This is the default value. +- **UPDATE_ALWAYS** = **3** +- **SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED** = **0** +- **SHADOW_ATLAS_QUADRANT_SUBDIV_1** = **1** +- **SHADOW_ATLAS_QUADRANT_SUBDIV_4** = **2** +- **SHADOW_ATLAS_QUADRANT_SUBDIV_16** = **3** +- **SHADOW_ATLAS_QUADRANT_SUBDIV_64** = **4** +- **SHADOW_ATLAS_QUADRANT_SUBDIV_256** = **5** +- **SHADOW_ATLAS_QUADRANT_SUBDIV_1024** = **6** +- **SHADOW_ATLAS_QUADRANT_SUBDIV_MAX** = **7** +- **MSAA_DISABLED** = **0** +- **MSAA_2X** = **1** +- **MSAA_4X** = **2** +- **MSAA_8X** = **3** +- **MSAA_16X** = **4** Description ----------- @@ -165,6 +209,12 @@ Finally, viewports can also behave as render targets, in which case they will no Member Function Description --------------------------- +.. _class_Viewport_clear: + +- void **clear** **(** **)** + +Clear the viewport manually. + .. _class_Viewport_find_world: - :ref:`World` **find_world** **(** **)** const @@ -185,81 +235,69 @@ Return the active 3D camera. .. _class_Viewport_get_canvas_transform: -- :ref:`Matrix32` **get_canvas_transform** **(** **)** const +- :ref:`Transform2D` **get_canvas_transform** **(** **)** const Get the canvas transform of the viewport. +.. _class_Viewport_get_clear_on_new_frame: + +- :ref:`bool` **get_clear_on_new_frame** **(** **)** const + +Return whether automatic clearing of the render target on each frame is enabled. + .. _class_Viewport_get_final_transform: -- :ref:`Matrix32` **get_final_transform** **(** **)** const +- :ref:`Transform2D` **get_final_transform** **(** **)** const Get the total transform of the viewport. .. _class_Viewport_get_global_canvas_transform: -- :ref:`Matrix32` **get_global_canvas_transform** **(** **)** const +- :ref:`Transform2D` **get_global_canvas_transform** **(** **)** const Get the global canvas transform of the viewport. +.. _class_Viewport_get_hdr: + +- :ref:`bool` **get_hdr** **(** **)** const + +Get whether the rendered texture has filters enabled. + .. _class_Viewport_get_mouse_pos: - :ref:`Vector2` **get_mouse_pos** **(** **)** const Get the mouse position, relative to the viewport. +.. _class_Viewport_get_msaa: + +- :ref:`int` **get_msaa** **(** **)** const + .. _class_Viewport_get_physics_object_picking: - :ref:`bool` **get_physics_object_picking** **(** **)** Get whether picking for all physics objects inside the viewport is enabled. -.. _class_Viewport_get_rect: - -- :ref:`Rect2` **get_rect** **(** **)** const - -Return the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. Otherwise, if the rect is empty, the viewport will use all the allowed space. - -.. _class_Viewport_get_render_target_clear_on_new_frame: - -- :ref:`bool` **get_render_target_clear_on_new_frame** **(** **)** const - -Return whether automatic clearing of the render target on each frame is enabled. - -.. _class_Viewport_get_render_target_filter: - -- :ref:`bool` **get_render_target_filter** **(** **)** const - -Get whether the rendered texture has filters enabled. - -.. _class_Viewport_get_render_target_gen_mipmaps: - -- :ref:`bool` **get_render_target_gen_mipmaps** **(** **)** const - -Get whether the rendered texture will have mipmaps generated. - -.. _class_Viewport_get_render_target_texture: - -- :ref:`RenderTargetTexture` **get_render_target_texture** **(** **)** const - -Get the render target's texture, for use with various objects that you want to texture with the viewport. - -.. _class_Viewport_get_render_target_update_mode: - -- :ref:`int` **get_render_target_update_mode** **(** **)** const - -Get when the render target would be updated, will be one of the ``RENDER_TARGET_UPDATE\_\*`` constants. - -.. _class_Viewport_get_render_target_vflip: - -- :ref:`bool` **get_render_target_vflip** **(** **)** const - -Set whether the render target is flipped on the Y axis. - .. _class_Viewport_get_screen_capture: - :ref:`Image` **get_screen_capture** **(** **)** const -Return the captured screenshot after :ref:`queue_screen_capture`. You might need to check more than one frame untill the right image is returned. +Return the captured screenshot after :ref:`queue_screen_capture`. You might need to check more than one frame until the right image is returned. + +.. _class_Viewport_get_shadow_atlas_quadrant_subdiv: + +- :ref:`int` **get_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant **)** const + +.. _class_Viewport_get_shadow_atlas_size: + +- :ref:`int` **get_shadow_atlas_size** **(** **)** const + +.. _class_Viewport_get_size: + +- :ref:`Vector2` **get_size** **(** **)** const + +Return the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. Otherwise, if the rect is empty, the viewport will use all the allowed space. .. _class_Viewport_get_size_override: @@ -267,11 +305,29 @@ Return the captured screenshot after :ref:`queue_screen_capture`. -.. _class_Viewport_get_viewport: +.. _class_Viewport_get_texture: -- :ref:`RID` **get_viewport** **(** **)** const +- :ref:`ViewportTexture` **get_texture** **(** **)** const -Get the viewport RID from the visual server. +Get the viewport's texture, for use with various objects that you want to texture with the viewport. + +.. _class_Viewport_get_update_mode: + +- :ref:`int` **get_update_mode** **(** **)** const + +Get when the viewport would be updated, will be one of the ``UPDATE\_\*`` constants. + +.. _class_Viewport_get_vflip: + +- :ref:`bool` **get_vflip** **(** **)** const + +Set whether the render target is flipped on the Y axis. + +.. _class_Viewport_get_viewport_rid: + +- :ref:`RID` **get_viewport_rid** **(** **)** const + +Get the viewport RID from the :ref:`VisualServer`. .. _class_Viewport_get_visible_rect: @@ -289,6 +345,8 @@ Return the 3D world of the viewport. - :ref:`World2D` **get_world_2d** **(** **)** const +Return the 2D world of the viewport. + .. _class_Viewport_gui_get_drag_data: - :ref:`Variant` **gui_get_drag_data** **(** **)** const @@ -311,6 +369,10 @@ Return whether the viewport lets whatever is behind it to show. - void **input** **(** :ref:`InputEvent` local_event **)** +.. _class_Viewport_is_3d_disabled: + +- :ref:`bool` **is_3d_disabled** **(** **)** const + .. _class_Viewport_is_audio_listener: - :ref:`bool` **is_audio_listener** **(** **)** const @@ -329,12 +391,6 @@ Returns whether the viewport sends soundsfrom 2D emitters to the speakers. Return whether input to the viewport is disabled. -.. _class_Viewport_is_set_as_render_target: - -- :ref:`bool` **is_set_as_render_target** **(** **)** const - -Return whether the viewport is set as a render target by :ref:`set_as_render_target`. - .. _class_Viewport_is_size_override_enabled: - :ref:`bool` **is_size_override_enabled** **(** **)** const @@ -359,12 +415,6 @@ Return whether the viewport is using a world separate from the parent viewport's Queue a multithreaded screenshot, you can retrive it at a later frame via :ref:`get_screen_capture`. -.. _class_Viewport_render_target_clear: - -- void **render_target_clear** **(** **)** - -Clear the render target manually. - .. _class_Viewport_set_as_audio_listener: - void **set_as_audio_listener** **(** :ref:`bool` enable **)** @@ -377,18 +427,24 @@ Makes the viewport send sounds to the speakers. Makes the viewport send sounds from 2D emitters to the speakers. -.. _class_Viewport_set_as_render_target: +.. _class_Viewport_set_attach_to_screen_rect: -- void **set_as_render_target** **(** :ref:`bool` enable **)** - -Set the viewport's render target mode. +- void **set_attach_to_screen_rect** **(** :ref:`Rect2` rect **)** .. _class_Viewport_set_canvas_transform: -- void **set_canvas_transform** **(** :ref:`Matrix32` xform **)** +- void **set_canvas_transform** **(** :ref:`Transform2D` xform **)** Set the canvas transform of the viewport, useful for changing the on-screen positions of all child :ref:`CanvasItem`s. This is relative to the global canvas transform of the viewport. +.. _class_Viewport_set_clear_on_new_frame: + +- void **set_clear_on_new_frame** **(** :ref:`bool` enable **)** + +.. _class_Viewport_set_disable_3d: + +- void **set_disable_3d** **(** :ref:`bool` disable **)** + .. _class_Viewport_set_disable_input: - void **set_disable_input** **(** :ref:`bool` disable **)** @@ -397,63 +453,43 @@ Set whether input to the viewport is disabled. .. _class_Viewport_set_global_canvas_transform: -- void **set_global_canvas_transform** **(** :ref:`Matrix32` xform **)** +- void **set_global_canvas_transform** **(** :ref:`Transform2D` xform **)** Set the global canvas transform of the viewport. The canvas transform is relative to this. +.. _class_Viewport_set_hdr: + +- void **set_hdr** **(** :ref:`bool` enable **)** + +.. _class_Viewport_set_msaa: + +- void **set_msaa** **(** :ref:`int` msaa **)** + .. _class_Viewport_set_physics_object_picking: - void **set_physics_object_picking** **(** :ref:`bool` enable **)** Enable/disable picking for all physics objects inside the viewport. -.. _class_Viewport_set_rect: +.. _class_Viewport_set_shadow_atlas_quadrant_subdiv: -- void **set_rect** **(** :ref:`Rect2` rect **)** +- void **set_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant, :ref:`int` subdiv **)** -Set the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. +.. _class_Viewport_set_shadow_atlas_size: -.. _class_Viewport_set_render_target_clear_on_new_frame: +- void **set_shadow_atlas_size** **(** :ref:`int` size **)** -- void **set_render_target_clear_on_new_frame** **(** :ref:`bool` enable **)** +.. _class_Viewport_set_size: -Enable/disable automatic clearing of the render target on each frame. You might find it better to disable this if you are using the viewport for rarely updated textures. To clear manually, check :ref:`render_target_clear` +- void **set_size** **(** :ref:`Vector2` size **)** -.. _class_Viewport_set_render_target_filter: - -- void **set_render_target_filter** **(** :ref:`bool` enable **)** - -Set whether the rendered texture should have filters enabled. Disable if you want the texture's pixels be visible. - -.. _class_Viewport_set_render_target_gen_mipmaps: - -- void **set_render_target_gen_mipmaps** **(** :ref:`bool` enable **)** - -Set whether the rendered texture should have mipmaps generated. Mipmaps allow the texture to have better antialiasing from far away. - -.. _class_Viewport_set_render_target_to_screen_rect: - -- void **set_render_target_to_screen_rect** **(** :ref:`Rect2` rect **)** - -Map a part of the screen to the render target directly. - -.. _class_Viewport_set_render_target_update_mode: - -- void **set_render_target_update_mode** **(** :ref:`int` mode **)** - -Set when the render target should be updated, has to be one of the ``RENDER_TARGET_UPDATE\_\*`` constants. - -.. _class_Viewport_set_render_target_vflip: - -- void **set_render_target_vflip** **(** :ref:`bool` enable **)** - -Set whether the render target should be flipped on the Y axis. +Set the size of the viewport. .. _class_Viewport_set_size_override: - void **set_size_override** **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2(-1, -1), :ref:`Vector2` margin=Vector2(0, 0) **)** -Set the size of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to ``(-1, -1)``, it won't update the size. +Set the size override of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to ``(-1, -1)``, it won't update the size. .. _class_Viewport_set_size_override_stretch: @@ -467,12 +503,24 @@ Set whether the size override affects stretch as well. If this viewport is a child of another viewport, keep the previously drawn background visible. +.. _class_Viewport_set_update_mode: + +- void **set_update_mode** **(** :ref:`int` mode **)** + +Set when the render target would be updated, using the ``UPDATE\_\*`` constants + .. _class_Viewport_set_use_own_world: - void **set_use_own_world** **(** :ref:`bool` enable **)** Make the viewport use a world separate from the parent viewport's world. +.. _class_Viewport_set_vflip: + +- void **set_vflip** **(** :ref:`bool` enable **)** + +Set whether the viewport is flipped on the Y axis. + .. _class_Viewport_set_world: - void **set_world** **(** :ref:`World` world **)** diff --git a/classes/class_viewportcontainer.rst b/classes/class_viewportcontainer.rst new file mode 100644 index 000000000..a1b508c59 --- /dev/null +++ b/classes/class_viewportcontainer.rst @@ -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_ViewportContainer: + +ViewportContainer +================= + +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_stretch_enabled` **(** **)** const | ++--------------------------+------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stretch` **(** :ref:`bool` enable **)** | ++--------------------------+------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`bool` **stretch** + +Member Function Description +--------------------------- + +.. _class_ViewportContainer_is_stretch_enabled: + +- :ref:`bool` **is_stretch_enabled** **(** **)** const + +.. _class_ViewportContainer_set_stretch: + +- void **set_stretch** **(** :ref:`bool` enable **)** + + diff --git a/classes/class_viewportsprite.rst b/classes/class_viewportsprite.rst deleted file mode 100644 index 97b11a81a..000000000 --- a/classes/class_viewportsprite.rst +++ /dev/null @@ -1,95 +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_ViewportSprite: - -ViewportSprite -============== - -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Displays a viewport as a sprite. - -Member Functions ----------------- - -+----------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_modulate` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_viewport_path` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_centered` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_centered` **(** :ref:`bool` centered **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_modulate` **(** :ref:`Color` modulate **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_viewport_path` **(** :ref:`NodePath` path **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------+ - -Description ------------ - -Used to display a :ref:`Viewport` node at some position in the world, without having to mess with :ref:`RenderTargetTexture`s. - -Member Function Description ---------------------------- - -.. _class_ViewportSprite_get_modulate: - -- :ref:`Color` **get_modulate** **(** **)** const - -Get color modulation for the texture. All texture pixels are multiplied by this color. - -.. _class_ViewportSprite_get_offset: - -- :ref:`Vector2` **get_offset** **(** **)** const - -get the offset to the origin of the texture. - -.. _class_ViewportSprite_get_viewport_path: - -- :ref:`NodePath` **get_viewport_path** **(** **)** const - -Return the path to the shown :ref:`Viewport` node. - -.. _class_ViewportSprite_is_centered: - -- :ref:`bool` **is_centered** **(** **)** const - -Return whether the viewport's texture is centered on the origin. - -.. _class_ViewportSprite_set_centered: - -- void **set_centered** **(** :ref:`bool` centered **)** - -Set whether the viewport's texture should be centered on the origin. - -.. _class_ViewportSprite_set_modulate: - -- void **set_modulate** **(** :ref:`Color` modulate **)** - -Set color modulation for the texture. All texture pixels are multiplied by this color. Color may contain rgb values above 1 to achieve a highlight effect. - -.. _class_ViewportSprite_set_offset: - -- void **set_offset** **(** :ref:`Vector2` offset **)** - -Set the offset to the origin of the texture. - -.. _class_ViewportSprite_set_viewport_path: - -- void **set_viewport_path** **(** :ref:`NodePath` path **)** - -Set the path to the shown :ref:`Viewport` node. - - diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst new file mode 100644 index 000000000..1348209c7 --- /dev/null +++ b/classes/class_viewporttexture.rst @@ -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_ViewportTexture: + +ViewportTexture +=============== + +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_viewport_path_in_scene` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_viewport_path_in_scene` **(** :ref:`NodePath` path **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`NodePath` **viewport_path** + +Member Function Description +--------------------------- + +.. _class_ViewportTexture_get_viewport_path_in_scene: + +- :ref:`NodePath` **get_viewport_path_in_scene** **(** **)** const + +.. _class_ViewportTexture_set_viewport_path_in_scene: + +- void **set_viewport_path_in_scene** **(** :ref:`NodePath` path **)** + + diff --git a/classes/class_visibilityenabler.rst b/classes/class_visibilityenabler.rst index f97c0ec4a..a2b7af927 100644 --- a/classes/class_visibilityenabler.rst +++ b/classes/class_visibilityenabler.rst @@ -24,6 +24,12 @@ Member Functions | void | :ref:`set_enabler` **(** :ref:`int` enabler, :ref:`bool` enabled **)** | +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`bool` **freeze_bodies** +- :ref:`bool` **pause_animations** + Numeric Constants ----------------- diff --git a/classes/class_visibilityenabler2d.rst b/classes/class_visibilityenabler2d.rst index 15c9d4107..58f5dec72 100644 --- a/classes/class_visibilityenabler2d.rst +++ b/classes/class_visibilityenabler2d.rst @@ -24,6 +24,16 @@ Member Functions | void | :ref:`set_enabler` **(** :ref:`int` enabler, :ref:`bool` enabled **)** | +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`bool` **fixed_process_parent** +- :ref:`bool` **freeze_bodies** +- :ref:`bool` **pause_animated_sprites** +- :ref:`bool` **pause_animations** +- :ref:`bool` **pause_particles** +- :ref:`bool` **process_parent** + Numeric Constants ----------------- diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index ba82c735c..48c07c9e7 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -20,21 +20,26 @@ Detect when the node is visible on screen. Member Functions ---------------- -+--------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | -+--------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_screen` **(** **)** const | -+--------------------------+-----------------------------------------------------------------------------------------------+ -| void | :ref:`set_aabb` **(** :ref:`AABB` rect **)** | -+--------------------------+-----------------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`get_aabb` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_screen` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------+ +| void | :ref:`set_aabb` **(** :ref:`Rect3` rect **)** | ++----------------------------+-------------------------------------------------------------------------------------------------+ Signals ------- -- **enter_camera** **(** :ref:`Object` camera **)** -- **enter_screen** **(** **)** -- **exit_camera** **(** :ref:`Object` camera **)** -- **exit_screen** **(** **)** +- **camera_entered** **(** :ref:`Object` camera **)** +- **camera_exited** **(** :ref:`Object` camera **)** +- **screen_entered** **(** **)** +- **screen_exited** **(** **)** + +Member Variables +---------------- + +- :ref:`Rect3` **aabb** Description ----------- @@ -46,7 +51,7 @@ Member Function Description .. _class_VisibilityNotifier_get_aabb: -- :ref:`AABB` **get_aabb** **(** **)** const +- :ref:`Rect3` **get_aabb** **(** **)** const Return the visibility bounding box of the VisibilityNotifier. @@ -58,7 +63,7 @@ Return true if any part of the bounding box is on the screen. .. _class_VisibilityNotifier_set_aabb: -- void **set_aabb** **(** :ref:`AABB` rect **)** +- void **set_aabb** **(** :ref:`Rect3` rect **)** Set the visibility bounding box of the VisibilityNotifier. diff --git a/classes/class_visibilitynotifier2d.rst b/classes/class_visibilitynotifier2d.rst index d6d2a6e00..cb8cb37df 100644 --- a/classes/class_visibilitynotifier2d.rst +++ b/classes/class_visibilitynotifier2d.rst @@ -31,10 +31,15 @@ Member Functions Signals ------- -- **enter_screen** **(** **)** -- **enter_viewport** **(** :ref:`Object` viewport **)** -- **exit_screen** **(** **)** -- **exit_viewport** **(** :ref:`Object` viewport **)** +- **screen_entered** **(** **)** +- **screen_exited** **(** **)** +- **viewport_entered** **(** :ref:`Object` viewport **)** +- **viewport_exited** **(** :ref:`Object` viewport **)** + +Member Variables +---------------- + +- :ref:`Rect2` **rect** Description ----------- diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index d53bac32f..2874039b6 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -8,7 +8,7 @@ VisualInstance **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`BakedLightInstance`, :ref:`Light`, :ref:`Room`, :ref:`BakedLightSampler`, :ref:`Portal`, :ref:`GeometryInstance` +**Inherited By:** :ref:`BakedLight`, :ref:`Light`, :ref:`ReflectionProbe`, :ref:`Room`, :ref:`GIProbe`, :ref:`Portal`, :ref:`GeometryInstance` **Category:** Core @@ -20,24 +20,29 @@ Brief Description Member Functions ---------------- -+--------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | -+--------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_mask` **(** **)** const | -+--------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_transformed_aabb` **(** **)** const | -+--------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base` **(** :ref:`RID` base **)** | -+--------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_mask` **(** :ref:`int` mask **)** | -+--------------------------+-----------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`get_aabb` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_layer_mask` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`get_transformed_aabb` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base` **(** :ref:`RID` base **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_layer_mask` **(** :ref:`int` mask **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`int` **layers** Member Function Description --------------------------- .. _class_VisualInstance_get_aabb: -- :ref:`AABB` **get_aabb** **(** **)** const +- :ref:`Rect3` **get_aabb** **(** **)** const .. _class_VisualInstance_get_layer_mask: @@ -45,7 +50,7 @@ Member Function Description .. _class_VisualInstance_get_transformed_aabb: -- :ref:`AABB` **get_transformed_aabb** **(** **)** const +- :ref:`Rect3` **get_transformed_aabb** **(** **)** const .. _class_VisualInstance_set_base: diff --git a/classes/class_visualscript.rst b/classes/class_visualscript.rst index 07bff658a..cc87b0f23 100644 --- a/classes/class_visualscript.rst +++ b/classes/class_visualscript.rst @@ -109,6 +109,11 @@ Signals - **node_ports_changed** **(** :ref:`String` function, :ref:`int` id **)** +Member Variables +---------------- + +- :ref:`Dictionary` **data** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptbasictypeconstant.rst b/classes/class_visualscriptbasictypeconstant.rst index 16490e2be..93c614548 100644 --- a/classes/class_visualscriptbasictypeconstant.rst +++ b/classes/class_visualscriptbasictypeconstant.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_basic_type_constant` **(** :ref:`String` name **)** | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **basic_type** +- :ref:`String` **constant** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptbuiltinfunc.rst b/classes/class_visualscriptbuiltinfunc.rst index b8ed92cf8..ac8a0a317 100644 --- a/classes/class_visualscriptbuiltinfunc.rst +++ b/classes/class_visualscriptbuiltinfunc.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_func` **(** :ref:`int` which **)** | +------------------------+---------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **function** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptclassconstant.rst b/classes/class_visualscriptclassconstant.rst index bd3ad1c47..f58d55285 100644 --- a/classes/class_visualscriptclassconstant.rst +++ b/classes/class_visualscriptclassconstant.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_class_constant` **(** :ref:`String` name **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`String` **base_type** +- :ref:`String` **constant** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptcomment.rst b/classes/class_visualscriptcomment.rst index 652c87709..32f2999ab 100644 --- a/classes/class_visualscriptcomment.rst +++ b/classes/class_visualscriptcomment.rst @@ -32,6 +32,13 @@ Member Functions | void | :ref:`set_title` **(** :ref:`String` title **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`String` **description** +- :ref:`Vector2` **size** +- :ref:`String` **title** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptconstant.rst b/classes/class_visualscriptconstant.rst index bc6e1fbe4..974cb1c0b 100644 --- a/classes/class_visualscriptconstant.rst +++ b/classes/class_visualscriptconstant.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_constant_value` **(** :ref:`Variant` value **)** | +------------------------+----------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **constant/type** +- :ref:`Nil` **constant/value** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptconstructor.rst b/classes/class_visualscriptconstructor.rst index 6207d86ad..c3cf7b02a 100644 --- a/classes/class_visualscriptconstructor.rst +++ b/classes/class_visualscriptconstructor.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_constructor_type` **(** :ref:`int` type **)** | +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Dictionary` **constructor** +- :ref:`int` **type** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptdeconstruct.rst b/classes/class_visualscriptdeconstruct.rst index b8b290edf..30a84f0d9 100644 --- a/classes/class_visualscriptdeconstruct.rst +++ b/classes/class_visualscriptdeconstruct.rst @@ -28,6 +28,13 @@ Member Functions | void | :ref:`set_deconstruct_type` **(** :ref:`int` type **)** | +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Array` **elem_cache** +- :ref:`int` **input_type** +- :ref:`int` **type** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptemitsignal.rst b/classes/class_visualscriptemitsignal.rst index 3d3fd7494..f9037365b 100644 --- a/classes/class_visualscriptemitsignal.rst +++ b/classes/class_visualscriptemitsignal.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_signal` **(** :ref:`String` name **)** | +------------------------------+-----------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`String` **signal/signal** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptenginesingleton.rst b/classes/class_visualscriptenginesingleton.rst index 3492e4195..012bcac03 100644 --- a/classes/class_visualscriptenginesingleton.rst +++ b/classes/class_visualscriptenginesingleton.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_singleton` **(** :ref:`String` name **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`String` **constant** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptfunctioncall.rst b/classes/class_visualscriptfunctioncall.rst index 0f44a21ca..d0d9c8415 100644 --- a/classes/class_visualscriptfunctioncall.rst +++ b/classes/class_visualscriptfunctioncall.rst @@ -60,6 +60,21 @@ Member Functions | void | :ref:`set_validate` **(** :ref:`bool` enable **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Dictionary` **function/argument_cache** +- :ref:`String` **function/base_script** +- :ref:`String` **function/base_type** +- :ref:`int` **function/basic_type** +- :ref:`int` **function/call_mode** +- :ref:`String` **function/function** +- :ref:`NodePath` **function/node_path** +- :ref:`String` **function/singleton** +- :ref:`int` **function/use_default_args** +- :ref:`bool` **function/validate** +- :ref:`int` **rpc/call_mode** + Numeric Constants ----------------- diff --git a/classes/class_visualscriptglobalconstant.rst b/classes/class_visualscriptglobalconstant.rst index 76cf8adbf..aa0a4bc1c 100644 --- a/classes/class_visualscriptglobalconstant.rst +++ b/classes/class_visualscriptglobalconstant.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_global_constant` **(** :ref:`int` index **)** | +------------------------+----------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **constant** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptinputaction.rst b/classes/class_visualscriptinputaction.rst index 40f977b20..15180dee2 100644 --- a/classes/class_visualscriptinputaction.rst +++ b/classes/class_visualscriptinputaction.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_action_name` **(** :ref:`String` name **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`String` **action** +- :ref:`int` **mode** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptlocalvar.rst b/classes/class_visualscriptlocalvar.rst index 6aaec4c5a..dfc997731 100644 --- a/classes/class_visualscriptlocalvar.rst +++ b/classes/class_visualscriptlocalvar.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_var_type` **(** :ref:`int` type **)** | +------------------------------+-------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`String` **variable/name** +- :ref:`int` **variable/type** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptlocalvarset.rst b/classes/class_visualscriptlocalvarset.rst index 7eec10f30..d6865b71f 100644 --- a/classes/class_visualscriptlocalvarset.rst +++ b/classes/class_visualscriptlocalvarset.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_var_type` **(** :ref:`int` type **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`String` **variable/name** +- :ref:`int` **variable/type** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptmathconstant.rst b/classes/class_visualscriptmathconstant.rst index 8dad8519a..4bc4bd271 100644 --- a/classes/class_visualscriptmathconstant.rst +++ b/classes/class_visualscriptmathconstant.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_math_constant` **(** :ref:`int` which **)** | +------------------------+----------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **constant** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index 3b4a875c1..668d4a8f5 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -8,7 +8,7 @@ VisualScriptNode **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptSelf`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptSequence`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptPreload`, :ref:`VisualScriptYield`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptFunction`, :ref:`VisualScriptInputFilter` +**Inherited By:** :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptSelf`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptSequence`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptPreload`, :ref:`VisualScriptYield`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptInputFilter`, :ref:`VisualScriptFunction` **Category:** Core @@ -33,6 +33,11 @@ Signals - **ports_changed** **(** **)** +Member Variables +---------------- + +- :ref:`Array` **_default_input_values** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptoperator.rst b/classes/class_visualscriptoperator.rst index 32797aeb9..907d428fc 100644 --- a/classes/class_visualscriptoperator.rst +++ b/classes/class_visualscriptoperator.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_typed` **(** :ref:`int` type **)** | +------------------------+-----------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **operator_value/type** +- :ref:`int` **typed_value/typed** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptpreload.rst b/classes/class_visualscriptpreload.rst index 2856131fb..b0db3cfc4 100644 --- a/classes/class_visualscriptpreload.rst +++ b/classes/class_visualscriptpreload.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_preload` **(** :ref:`Object` resource **)** | +------------------------------+--------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Resource` **resource** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptpropertyget.rst b/classes/class_visualscriptpropertyget.rst index 821b8bbb7..1cd1d4675 100644 --- a/classes/class_visualscriptpropertyget.rst +++ b/classes/class_visualscriptpropertyget.rst @@ -48,6 +48,18 @@ Member Functions | void | :ref:`set_property` **(** :ref:`String` property **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`String` **property/base_script** +- :ref:`String` **property/base_type** +- :ref:`int` **property/basic_type** +- :ref:`int` **property/event_type** +- :ref:`NodePath` **property/node_path** +- :ref:`String` **property/property** +- :ref:`int` **property/set_mode** +- :ref:`int` **property/type_cache** + Numeric Constants ----------------- diff --git a/classes/class_visualscriptpropertyset.rst b/classes/class_visualscriptpropertyset.rst index 5fda22f30..485beb3e1 100644 --- a/classes/class_visualscriptpropertyset.rst +++ b/classes/class_visualscriptpropertyset.rst @@ -48,6 +48,18 @@ Member Functions | void | :ref:`set_property` **(** :ref:`String` property **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`String` **property/base_script** +- :ref:`String` **property/base_type** +- :ref:`int` **property/basic_type** +- :ref:`int` **property/event_type** +- :ref:`NodePath` **property/node_path** +- :ref:`String` **property/property** +- :ref:`int` **property/set_mode** +- :ref:`int` **property/type_cache** + Numeric Constants ----------------- diff --git a/classes/class_visualscriptresourcepath.rst b/classes/class_visualscriptresourcepath.rst index c42e01766..497bcce5e 100644 --- a/classes/class_visualscriptresourcepath.rst +++ b/classes/class_visualscriptresourcepath.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_resource_path` **(** :ref:`String` path **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`String` **path** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptreturn.rst b/classes/class_visualscriptreturn.rst index f0b16825f..2886a6d58 100644 --- a/classes/class_visualscriptreturn.rst +++ b/classes/class_visualscriptreturn.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_return_type` **(** :ref:`int` type **)** | +--------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`bool` **return_value/enabled** +- :ref:`int` **return_value/type** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptscenenode.rst b/classes/class_visualscriptscenenode.rst index bd7c12e57..16f2e9b0b 100644 --- a/classes/class_visualscriptscenenode.rst +++ b/classes/class_visualscriptscenenode.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_node_path` **(** :ref:`NodePath` path **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`NodePath` **node_path** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptsequence.rst b/classes/class_visualscriptsequence.rst index 0c3d1407d..f3899aa79 100644 --- a/classes/class_visualscriptsequence.rst +++ b/classes/class_visualscriptsequence.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_steps` **(** :ref:`int` steps **)** | +------------------------+--------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **steps** + Member Function Description --------------------------- diff --git a/classes/class_visualscripttypecast.rst b/classes/class_visualscripttypecast.rst index 5ef3c3295..ddc7c149f 100644 --- a/classes/class_visualscripttypecast.rst +++ b/classes/class_visualscripttypecast.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_base_type` **(** :ref:`String` type **)** | +------------------------------+-------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`String` **function/base_type** +- :ref:`String` **property/base_script** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptvariableget.rst b/classes/class_visualscriptvariableget.rst index 0508d40cc..6895d3721 100644 --- a/classes/class_visualscriptvariableget.rst +++ b/classes/class_visualscriptvariableget.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_variable` **(** :ref:`String` name **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`String` **variable/name** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptvariableset.rst b/classes/class_visualscriptvariableset.rst index a6f02b8e3..711bc24c5 100644 --- a/classes/class_visualscriptvariableset.rst +++ b/classes/class_visualscriptvariableset.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_variable` **(** :ref:`String` name **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`String` **variable/name** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptyield.rst b/classes/class_visualscriptyield.rst index fee53ce5d..4c9438a11 100644 --- a/classes/class_visualscriptyield.rst +++ b/classes/class_visualscriptyield.rst @@ -28,6 +28,12 @@ Member Functions | void | :ref:`set_yield_mode` **(** :ref:`int` mode **)** | +----------------------------+---------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **mode** +- :ref:`float` **wait_time** + Numeric Constants ----------------- diff --git a/classes/class_visualscriptyieldsignal.rst b/classes/class_visualscriptyieldsignal.rst index 66a9bb6bb..2799a2c65 100644 --- a/classes/class_visualscriptyieldsignal.rst +++ b/classes/class_visualscriptyieldsignal.rst @@ -36,6 +36,14 @@ Member Functions | void | :ref:`set_signal` **(** :ref:`String` signal **)** | +----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`String` **signal/base_type** +- :ref:`int` **signal/call_mode** +- :ref:`NodePath` **signal/node_path** +- :ref:`String` **signal/signal** + Numeric Constants ----------------- diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index d5af591ac..f52e39ab6 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -18,447 +18,21 @@ Server for anything visible. Member Functions ---------------- -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`black_bars_set_images` **(** :ref:`RID` left, :ref:`RID` top, :ref:`RID` right, :ref:`RID` bottom **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`black_bars_set_margins` **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`camera_create` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_orthogonal` **(** :ref:`RID` arg0, :ref:`float` arg1, :ref:`float` arg2, :ref:`float` arg3 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_perspective` **(** :ref:`RID` arg0, :ref:`float` arg1, :ref:`float` arg2, :ref:`float` arg3 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_transform` **(** :ref:`RID` arg0, :ref:`Transform` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_create` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_circle` **(** :ref:`RID` arg0, :ref:`Vector2` arg1, :ref:`float` arg2, :ref:`Color` arg3 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_line` **(** :ref:`RID` arg0, :ref:`Vector2` arg1, :ref:`Vector2` arg2, :ref:`Color` arg3, :ref:`float` arg4=1, :ref:`bool` arg5=false **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_rect` **(** :ref:`RID` arg0, :ref:`Rect2` arg1, :ref:`Color` arg2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_style_box` **(** :ref:`RID` arg0, :ref:`Rect2` arg1, :ref:`Rect2` arg2, :ref:`RID` arg3, :ref:`RealArray` arg4, :ref:`Color` arg5=Color(1,1,1,1) **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_texture_rect` **(** :ref:`RID` arg0, :ref:`Rect2` arg1, :ref:`RID` arg2, :ref:`bool` arg3, :ref:`Color` arg4=Color(1,1,1,1), :ref:`bool` arg5=false **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_texture_rect_region` **(** :ref:`RID` arg0, :ref:`Rect2` arg1, :ref:`RID` arg2, :ref:`Rect2` arg3, :ref:`Color` arg4=Color(1,1,1,1), :ref:`bool` arg5=false **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_clear` **(** :ref:`RID` arg0 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_item_create` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`canvas_item_get_opacity` **(** :ref:`RID` arg0, :ref:`float` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_item_get_parent` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`canvas_item_get_self_opacity` **(** :ref:`RID` arg0, :ref:`float` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_raise` **(** :ref:`RID` arg0 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_clip` **(** :ref:`RID` arg0, :ref:`bool` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_custom_rect` **(** :ref:`RID` arg0, :ref:`bool` arg1, :ref:`Rect2` arg2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_opacity` **(** :ref:`RID` arg0, :ref:`float` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_parent` **(** :ref:`RID` arg0, :ref:`RID` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_self_opacity` **(** :ref:`RID` arg0, :ref:`float` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_transform` **(** :ref:`RID` arg0, :ref:`Matrix32` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_z` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_pos` **(** :ref:`Vector2` arg0, :ref:`int` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_rotation` **(** :ref:`float` arg0, :ref:`int` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_texture` **(** :ref:`RID` arg0, :ref:`Vector2` arg1, :ref:`int` arg2, :ref:`Rect2` arg3 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_visible` **(** :ref:`bool` arg0, :ref:`int` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` arg0 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_render_info` **(** :ref:`int` arg0 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_test_cube` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_attach_object_instance_ID` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_attach_skeleton` **(** :ref:`RID` arg0, :ref:`RID` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`instance_create` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`instance_geometry_get_material_param` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`instance_geometry_override_material_param` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`instance_get_base` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`instance_get_base_aabb` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`instance_get_object_instance_ID` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`instance_get_room` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`instance_get_skeleton` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`instance_get_transform` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`instance_is_exterior` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_exterior` **(** :ref:`RID` arg0, :ref:`bool` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_room` **(** :ref:`RID` arg0, :ref:`RID` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_transform` **(** :ref:`RID` arg0, :ref:`Transform` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`instances_cull_aabb` **(** :ref:`AABB` arg0, :ref:`RID` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`instances_cull_convex` **(** :ref:`Array` arg0, :ref:`RID` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`instances_cull_ray` **(** :ref:`Vector3` arg0, :ref:`Vector3` arg1, :ref:`RID` arg2 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`light_create` **(** :ref:`int` arg0 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`light_get_color` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`light_get_projector` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`light_get_type` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`light_get_var` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`light_has_shadow` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`light_is_volumetric` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_color` **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`Color` arg2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_projector` **(** :ref:`RID` arg0, :ref:`RID` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_shadow` **(** :ref:`RID` arg0, :ref:`bool` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_var` **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`float` arg2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_volumetric` **(** :ref:`RID` arg0, :ref:`bool` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`make_sphere_mesh` **(** :ref:`int` arg0, :ref:`int` arg1, :ref:`float` arg2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`material_create` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`material_get_blend_mode` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`material_get_flag` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`material_get_line_width` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_get_param` **(** :ref:`RID` arg0, :ref:`String` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`material_get_shader` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_blend_mode` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_flag` **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`bool` arg2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_line_width` **(** :ref:`RID` arg0, :ref:`float` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_param` **(** :ref:`RID` arg0, :ref:`String` arg1, :ref:`Variant` arg2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_shader` **(** :ref:`RID` shader, :ref:`RID` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_add_surface` **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`Array` arg2, :ref:`Array` arg3, :ref:`bool` arg4=-1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_add_surface_from_planes` **(** :ref:`RID` arg0, :ref:`Array` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`mesh_create` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_get_surface_count` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_remove_surface` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_array_index_len` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_array_len` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_format` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`mesh_surface_get_material` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_primitive_type` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_surface_set_material` **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`RID` arg2, :ref:`bool` arg3=false **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`multimesh_create` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`multimesh_get_aabb` **(** :ref:`RID` arg0, :ref:`AABB` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`multimesh_get_mesh` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`multimesh_instance_get_color` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`multimesh_instance_get_transform` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_color` **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`Color` arg2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_transform` **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`Transform` arg2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_set_aabb` **(** :ref:`RID` arg0, :ref:`AABB` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_set_mesh` **(** :ref:`RID` arg0, :ref:`RID` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`particles_create` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`particles_get_amount` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`particles_get_attractor_pos` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`particles_get_attractor_strength` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`particles_get_attractors` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`particles_get_color_phase_color` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`particles_get_color_phase_pos` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`particles_get_color_phases` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`particles_get_randomness` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`particles_get_variable` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`particles_get_visibility_aabb` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`particles_has_height_from_velocity` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`particles_is_emitting` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_amount` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_attractor_pos` **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`Vector3` arg2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_attractor_strength` **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`float` arg2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_attractors` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_color_phase_color` **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`Color` arg2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_color_phase_pos` **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`float` arg2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_color_phases` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_emitting` **(** :ref:`RID` arg0, :ref:`bool` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_height_from_velocity` **(** :ref:`RID` arg0, :ref:`bool` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_material` **(** :ref:`RID` arg0, :ref:`RID` arg1, :ref:`bool` arg2=false **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_randomness` **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`float` arg2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_variable` **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`float` arg2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_visibility_aabb` **(** :ref:`RID` arg0, :ref:`AABB` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`portal_create` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`portal_get_disable_distance` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`portal_get_disabled_color` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`portal_get_shape` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`portal_is_enabled` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`portal_set_disable_distance` **(** :ref:`RID` arg0, :ref:`float` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`portal_set_disabled_color` **(** :ref:`RID` arg0, :ref:`Color` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`portal_set_enabled` **(** :ref:`RID` arg0, :ref:`bool` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`portal_set_shape` **(** :ref:`RID` arg0, :ref:`Vector2Array` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`room_create` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`room_get_bounds` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`room_set_bounds` **(** :ref:`RID` arg0, :ref:`Dictionary` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`scenario_create` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_debug` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_clear_color` **(** :ref:`Color` arg0 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shader_create` **(** :ref:`int` mode=0 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shader_set_mode` **(** :ref:`RID` shader, :ref:`int` mode **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`skeleton_bone_get_transform` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skeleton_bone_set_transform` **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`Transform` arg2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`skeleton_create` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`skeleton_get_bone_count` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skeleton_resize` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sync` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_create` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_create_from_image` **(** :ref:`Image` arg0, :ref:`int` arg1=7 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_flags` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_height` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_width` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_flags` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_shrink_all_x2_on_set_data` **(** :ref:`bool` shrink **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_camera` **(** :ref:`RID` arg0, :ref:`RID` arg1=RID() **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_canvas` **(** :ref:`RID` arg0, :ref:`RID` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`viewport_create` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`viewport_get_attached_camera` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`viewport_get_rect` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`viewport_get_scenario` **(** :ref:`RID` arg0 **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_remove_canvas` **(** :ref:`RID` arg0, :ref:`RID` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_canvas_transform` **(** :ref:`RID` arg0, :ref:`RID` arg1, :ref:`Matrix32` arg2 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_global_canvas_transform` **(** :ref:`RID` arg0, :ref:`Matrix32` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_rect` **(** :ref:`RID` arg0, :ref:`Rect2` arg1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Numeric Constants ------------------ - -- **NO_INDEX_ARRAY** = **-1** -- **CUSTOM_ARRAY_SIZE** = **8** -- **ARRAY_WEIGHTS_SIZE** = **4** -- **MAX_PARTICLE_COLOR_PHASES** = **4** -- **MAX_PARTICLE_ATTRACTORS** = **4** -- **MAX_CURSORS** = **8** -- **TEXTURE_FLAG_MIPMAPS** = **1** -- **TEXTURE_FLAG_REPEAT** = **2** -- **TEXTURE_FLAG_FILTER** = **4** -- **TEXTURE_FLAG_CUBEMAP** = **2048** -- **TEXTURE_FLAGS_DEFAULT** = **7** -- **CUBEMAP_LEFT** = **0** -- **CUBEMAP_RIGHT** = **1** -- **CUBEMAP_BOTTOM** = **2** -- **CUBEMAP_TOP** = **3** -- **CUBEMAP_FRONT** = **4** -- **CUBEMAP_BACK** = **5** -- **SHADER_MATERIAL** = **0** -- **SHADER_POST_PROCESS** = **2** -- **MATERIAL_FLAG_VISIBLE** = **0** -- **MATERIAL_FLAG_DOUBLE_SIDED** = **1** -- **MATERIAL_FLAG_INVERT_FACES** = **2** -- **MATERIAL_FLAG_UNSHADED** = **3** -- **MATERIAL_FLAG_ONTOP** = **4** -- **MATERIAL_FLAG_MAX** = **7** -- **MATERIAL_BLEND_MODE_MIX** = **0** -- **MATERIAL_BLEND_MODE_ADD** = **1** -- **MATERIAL_BLEND_MODE_SUB** = **2** -- **MATERIAL_BLEND_MODE_MUL** = **3** -- **FIXED_MATERIAL_PARAM_DIFFUSE** = **0** -- **FIXED_MATERIAL_PARAM_DETAIL** = **1** -- **FIXED_MATERIAL_PARAM_SPECULAR** = **2** -- **FIXED_MATERIAL_PARAM_EMISSION** = **3** -- **FIXED_MATERIAL_PARAM_SPECULAR_EXP** = **4** -- **FIXED_MATERIAL_PARAM_GLOW** = **5** -- **FIXED_MATERIAL_PARAM_NORMAL** = **6** -- **FIXED_MATERIAL_PARAM_SHADE_PARAM** = **7** -- **FIXED_MATERIAL_PARAM_MAX** = **8** -- **FIXED_MATERIAL_TEXCOORD_SPHERE** = **3** -- **FIXED_MATERIAL_TEXCOORD_UV** = **0** -- **FIXED_MATERIAL_TEXCOORD_UV_TRANSFORM** = **1** -- **FIXED_MATERIAL_TEXCOORD_UV2** = **2** -- **ARRAY_VERTEX** = **0** -- **ARRAY_NORMAL** = **1** -- **ARRAY_TANGENT** = **2** -- **ARRAY_COLOR** = **3** -- **ARRAY_TEX_UV** = **4** -- **ARRAY_BONES** = **6** -- **ARRAY_WEIGHTS** = **7** -- **ARRAY_INDEX** = **8** -- **ARRAY_MAX** = **9** -- **ARRAY_FORMAT_VERTEX** = **1** -- **ARRAY_FORMAT_NORMAL** = **2** -- **ARRAY_FORMAT_TANGENT** = **4** -- **ARRAY_FORMAT_COLOR** = **8** -- **ARRAY_FORMAT_TEX_UV** = **16** -- **ARRAY_FORMAT_BONES** = **64** -- **ARRAY_FORMAT_WEIGHTS** = **128** -- **ARRAY_FORMAT_INDEX** = **256** -- **PRIMITIVE_POINTS** = **0** -- **PRIMITIVE_LINES** = **1** -- **PRIMITIVE_LINE_STRIP** = **2** -- **PRIMITIVE_LINE_LOOP** = **3** -- **PRIMITIVE_TRIANGLES** = **4** -- **PRIMITIVE_TRIANGLE_STRIP** = **5** -- **PRIMITIVE_TRIANGLE_FAN** = **6** -- **PRIMITIVE_MAX** = **7** -- **PARTICLE_LIFETIME** = **0** -- **PARTICLE_SPREAD** = **1** -- **PARTICLE_GRAVITY** = **2** -- **PARTICLE_LINEAR_VELOCITY** = **3** -- **PARTICLE_ANGULAR_VELOCITY** = **4** -- **PARTICLE_LINEAR_ACCELERATION** = **5** -- **PARTICLE_RADIAL_ACCELERATION** = **6** -- **PARTICLE_TANGENTIAL_ACCELERATION** = **7** -- **PARTICLE_INITIAL_SIZE** = **9** -- **PARTICLE_FINAL_SIZE** = **10** -- **PARTICLE_INITIAL_ANGLE** = **11** -- **PARTICLE_HEIGHT** = **12** -- **PARTICLE_HEIGHT_SPEED_SCALE** = **13** -- **PARTICLE_VAR_MAX** = **14** -- **LIGHT_DIRECTIONAL** = **0** -- **LIGHT_OMNI** = **1** -- **LIGHT_SPOT** = **2** -- **LIGHT_COLOR_DIFFUSE** = **0** -- **LIGHT_COLOR_SPECULAR** = **1** -- **LIGHT_PARAM_SPOT_ATTENUATION** = **0** -- **LIGHT_PARAM_SPOT_ANGLE** = **1** -- **LIGHT_PARAM_RADIUS** = **2** -- **LIGHT_PARAM_ENERGY** = **3** -- **LIGHT_PARAM_ATTENUATION** = **4** -- **LIGHT_PARAM_MAX** = **10** -- **SCENARIO_DEBUG_DISABLED** = **0** -- **SCENARIO_DEBUG_WIREFRAME** = **1** -- **SCENARIO_DEBUG_OVERDRAW** = **2** -- **INSTANCE_MESH** = **1** -- **INSTANCE_MULTIMESH** = **2** -- **INSTANCE_PARTICLES** = **4** -- **INSTANCE_LIGHT** = **5** -- **INSTANCE_ROOM** = **6** -- **INSTANCE_PORTAL** = **7** -- **INSTANCE_GEOMETRY_MASK** = **30** -- **INFO_OBJECTS_IN_FRAME** = **0** -- **INFO_VERTICES_IN_FRAME** = **1** -- **INFO_MATERIAL_CHANGES_IN_FRAME** = **2** -- **INFO_SHADER_CHANGES_IN_FRAME** = **3** -- **INFO_SURFACE_CHANGES_IN_FRAME** = **4** -- **INFO_DRAW_CALLS_IN_FRAME** = **5** -- **INFO_USAGE_VIDEO_MEM_TOTAL** = **6** -- **INFO_VIDEO_MEM_USED** = **7** -- **INFO_TEXTURE_MEM_USED** = **8** -- **INFO_VERTEX_MEM_USED** = **9** ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_create` **(** **)** | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_create_from_image` **(** :ref:`Image` arg0, :ref:`int` arg1=7 **)** | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_flags` **(** :ref:`RID` arg0 **)** const | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_height` **(** :ref:`RID` arg0 **)** const | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_width` **(** :ref:`RID` arg0 **)** const | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_flags` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_shrink_all_x2_on_set_data` **(** :ref:`bool` shrink **)** | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -470,586 +44,6 @@ The visual server is completely opaque, the internals are entirely implementatio Member Function Description --------------------------- -.. _class_VisualServer_black_bars_set_images: - -- void **black_bars_set_images** **(** :ref:`RID` left, :ref:`RID` top, :ref:`RID` right, :ref:`RID` bottom **)** - -.. _class_VisualServer_black_bars_set_margins: - -- void **black_bars_set_margins** **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** - -.. _class_VisualServer_camera_create: - -- :ref:`RID` **camera_create** **(** **)** - -.. _class_VisualServer_camera_set_orthogonal: - -- void **camera_set_orthogonal** **(** :ref:`RID` arg0, :ref:`float` arg1, :ref:`float` arg2, :ref:`float` arg3 **)** - -.. _class_VisualServer_camera_set_perspective: - -- void **camera_set_perspective** **(** :ref:`RID` arg0, :ref:`float` arg1, :ref:`float` arg2, :ref:`float` arg3 **)** - -.. _class_VisualServer_camera_set_transform: - -- void **camera_set_transform** **(** :ref:`RID` arg0, :ref:`Transform` arg1 **)** - -.. _class_VisualServer_canvas_create: - -- :ref:`RID` **canvas_create** **(** **)** - -.. _class_VisualServer_canvas_item_add_circle: - -- void **canvas_item_add_circle** **(** :ref:`RID` arg0, :ref:`Vector2` arg1, :ref:`float` arg2, :ref:`Color` arg3 **)** - -.. _class_VisualServer_canvas_item_add_line: - -- void **canvas_item_add_line** **(** :ref:`RID` arg0, :ref:`Vector2` arg1, :ref:`Vector2` arg2, :ref:`Color` arg3, :ref:`float` arg4=1, :ref:`bool` arg5=false **)** - -.. _class_VisualServer_canvas_item_add_rect: - -- void **canvas_item_add_rect** **(** :ref:`RID` arg0, :ref:`Rect2` arg1, :ref:`Color` arg2 **)** - -.. _class_VisualServer_canvas_item_add_style_box: - -- void **canvas_item_add_style_box** **(** :ref:`RID` arg0, :ref:`Rect2` arg1, :ref:`Rect2` arg2, :ref:`RID` arg3, :ref:`RealArray` arg4, :ref:`Color` arg5=Color(1,1,1,1) **)** - -.. _class_VisualServer_canvas_item_add_texture_rect: - -- void **canvas_item_add_texture_rect** **(** :ref:`RID` arg0, :ref:`Rect2` arg1, :ref:`RID` arg2, :ref:`bool` arg3, :ref:`Color` arg4=Color(1,1,1,1), :ref:`bool` arg5=false **)** - -.. _class_VisualServer_canvas_item_add_texture_rect_region: - -- void **canvas_item_add_texture_rect_region** **(** :ref:`RID` arg0, :ref:`Rect2` arg1, :ref:`RID` arg2, :ref:`Rect2` arg3, :ref:`Color` arg4=Color(1,1,1,1), :ref:`bool` arg5=false **)** - -.. _class_VisualServer_canvas_item_clear: - -- void **canvas_item_clear** **(** :ref:`RID` arg0 **)** - -.. _class_VisualServer_canvas_item_create: - -- :ref:`RID` **canvas_item_create** **(** **)** - -.. _class_VisualServer_canvas_item_get_opacity: - -- :ref:`float` **canvas_item_get_opacity** **(** :ref:`RID` arg0, :ref:`float` arg1 **)** const - -.. _class_VisualServer_canvas_item_get_parent: - -- :ref:`RID` **canvas_item_get_parent** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_canvas_item_get_self_opacity: - -- :ref:`float` **canvas_item_get_self_opacity** **(** :ref:`RID` arg0, :ref:`float` arg1 **)** const - -.. _class_VisualServer_canvas_item_raise: - -- void **canvas_item_raise** **(** :ref:`RID` arg0 **)** - -.. _class_VisualServer_canvas_item_set_clip: - -- void **canvas_item_set_clip** **(** :ref:`RID` arg0, :ref:`bool` arg1 **)** - -.. _class_VisualServer_canvas_item_set_custom_rect: - -- void **canvas_item_set_custom_rect** **(** :ref:`RID` arg0, :ref:`bool` arg1, :ref:`Rect2` arg2 **)** - -.. _class_VisualServer_canvas_item_set_opacity: - -- void **canvas_item_set_opacity** **(** :ref:`RID` arg0, :ref:`float` arg1 **)** - -.. _class_VisualServer_canvas_item_set_parent: - -- void **canvas_item_set_parent** **(** :ref:`RID` arg0, :ref:`RID` arg1 **)** - -.. _class_VisualServer_canvas_item_set_self_opacity: - -- void **canvas_item_set_self_opacity** **(** :ref:`RID` arg0, :ref:`float` arg1 **)** - -.. _class_VisualServer_canvas_item_set_transform: - -- void **canvas_item_set_transform** **(** :ref:`RID` arg0, :ref:`Matrix32` arg1 **)** - -.. _class_VisualServer_canvas_item_set_z: - -- void **canvas_item_set_z** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** - -.. _class_VisualServer_cursor_set_pos: - -- void **cursor_set_pos** **(** :ref:`Vector2` arg0, :ref:`int` arg1 **)** - -.. _class_VisualServer_cursor_set_rotation: - -- void **cursor_set_rotation** **(** :ref:`float` arg0, :ref:`int` arg1 **)** - -.. _class_VisualServer_cursor_set_texture: - -- void **cursor_set_texture** **(** :ref:`RID` arg0, :ref:`Vector2` arg1, :ref:`int` arg2, :ref:`Rect2` arg3 **)** - -.. _class_VisualServer_cursor_set_visible: - -- void **cursor_set_visible** **(** :ref:`bool` arg0, :ref:`int` arg1 **)** - -.. _class_VisualServer_draw: - -- void **draw** **(** **)** - -.. _class_VisualServer_free_rid: - -- void **free_rid** **(** :ref:`RID` arg0 **)** - -.. _class_VisualServer_get_render_info: - -- :ref:`int` **get_render_info** **(** :ref:`int` arg0 **)** - -.. _class_VisualServer_get_test_cube: - -- :ref:`RID` **get_test_cube** **(** **)** - -.. _class_VisualServer_instance_attach_object_instance_ID: - -- void **instance_attach_object_instance_ID** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** - -.. _class_VisualServer_instance_attach_skeleton: - -- void **instance_attach_skeleton** **(** :ref:`RID` arg0, :ref:`RID` arg1 **)** - -.. _class_VisualServer_instance_create: - -- :ref:`RID` **instance_create** **(** **)** - -.. _class_VisualServer_instance_geometry_get_material_param: - -- :ref:`RID` **instance_geometry_get_material_param** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_instance_geometry_override_material_param: - -- :ref:`RID` **instance_geometry_override_material_param** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_instance_get_base: - -- :ref:`RID` **instance_get_base** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_instance_get_base_aabb: - -- :ref:`RID` **instance_get_base_aabb** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_instance_get_object_instance_ID: - -- :ref:`int` **instance_get_object_instance_ID** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_instance_get_room: - -- :ref:`RID` **instance_get_room** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_instance_get_skeleton: - -- :ref:`RID` **instance_get_skeleton** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_instance_get_transform: - -- :ref:`Transform` **instance_get_transform** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_instance_is_exterior: - -- :ref:`bool` **instance_is_exterior** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_instance_set_exterior: - -- void **instance_set_exterior** **(** :ref:`RID` arg0, :ref:`bool` arg1 **)** - -.. _class_VisualServer_instance_set_room: - -- void **instance_set_room** **(** :ref:`RID` arg0, :ref:`RID` arg1 **)** - -.. _class_VisualServer_instance_set_transform: - -- void **instance_set_transform** **(** :ref:`RID` arg0, :ref:`Transform` arg1 **)** - -.. _class_VisualServer_instances_cull_aabb: - -- :ref:`Array` **instances_cull_aabb** **(** :ref:`AABB` arg0, :ref:`RID` arg1 **)** const - -.. _class_VisualServer_instances_cull_convex: - -- :ref:`Array` **instances_cull_convex** **(** :ref:`Array` arg0, :ref:`RID` arg1 **)** const - -.. _class_VisualServer_instances_cull_ray: - -- :ref:`Array` **instances_cull_ray** **(** :ref:`Vector3` arg0, :ref:`Vector3` arg1, :ref:`RID` arg2 **)** const - -.. _class_VisualServer_light_create: - -- :ref:`RID` **light_create** **(** :ref:`int` arg0 **)** - -.. _class_VisualServer_light_get_color: - -- :ref:`Color` **light_get_color** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const - -.. _class_VisualServer_light_get_projector: - -- :ref:`RID` **light_get_projector** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_light_get_type: - -- :ref:`int` **light_get_type** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_light_get_var: - -- :ref:`float` **light_get_var** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const - -.. _class_VisualServer_light_has_shadow: - -- :ref:`bool` **light_has_shadow** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_light_is_volumetric: - -- :ref:`bool` **light_is_volumetric** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_light_set_color: - -- void **light_set_color** **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`Color` arg2 **)** - -.. _class_VisualServer_light_set_projector: - -- void **light_set_projector** **(** :ref:`RID` arg0, :ref:`RID` arg1 **)** - -.. _class_VisualServer_light_set_shadow: - -- void **light_set_shadow** **(** :ref:`RID` arg0, :ref:`bool` arg1 **)** - -.. _class_VisualServer_light_set_var: - -- void **light_set_var** **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`float` arg2 **)** - -.. _class_VisualServer_light_set_volumetric: - -- void **light_set_volumetric** **(** :ref:`RID` arg0, :ref:`bool` arg1 **)** - -.. _class_VisualServer_make_sphere_mesh: - -- :ref:`RID` **make_sphere_mesh** **(** :ref:`int` arg0, :ref:`int` arg1, :ref:`float` arg2 **)** - -.. _class_VisualServer_material_create: - -- :ref:`RID` **material_create** **(** **)** - -.. _class_VisualServer_material_get_blend_mode: - -- :ref:`int` **material_get_blend_mode** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_material_get_flag: - -- :ref:`bool` **material_get_flag** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const - -.. _class_VisualServer_material_get_line_width: - -- :ref:`float` **material_get_line_width** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_material_get_param: - -- void **material_get_param** **(** :ref:`RID` arg0, :ref:`String` arg1 **)** const - -.. _class_VisualServer_material_get_shader: - -- :ref:`RID` **material_get_shader** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_material_set_blend_mode: - -- void **material_set_blend_mode** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** - -.. _class_VisualServer_material_set_flag: - -- void **material_set_flag** **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`bool` arg2 **)** - -.. _class_VisualServer_material_set_line_width: - -- void **material_set_line_width** **(** :ref:`RID` arg0, :ref:`float` arg1 **)** - -.. _class_VisualServer_material_set_param: - -- void **material_set_param** **(** :ref:`RID` arg0, :ref:`String` arg1, :ref:`Variant` arg2 **)** - -.. _class_VisualServer_material_set_shader: - -- void **material_set_shader** **(** :ref:`RID` shader, :ref:`RID` arg1 **)** - -.. _class_VisualServer_mesh_add_surface: - -- void **mesh_add_surface** **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`Array` arg2, :ref:`Array` arg3, :ref:`bool` arg4=-1 **)** - -.. _class_VisualServer_mesh_add_surface_from_planes: - -- void **mesh_add_surface_from_planes** **(** :ref:`RID` arg0, :ref:`Array` arg1 **)** - -.. _class_VisualServer_mesh_create: - -- :ref:`RID` **mesh_create** **(** **)** - -.. _class_VisualServer_mesh_get_surface_count: - -- :ref:`int` **mesh_get_surface_count** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_mesh_remove_surface: - -- void **mesh_remove_surface** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** - -.. _class_VisualServer_mesh_surface_get_array_index_len: - -- :ref:`int` **mesh_surface_get_array_index_len** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const - -.. _class_VisualServer_mesh_surface_get_array_len: - -- :ref:`int` **mesh_surface_get_array_len** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const - -.. _class_VisualServer_mesh_surface_get_format: - -- :ref:`int` **mesh_surface_get_format** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const - -.. _class_VisualServer_mesh_surface_get_material: - -- :ref:`RID` **mesh_surface_get_material** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const - -.. _class_VisualServer_mesh_surface_get_primitive_type: - -- :ref:`int` **mesh_surface_get_primitive_type** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const - -.. _class_VisualServer_mesh_surface_set_material: - -- void **mesh_surface_set_material** **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`RID` arg2, :ref:`bool` arg3=false **)** - -.. _class_VisualServer_multimesh_create: - -- :ref:`RID` **multimesh_create** **(** **)** - -.. _class_VisualServer_multimesh_get_aabb: - -- :ref:`AABB` **multimesh_get_aabb** **(** :ref:`RID` arg0, :ref:`AABB` arg1 **)** const - -.. _class_VisualServer_multimesh_get_mesh: - -- :ref:`RID` **multimesh_get_mesh** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_multimesh_instance_get_color: - -- :ref:`Color` **multimesh_instance_get_color** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const - -.. _class_VisualServer_multimesh_instance_get_transform: - -- :ref:`Transform` **multimesh_instance_get_transform** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const - -.. _class_VisualServer_multimesh_instance_set_color: - -- void **multimesh_instance_set_color** **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`Color` arg2 **)** - -.. _class_VisualServer_multimesh_instance_set_transform: - -- void **multimesh_instance_set_transform** **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`Transform` arg2 **)** - -.. _class_VisualServer_multimesh_set_aabb: - -- void **multimesh_set_aabb** **(** :ref:`RID` arg0, :ref:`AABB` arg1 **)** - -.. _class_VisualServer_multimesh_set_mesh: - -- void **multimesh_set_mesh** **(** :ref:`RID` arg0, :ref:`RID` arg1 **)** - -.. _class_VisualServer_particles_create: - -- :ref:`RID` **particles_create** **(** **)** - -.. _class_VisualServer_particles_get_amount: - -- :ref:`int` **particles_get_amount** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_particles_get_attractor_pos: - -- :ref:`Vector3` **particles_get_attractor_pos** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const - -.. _class_VisualServer_particles_get_attractor_strength: - -- :ref:`float` **particles_get_attractor_strength** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const - -.. _class_VisualServer_particles_get_attractors: - -- :ref:`int` **particles_get_attractors** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_particles_get_color_phase_color: - -- :ref:`Color` **particles_get_color_phase_color** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const - -.. _class_VisualServer_particles_get_color_phase_pos: - -- :ref:`float` **particles_get_color_phase_pos** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const - -.. _class_VisualServer_particles_get_color_phases: - -- :ref:`int` **particles_get_color_phases** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_particles_get_randomness: - -- :ref:`float` **particles_get_randomness** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const - -.. _class_VisualServer_particles_get_variable: - -- :ref:`float` **particles_get_variable** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** const - -.. _class_VisualServer_particles_get_visibility_aabb: - -- :ref:`AABB` **particles_get_visibility_aabb** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_particles_has_height_from_velocity: - -- :ref:`bool` **particles_has_height_from_velocity** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_particles_is_emitting: - -- :ref:`bool` **particles_is_emitting** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_particles_set_amount: - -- void **particles_set_amount** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** - -.. _class_VisualServer_particles_set_attractor_pos: - -- void **particles_set_attractor_pos** **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`Vector3` arg2 **)** - -.. _class_VisualServer_particles_set_attractor_strength: - -- void **particles_set_attractor_strength** **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`float` arg2 **)** - -.. _class_VisualServer_particles_set_attractors: - -- void **particles_set_attractors** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** - -.. _class_VisualServer_particles_set_color_phase_color: - -- void **particles_set_color_phase_color** **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`Color` arg2 **)** - -.. _class_VisualServer_particles_set_color_phase_pos: - -- void **particles_set_color_phase_pos** **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`float` arg2 **)** - -.. _class_VisualServer_particles_set_color_phases: - -- void **particles_set_color_phases** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** - -.. _class_VisualServer_particles_set_emitting: - -- void **particles_set_emitting** **(** :ref:`RID` arg0, :ref:`bool` arg1 **)** - -.. _class_VisualServer_particles_set_height_from_velocity: - -- void **particles_set_height_from_velocity** **(** :ref:`RID` arg0, :ref:`bool` arg1 **)** - -.. _class_VisualServer_particles_set_material: - -- void **particles_set_material** **(** :ref:`RID` arg0, :ref:`RID` arg1, :ref:`bool` arg2=false **)** - -.. _class_VisualServer_particles_set_randomness: - -- void **particles_set_randomness** **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`float` arg2 **)** - -.. _class_VisualServer_particles_set_variable: - -- void **particles_set_variable** **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`float` arg2 **)** - -.. _class_VisualServer_particles_set_visibility_aabb: - -- void **particles_set_visibility_aabb** **(** :ref:`RID` arg0, :ref:`AABB` arg1 **)** - -.. _class_VisualServer_portal_create: - -- :ref:`RID` **portal_create** **(** **)** - -.. _class_VisualServer_portal_get_disable_distance: - -- :ref:`float` **portal_get_disable_distance** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_portal_get_disabled_color: - -- :ref:`Color` **portal_get_disabled_color** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_portal_get_shape: - -- :ref:`Vector2Array` **portal_get_shape** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_portal_is_enabled: - -- :ref:`bool` **portal_is_enabled** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_portal_set_disable_distance: - -- void **portal_set_disable_distance** **(** :ref:`RID` arg0, :ref:`float` arg1 **)** - -.. _class_VisualServer_portal_set_disabled_color: - -- void **portal_set_disabled_color** **(** :ref:`RID` arg0, :ref:`Color` arg1 **)** - -.. _class_VisualServer_portal_set_enabled: - -- void **portal_set_enabled** **(** :ref:`RID` arg0, :ref:`bool` arg1 **)** - -.. _class_VisualServer_portal_set_shape: - -- void **portal_set_shape** **(** :ref:`RID` arg0, :ref:`Vector2Array` arg1 **)** - -.. _class_VisualServer_room_create: - -- :ref:`RID` **room_create** **(** **)** - -.. _class_VisualServer_room_get_bounds: - -- :ref:`Dictionary` **room_get_bounds** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_room_set_bounds: - -- void **room_set_bounds** **(** :ref:`RID` arg0, :ref:`Dictionary` arg1 **)** - -.. _class_VisualServer_scenario_create: - -- :ref:`RID` **scenario_create** **(** **)** - -.. _class_VisualServer_scenario_set_debug: - -- void **scenario_set_debug** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** - -.. _class_VisualServer_set_default_clear_color: - -- void **set_default_clear_color** **(** :ref:`Color` arg0 **)** - -.. _class_VisualServer_shader_create: - -- :ref:`RID` **shader_create** **(** :ref:`int` mode=0 **)** - -.. _class_VisualServer_shader_set_mode: - -- void **shader_set_mode** **(** :ref:`RID` shader, :ref:`int` mode **)** - -.. _class_VisualServer_skeleton_bone_get_transform: - -- :ref:`Transform` **skeleton_bone_get_transform** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** - -.. _class_VisualServer_skeleton_bone_set_transform: - -- void **skeleton_bone_set_transform** **(** :ref:`RID` arg0, :ref:`int` arg1, :ref:`Transform` arg2 **)** - -.. _class_VisualServer_skeleton_create: - -- :ref:`RID` **skeleton_create** **(** **)** - -.. _class_VisualServer_skeleton_get_bone_count: - -- :ref:`int` **skeleton_get_bone_count** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_skeleton_resize: - -- void **skeleton_resize** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** - -.. _class_VisualServer_sync: - -- void **sync** **(** **)** - .. _class_VisualServer_texture_create: - :ref:`RID` **texture_create** **(** **)** @@ -1078,44 +72,4 @@ Member Function Description - void **texture_set_shrink_all_x2_on_set_data** **(** :ref:`bool` shrink **)** -.. _class_VisualServer_viewport_attach_camera: - -- void **viewport_attach_camera** **(** :ref:`RID` arg0, :ref:`RID` arg1=RID() **)** - -.. _class_VisualServer_viewport_attach_canvas: - -- void **viewport_attach_canvas** **(** :ref:`RID` arg0, :ref:`RID` arg1 **)** - -.. _class_VisualServer_viewport_create: - -- :ref:`RID` **viewport_create** **(** **)** - -.. _class_VisualServer_viewport_get_attached_camera: - -- :ref:`RID` **viewport_get_attached_camera** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_viewport_get_rect: - -- :ref:`Rect2` **viewport_get_rect** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_viewport_get_scenario: - -- :ref:`RID` **viewport_get_scenario** **(** :ref:`RID` arg0 **)** const - -.. _class_VisualServer_viewport_remove_canvas: - -- void **viewport_remove_canvas** **(** :ref:`RID` arg0, :ref:`RID` arg1 **)** - -.. _class_VisualServer_viewport_set_canvas_transform: - -- void **viewport_set_canvas_transform** **(** :ref:`RID` arg0, :ref:`RID` arg1, :ref:`Matrix32` arg2 **)** - -.. _class_VisualServer_viewport_set_global_canvas_transform: - -- void **viewport_set_global_canvas_transform** **(** :ref:`RID` arg0, :ref:`Matrix32` arg1 **)** - -.. _class_VisualServer_viewport_set_rect: - -- void **viewport_set_rect** **(** :ref:`RID` arg0, :ref:`Rect2` arg1 **)** - diff --git a/classes/class_windowdialog.rst b/classes/class_windowdialog.rst index 63f0941dc..89ad983e1 100644 --- a/classes/class_windowdialog.rst +++ b/classes/class_windowdialog.rst @@ -20,13 +20,23 @@ Base class for window dialogs. Member Functions ---------------- -+--------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`TextureButton` | :ref:`get_close_button` **(** **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_title` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------+ -| void | :ref:`set_title` **(** :ref:`String` title **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------+ ++--------------------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`TextureButton` | :ref:`get_close_button` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_resizable` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_title` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_resizable` **(** :ref:`bool` resizable **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_title` **(** :ref:`String` title **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`bool` **resizable** +- :ref:`String` **window_title** Description ----------- @@ -42,12 +52,20 @@ Member Function Description Return the close :ref:`TextureButton`. +.. _class_WindowDialog_get_resizable: + +- :ref:`bool` **get_resizable** **(** **)** const + .. _class_WindowDialog_get_title: - :ref:`String` **get_title** **(** **)** const Return the title of the window. +.. _class_WindowDialog_set_resizable: + +- void **set_resizable** **(** :ref:`bool` resizable **)** + .. _class_WindowDialog_set_title: - void **set_title** **(** :ref:`String` title **)** diff --git a/classes/class_world.rst b/classes/class_world.rst index 60059beab..09dd3ed45 100644 --- a/classes/class_world.rst +++ b/classes/class_world.rst @@ -25,13 +25,16 @@ Member Functions +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_scenario` **(** **)** const | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_sound_space` **(** **)** const | -+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_space` **(** **)** const | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_environment` **(** :ref:`Environment` env **)** | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Environment` **environment** + Description ----------- @@ -52,10 +55,6 @@ Member Function Description - :ref:`RID` **get_scenario** **(** **)** const -.. _class_World_get_sound_space: - -- :ref:`RID` **get_sound_space** **(** **)** const - .. _class_World_get_space: - :ref:`RID` **get_space** **(** **)** const diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index d9e9a7fd8..834991008 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_environment` **(** :ref:`Environment` env **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`Environment` **environment** + Member Function Description --------------------------- diff --git a/classes/class_xmlparser.rst b/classes/class_xmlparser.rst index 1b8b18188..ad8a1f99d 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -45,7 +45,7 @@ Member Functions +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`open` **(** :ref:`String` file **)** | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`open_buffer` **(** :ref:`RawArray` buffer **)** | +| :ref:`int` | :ref:`open_buffer` **(** :ref:`PoolByteArray` buffer **)** | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`read` **(** **)** | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ @@ -153,7 +153,7 @@ Open a XML file for parsing. This returns an error code. .. _class_XMLParser_open_buffer: -- :ref:`int` **open_buffer** **(** :ref:`RawArray` buffer **)** +- :ref:`int` **open_buffer** **(** :ref:`PoolByteArray` buffer **)** Open a XML raw buffer for parsing. This returns an error code. diff --git a/classes/class_ysort.rst b/classes/class_ysort.rst index 0a7c03c07..3886bda34 100644 --- a/classes/class_ysort.rst +++ b/classes/class_ysort.rst @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_sort_enabled` **(** :ref:`bool` enabled **)** | +--------------------------+-----------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`bool` **sort_enabled** + Description -----------