godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2020-01-21 09:28:25 +01:00
parent e11844538c
commit 3e8e67ac95
419 changed files with 12807 additions and 99 deletions
Download Patch File Download Diff File Expand all files Collapse all files

172
classes/class_@gdscript.rst
View File

@@ -240,6 +240,8 @@ Returns a 32 bit color with red, green, blue and alpha channels. Each channel ha
red = Color8(255, 0, 0) red = Color8(255, 0, 0)
----
.. _class_@GDScript_method_ColorN: .. _class_@GDScript_method_ColorN:
- :ref:`Color<class_Color>` **ColorN** **(** :ref:`String<class_String>` name, :ref:`float<class_float>` alpha=1.0 **)** - :ref:`Color<class_Color>` **ColorN** **(** :ref:`String<class_String>` name, :ref:`float<class_float>` alpha=1.0 **)**
@@ -254,6 +256,8 @@ Supported color names:
"aliceblue", "antiquewhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedalmond", "blue", "blueviolet", "brown", "burlywood", "cadetblue", "chartreuse", "chocolate", "coral", "cornflower", "cornsilk", "crimson", "cyan", "darkblue", "darkcyan", "darkgoldenrod", "darkgray", "darkgreen", "darkkhaki", "darkmagenta", "darkolivegreen", "darkorange", "darkorchid", "darkred", "darksalmon", "darkseagreen", "darkslateblue", "darkslategray", "darkturquoise", "darkviolet", "deeppink", "deepskyblue", "dimgray", "dodgerblue", "firebrick", "floralwhite", "forestgreen", "fuchsia", "gainsboro", "ghostwhite", "gold", "goldenrod", "gray", "webgray", "green", "webgreen", "greenyellow", "honeydew", "hotpink", "indianred", "indigo", "ivory", "khaki", "lavender", "lavenderblush", "lawngreen", "lemonchiffon", "lightblue", "lightcoral", "lightcyan", "lightgoldenrod", "lightgray", "lightgreen", "lightpink", "lightsalmon", "lightseagreen", "lightskyblue", "lightslategray", "lightsteelblue", "lightyellow", "lime", "limegreen", "linen", "magenta", "maroon", "webmaroon", "mediumaquamarine", "mediumblue", "mediumorchid", "mediumpurple", "mediumseagreen", "mediumslateblue", "mediumspringgreen", "mediumturquoise", "mediumvioletred", "midnightblue", "mintcream", "mistyrose", "moccasin", "navajowhite", "navyblue", "oldlace", "olive", "olivedrab", "orange", "orangered", "orchid", "palegoldenrod", "palegreen", "paleturquoise", "palevioletred", "papayawhip", "peachpuff", "peru", "pink", "plum", "powderblue", "purple", "webpurple", "rebeccapurple", "red", "rosybrown", "royalblue", "saddlebrown", "salmon", "sandybrown", "seagreen", "seashell", "sienna", "silver", "skyblue", "slateblue", "slategray", "snow", "springgreen", "steelblue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whitesmoke", "yellow", "yellowgreen". "aliceblue", "antiquewhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedalmond", "blue", "blueviolet", "brown", "burlywood", "cadetblue", "chartreuse", "chocolate", "coral", "cornflower", "cornsilk", "crimson", "cyan", "darkblue", "darkcyan", "darkgoldenrod", "darkgray", "darkgreen", "darkkhaki", "darkmagenta", "darkolivegreen", "darkorange", "darkorchid", "darkred", "darksalmon", "darkseagreen", "darkslateblue", "darkslategray", "darkturquoise", "darkviolet", "deeppink", "deepskyblue", "dimgray", "dodgerblue", "firebrick", "floralwhite", "forestgreen", "fuchsia", "gainsboro", "ghostwhite", "gold", "goldenrod", "gray", "webgray", "green", "webgreen", "greenyellow", "honeydew", "hotpink", "indianred", "indigo", "ivory", "khaki", "lavender", "lavenderblush", "lawngreen", "lemonchiffon", "lightblue", "lightcoral", "lightcyan", "lightgoldenrod", "lightgray", "lightgreen", "lightpink", "lightsalmon", "lightseagreen", "lightskyblue", "lightslategray", "lightsteelblue", "lightyellow", "lime", "limegreen", "linen", "magenta", "maroon", "webmaroon", "mediumaquamarine", "mediumblue", "mediumorchid", "mediumpurple", "mediumseagreen", "mediumslateblue", "mediumspringgreen", "mediumturquoise", "mediumvioletred", "midnightblue", "mintcream", "mistyrose", "moccasin", "navajowhite", "navyblue", "oldlace", "olive", "olivedrab", "orange", "orangered", "orchid", "palegoldenrod", "palegreen", "paleturquoise", "palevioletred", "papayawhip", "peachpuff", "peru", "pink", "plum", "powderblue", "purple", "webpurple", "rebeccapurple", "red", "rosybrown", "royalblue", "saddlebrown", "salmon", "sandybrown", "seagreen", "seashell", "sienna", "silver", "skyblue", "slateblue", "slategray", "snow", "springgreen", "steelblue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whitesmoke", "yellow", "yellowgreen".
----
.. _class_@GDScript_method_abs: .. _class_@GDScript_method_abs:
- :ref:`float<class_float>` **abs** **(** :ref:`float<class_float>` s **)** - :ref:`float<class_float>` **abs** **(** :ref:`float<class_float>` s **)**
@@ -265,6 +269,8 @@ Returns the absolute value of parameter ``s`` (i.e. unsigned value, works for in
# a is 1 # a is 1
a = abs(-1) a = abs(-1)
----
.. _class_@GDScript_method_acos: .. _class_@GDScript_method_acos:
- :ref:`float<class_float>` **acos** **(** :ref:`float<class_float>` s **)** - :ref:`float<class_float>` **acos** **(** :ref:`float<class_float>` s **)**
@@ -276,6 +282,8 @@ Returns the arc cosine of ``s`` in radians. Use to get the angle of cosine ``s``
# c is 0.523599 or 30 degrees if converted with rad2deg(s) # c is 0.523599 or 30 degrees if converted with rad2deg(s)
c = acos(0.866025) c = acos(0.866025)
----
.. _class_@GDScript_method_asin: .. _class_@GDScript_method_asin:
- :ref:`float<class_float>` **asin** **(** :ref:`float<class_float>` s **)** - :ref:`float<class_float>` **asin** **(** :ref:`float<class_float>` s **)**
@@ -287,6 +295,8 @@ Returns the arc sine of ``s`` in radians. Use to get the angle of sine ``s``.
# s is 0.523599 or 30 degrees if converted with rad2deg(s) # s is 0.523599 or 30 degrees if converted with rad2deg(s)
s = asin(0.5) s = asin(0.5)
----
.. _class_@GDScript_method_assert: .. _class_@GDScript_method_assert:
- void **assert** **(** :ref:`bool<class_bool>` condition **)** - void **assert** **(** :ref:`bool<class_bool>` condition **)**
@@ -301,6 +311,8 @@ Asserts that the ``condition`` is ``true`` . If the ``condition`` is ``false``,
assert(speed >= 0) # False, the program will stop assert(speed >= 0) # False, the program will stop
assert(speed >= 0 && speed < 20) # You can also combine the two conditional statements in one check assert(speed >= 0 && speed < 20) # You can also combine the two conditional statements in one check
----
.. _class_@GDScript_method_atan: .. _class_@GDScript_method_atan:
- :ref:`float<class_float>` **atan** **(** :ref:`float<class_float>` s **)** - :ref:`float<class_float>` **atan** **(** :ref:`float<class_float>` s **)**
@@ -313,6 +325,8 @@ The method cannot know in which quadrant the angle should fall. See :ref:`atan2<
a = atan(0.5) # a is 0.463648 a = atan(0.5) # a is 0.463648
----
.. _class_@GDScript_method_atan2: .. _class_@GDScript_method_atan2:
- :ref:`float<class_float>` **atan2** **(** :ref:`float<class_float>` y, :ref:`float<class_float>` x **)** - :ref:`float<class_float>` **atan2** **(** :ref:`float<class_float>` y, :ref:`float<class_float>` x **)**
@@ -323,6 +337,8 @@ Returns the arc tangent of ``y/x`` in radians. Use to get the angle of tangent `
a = atan2(0, -1) # a is 3.141593 a = atan2(0, -1) # a is 3.141593
----
.. _class_@GDScript_method_bytes2var: .. _class_@GDScript_method_bytes2var:
- :ref:`Variant<class_Variant>` **bytes2var** **(** :ref:`PoolByteArray<class_PoolByteArray>` bytes, :ref:`bool<class_bool>` allow_objects=false **)** - :ref:`Variant<class_Variant>` **bytes2var** **(** :ref:`PoolByteArray<class_PoolByteArray>` bytes, :ref:`bool<class_bool>` allow_objects=false **)**
@@ -331,12 +347,16 @@ Decodes a byte array back to a value. When ``allow_objects`` is ``true`` decodin
**WARNING:** Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). **WARNING:** Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution).
----
.. _class_@GDScript_method_cartesian2polar: .. _class_@GDScript_method_cartesian2polar:
- :ref:`Vector2<class_Vector2>` **cartesian2polar** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** - :ref:`Vector2<class_Vector2>` **cartesian2polar** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**
Converts a 2D point expressed in the cartesian coordinate system (x and y axis) to the polar coordinate system (a distance from the origin and an angle). Converts a 2D point expressed in the cartesian coordinate system (x and y axis) to the polar coordinate system (a distance from the origin and an angle).
----
.. _class_@GDScript_method_ceil: .. _class_@GDScript_method_ceil:
- :ref:`float<class_float>` **ceil** **(** :ref:`float<class_float>` s **)** - :ref:`float<class_float>` **ceil** **(** :ref:`float<class_float>` s **)**
@@ -348,6 +368,8 @@ Rounds ``s`` upward, returning the smallest integral value that is not less than
i = ceil(1.45) # i is 2 i = ceil(1.45) # i is 2
i = ceil(1.001) # i is 2 i = ceil(1.001) # i is 2
----
.. _class_@GDScript_method_char: .. _class_@GDScript_method_char:
- :ref:`String<class_String>` **char** **(** :ref:`int<class_int>` ascii **)** - :ref:`String<class_String>` **char** **(** :ref:`int<class_int>` ascii **)**
@@ -361,6 +383,8 @@ Returns a character as a String of the given ASCII code.
# a is 'a' # a is 'a'
a = char(65 + 32) a = char(65 + 32)
----
.. _class_@GDScript_method_clamp: .. _class_@GDScript_method_clamp:
- :ref:`float<class_float>` **clamp** **(** :ref:`float<class_float>` value, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)** - :ref:`float<class_float>` **clamp** **(** :ref:`float<class_float>` value, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)**
@@ -377,6 +401,8 @@ Clamps ``value`` and returns a value not less than ``min`` and not more than ``m
# a is 1 # a is 1
a = clamp(speed, 1, 20) a = clamp(speed, 1, 20)
----
.. _class_@GDScript_method_convert: .. _class_@GDScript_method_convert:
- :ref:`Variant<class_Variant>` **convert** **(** :ref:`Variant<class_Variant>` what, :ref:`int<class_int>` type **)** - :ref:`Variant<class_Variant>` **convert** **(** :ref:`Variant<class_Variant>` what, :ref:`int<class_int>` type **)**
@@ -393,6 +419,8 @@ Converts from a type to another in the best way possible. The ``type`` parameter
# (1, 0) is 6 characters # (1, 0) is 6 characters
print(a.length()) print(a.length())
----
.. _class_@GDScript_method_cos: .. _class_@GDScript_method_cos:
- :ref:`float<class_float>` **cos** **(** :ref:`float<class_float>` s **)** - :ref:`float<class_float>` **cos** **(** :ref:`float<class_float>` s **)**
@@ -405,6 +433,8 @@ Returns the cosine of angle ``s`` in radians.
print(cos(PI * 2)) print(cos(PI * 2))
print(cos(PI)) print(cos(PI))
----
.. _class_@GDScript_method_cosh: .. _class_@GDScript_method_cosh:
- :ref:`float<class_float>` **cosh** **(** :ref:`float<class_float>` s **)** - :ref:`float<class_float>` **cosh** **(** :ref:`float<class_float>` s **)**
@@ -416,12 +446,16 @@ Returns the hyperbolic cosine of ``s`` in radians.
# prints 1.543081 # prints 1.543081
print(cosh(1)) print(cosh(1))
----
.. _class_@GDScript_method_db2linear: .. _class_@GDScript_method_db2linear:
- :ref:`float<class_float>` **db2linear** **(** :ref:`float<class_float>` db **)** - :ref:`float<class_float>` **db2linear** **(** :ref:`float<class_float>` db **)**
Converts from decibels to linear energy (audio). Converts from decibels to linear energy (audio).
----
.. _class_@GDScript_method_decimals: .. _class_@GDScript_method_decimals:
- :ref:`float<class_float>` **decimals** **(** :ref:`float<class_float>` step **)** - :ref:`float<class_float>` **decimals** **(** :ref:`float<class_float>` step **)**
@@ -433,6 +467,8 @@ Returns the position of the first non-zero digit, after the decimal point.
# n is 2 # n is 2
n = decimals(0.035) n = decimals(0.035)
----
.. _class_@GDScript_method_dectime: .. _class_@GDScript_method_dectime:
- :ref:`float<class_float>` **dectime** **(** :ref:`float<class_float>` value, :ref:`float<class_float>` amount, :ref:`float<class_float>` step **)** - :ref:`float<class_float>` **dectime** **(** :ref:`float<class_float>` value, :ref:`float<class_float>` amount, :ref:`float<class_float>` step **)**
@@ -444,6 +480,8 @@ Returns the result of ``value`` decreased by ``step`` \* ``amount``.
# a = 59 # a = 59
a = dectime(60, 10, 0.1)) a = dectime(60, 10, 0.1))
----
.. _class_@GDScript_method_deg2rad: .. _class_@GDScript_method_deg2rad:
- :ref:`float<class_float>` **deg2rad** **(** :ref:`float<class_float>` deg **)** - :ref:`float<class_float>` **deg2rad** **(** :ref:`float<class_float>` deg **)**
@@ -455,18 +493,24 @@ Returns degrees converted to radians.
# r is 3.141593 # r is 3.141593
r = deg2rad(180) r = deg2rad(180)
----
.. _class_@GDScript_method_dict2inst: .. _class_@GDScript_method_dict2inst:
- :ref:`Object<class_Object>` **dict2inst** **(** :ref:`Dictionary<class_Dictionary>` dict **)** - :ref:`Object<class_Object>` **dict2inst** **(** :ref:`Dictionary<class_Dictionary>` dict **)**
Converts a previously converted instance to a dictionary, back into an instance. Useful for deserializing. Converts a previously converted instance to a dictionary, back into an instance. Useful for deserializing.
----
.. _class_@GDScript_method_ease: .. _class_@GDScript_method_ease:
- :ref:`float<class_float>` **ease** **(** :ref:`float<class_float>` s, :ref:`float<class_float>` curve **)** - :ref:`float<class_float>` **ease** **(** :ref:`float<class_float>` s, :ref:`float<class_float>` curve **)**
Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in. Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in.
----
.. _class_@GDScript_method_exp: .. _class_@GDScript_method_exp:
- :ref:`float<class_float>` **exp** **(** :ref:`float<class_float>` s **)** - :ref:`float<class_float>` **exp** **(** :ref:`float<class_float>` s **)**
@@ -475,10 +519,14 @@ The natural exponential function. It raises the mathematical constant **e** to t
**e** has an approximate value of 2.71828. **e** has an approximate value of 2.71828.
For exponents to other bases use the method :ref:`pow<class_@GDScript_method_pow>`.
:: ::
a = exp(2) # approximately 7.39 a = exp(2) # approximately 7.39
----
.. _class_@GDScript_method_floor: .. _class_@GDScript_method_floor:
- :ref:`float<class_float>` **floor** **(** :ref:`float<class_float>` s **)** - :ref:`float<class_float>` **floor** **(** :ref:`float<class_float>` s **)**
@@ -492,6 +540,8 @@ Rounds ``s`` to the closest smaller integer and returns it.
# a is -3 # a is -3
a = floor(-2.99) a = floor(-2.99)
----
.. _class_@GDScript_method_fmod: .. _class_@GDScript_method_fmod:
- :ref:`float<class_float>` **fmod** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** - :ref:`float<class_float>` **fmod** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**
@@ -503,6 +553,8 @@ Returns the floating-point remainder of ``x/y``.
# remainder is 1.5 # remainder is 1.5
var remainder = fmod(7, 5.5) var remainder = fmod(7, 5.5)
----
.. _class_@GDScript_method_fposmod: .. _class_@GDScript_method_fposmod:
- :ref:`float<class_float>` **fposmod** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** - :ref:`float<class_float>` **fposmod** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**
@@ -531,6 +583,8 @@ Produces:
-2 8 -2 8
-1 9 -1 9
----
.. _class_@GDScript_method_funcref: .. _class_@GDScript_method_funcref:
- :ref:`FuncRef<class_FuncRef>` **funcref** **(** :ref:`Object<class_Object>` instance, :ref:`String<class_String>` funcname **)** - :ref:`FuncRef<class_FuncRef>` **funcref** **(** :ref:`Object<class_Object>` instance, :ref:`String<class_String>` funcname **)**
@@ -545,6 +599,8 @@ Returns a reference to the specified function ``funcname`` in the ``instance`` n
a = funcref(self, "foo") a = funcref(self, "foo")
print(a.call_func()) # prints bar print(a.call_func()) # prints bar
----
.. _class_@GDScript_method_get_stack: .. _class_@GDScript_method_get_stack:
- :ref:`Array<class_Array>` **get_stack** **(** **)** - :ref:`Array<class_Array>` **get_stack** **(** **)**
@@ -568,6 +624,8 @@ would print
[{function:bar, line:12, source:res://script.gd}, {function:foo, line:9, source:res://script.gd}, {function:_ready, line:6, source:res://script.gd}] [{function:bar, line:12, source:res://script.gd}, {function:foo, line:9, source:res://script.gd}, {function:_ready, line:6, source:res://script.gd}]
----
.. _class_@GDScript_method_hash: .. _class_@GDScript_method_hash:
- :ref:`int<class_int>` **hash** **(** :ref:`Variant<class_Variant>` var **)** - :ref:`int<class_int>` **hash** **(** :ref:`Variant<class_Variant>` var **)**
@@ -578,6 +636,8 @@ Returns the integer hash of the variable passed.
print(hash("a")) # prints 177670 print(hash("a")) # prints 177670
----
.. _class_@GDScript_method_inst2dict: .. _class_@GDScript_method_inst2dict:
- :ref:`Dictionary<class_Dictionary>` **inst2dict** **(** :ref:`Object<class_Object>` inst **)** - :ref:`Dictionary<class_Dictionary>` **inst2dict** **(** :ref:`Object<class_Object>` inst **)**
@@ -599,6 +659,8 @@ Prints out:
[@subpath, @path, foo] [@subpath, @path, foo]
[, res://test.gd, bar] [, res://test.gd, bar]
----
.. _class_@GDScript_method_instance_from_id: .. _class_@GDScript_method_instance_from_id:
- :ref:`Object<class_Object>` **instance_from_id** **(** :ref:`int<class_int>` instance_id **)** - :ref:`Object<class_Object>` **instance_from_id** **(** :ref:`int<class_int>` instance_id **)**
@@ -613,6 +675,8 @@ Returns the Object that corresponds to ``instance_id``. All Objects have a uniqu
var inst = instance_from_id(id) var inst = instance_from_id(id)
print(inst.foo) # prints bar print(inst.foo) # prints bar
----
.. _class_@GDScript_method_inverse_lerp: .. _class_@GDScript_method_inverse_lerp:
- :ref:`float<class_float>` **inverse_lerp** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight **)** - :ref:`float<class_float>` **inverse_lerp** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight **)**
@@ -623,24 +687,32 @@ Returns a normalized value considering the given range.
inverse_lerp(3, 5, 4) # returns 0.5 inverse_lerp(3, 5, 4) # returns 0.5
----
.. _class_@GDScript_method_is_inf: .. _class_@GDScript_method_is_inf:
- :ref:`bool<class_bool>` **is_inf** **(** :ref:`float<class_float>` s **)** - :ref:`bool<class_bool>` **is_inf** **(** :ref:`float<class_float>` s **)**
Returns whether ``s`` is an infinity value (either positive infinity or negative infinity). Returns whether ``s`` is an infinity value (either positive infinity or negative infinity).
----
.. _class_@GDScript_method_is_instance_valid: .. _class_@GDScript_method_is_instance_valid:
- :ref:`bool<class_bool>` **is_instance_valid** **(** :ref:`Object<class_Object>` instance **)** - :ref:`bool<class_bool>` **is_instance_valid** **(** :ref:`Object<class_Object>` instance **)**
Returns whether ``instance`` is a valid object (e.g. has not been deleted from memory). Returns whether ``instance`` is a valid object (e.g. has not been deleted from memory).
----
.. _class_@GDScript_method_is_nan: .. _class_@GDScript_method_is_nan:
- :ref:`bool<class_bool>` **is_nan** **(** :ref:`float<class_float>` s **)** - :ref:`bool<class_bool>` **is_nan** **(** :ref:`float<class_float>` s **)**
Returns whether ``s`` is a NaN (Not-A-Number) value. Returns whether ``s`` is a NaN (Not-A-Number) value.
----
.. _class_@GDScript_method_len: .. _class_@GDScript_method_len:
- :ref:`int<class_int>` **len** **(** :ref:`Variant<class_Variant>` var **)** - :ref:`int<class_int>` **len** **(** :ref:`Variant<class_Variant>` var **)**
@@ -654,6 +726,8 @@ Returns length of Variant ``var``. Length is the character count of String, elem
a = [1, 2, 3, 4] a = [1, 2, 3, 4]
len(a) # returns 4 len(a) # returns 4
----
.. _class_@GDScript_method_lerp: .. _class_@GDScript_method_lerp:
- :ref:`Variant<class_Variant>` **lerp** **(** :ref:`Variant<class_Variant>` from, :ref:`Variant<class_Variant>` to, :ref:`float<class_float>` weight **)** - :ref:`Variant<class_Variant>` **lerp** **(** :ref:`Variant<class_Variant>` from, :ref:`Variant<class_Variant>` to, :ref:`float<class_float>` weight **)**
@@ -669,12 +743,16 @@ If both are of the same vector type (:ref:`Vector2<class_Vector2>`, :ref:`Vector
lerp(0, 4, 0.75) # returns 3.0 lerp(0, 4, 0.75) # returns 3.0
lerp(Vector2(1, 5), Vector2(3, 2), 0.5) # returns Vector2(2, 3.5) lerp(Vector2(1, 5), Vector2(3, 2), 0.5) # returns Vector2(2, 3.5)
----
.. _class_@GDScript_method_linear2db: .. _class_@GDScript_method_linear2db:
- :ref:`float<class_float>` **linear2db** **(** :ref:`float<class_float>` nrg **)** - :ref:`float<class_float>` **linear2db** **(** :ref:`float<class_float>` nrg **)**
Converts from linear energy to decibels (audio). Converts from linear energy to decibels (audio).
----
.. _class_@GDScript_method_load: .. _class_@GDScript_method_load:
- :ref:`Resource<class_Resource>` **load** **(** :ref:`String<class_String>` path **)** - :ref:`Resource<class_Resource>` **load** **(** :ref:`String<class_String>` path **)**
@@ -688,6 +766,8 @@ Loads a resource from the filesystem located at ``path``.
# load a scene called main located in the root of the project directory # load a scene called main located in the root of the project directory
var main = load("res://main.tscn") var main = load("res://main.tscn")
----
.. _class_@GDScript_method_log: .. _class_@GDScript_method_log:
- :ref:`float<class_float>` **log** **(** :ref:`float<class_float>` s **)** - :ref:`float<class_float>` **log** **(** :ref:`float<class_float>` s **)**
@@ -700,6 +780,8 @@ Natural logarithm. The amount of time needed to reach a certain level of continu
log(10) # returns 2.302585 log(10) # returns 2.302585
----
.. _class_@GDScript_method_max: .. _class_@GDScript_method_max:
- :ref:`float<class_float>` **max** **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)** - :ref:`float<class_float>` **max** **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)**
@@ -711,6 +793,8 @@ Returns the maximum of two values.
max(1, 2) # returns 2 max(1, 2) # returns 2
max(-3.99, -4) # returns -3.99 max(-3.99, -4) # returns -3.99
----
.. _class_@GDScript_method_min: .. _class_@GDScript_method_min:
- :ref:`float<class_float>` **min** **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)** - :ref:`float<class_float>` **min** **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)**
@@ -722,6 +806,8 @@ Returns the minimum of two values.
min(1, 2) # returns 1 min(1, 2) # returns 1
min(-3.99, -4) # returns -4 min(-3.99, -4) # returns -4
----
.. _class_@GDScript_method_nearest_po2: .. _class_@GDScript_method_nearest_po2:
- :ref:`int<class_int>` **nearest_po2** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **nearest_po2** **(** :ref:`int<class_int>` value **)**
@@ -734,6 +820,8 @@ Returns the nearest larger power of 2 for integer ``value``.
nearest_po2(4) # returns 4 nearest_po2(4) # returns 4
nearest_po2(5) # returns 8 nearest_po2(5) # returns 8
----
.. _class_@GDScript_method_parse_json: .. _class_@GDScript_method_parse_json:
- :ref:`Variant<class_Variant>` **parse_json** **(** :ref:`String<class_String>` json **)** - :ref:`Variant<class_Variant>` **parse_json** **(** :ref:`String<class_String>` json **)**
@@ -752,12 +840,16 @@ Note that JSON objects do not preserve key order like Godot dictionaries, thus y
else: else:
print("unexpected results") print("unexpected results")
----
.. _class_@GDScript_method_polar2cartesian: .. _class_@GDScript_method_polar2cartesian:
- :ref:`Vector2<class_Vector2>` **polar2cartesian** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` th **)** - :ref:`Vector2<class_Vector2>` **polar2cartesian** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` th **)**
Converts a 2D point expressed in the polar coordinate system (a distance from the origin ``r`` and an angle ``th``) to the cartesian coordinate system (x and y axis). Converts a 2D point expressed in the polar coordinate system (a distance from the origin ``r`` and an angle ``th``) to the cartesian coordinate system (x and y axis).
----
.. _class_@GDScript_method_pow: .. _class_@GDScript_method_pow:
- :ref:`float<class_float>` **pow** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** - :ref:`float<class_float>` **pow** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**
@@ -768,6 +860,8 @@ Returns the result of ``x`` raised to the power of ``y``.
pow(2, 5) # returns 32 pow(2, 5) # returns 32
----
.. _class_@GDScript_method_preload: .. _class_@GDScript_method_preload:
- :ref:`Resource<class_Resource>` **preload** **(** :ref:`String<class_String>` path **)** - :ref:`Resource<class_Resource>` **preload** **(** :ref:`String<class_String>` path **)**
@@ -781,6 +875,8 @@ Returns a resource from the filesystem that is loaded during script parsing.
# load a scene called main located in the root of the project directory # load a scene called main located in the root of the project directory
var main = preload("res://main.tscn") var main = preload("res://main.tscn")
----
.. _class_@GDScript_method_print: .. _class_@GDScript_method_print:
- void **print** **(** ... **)** vararg - void **print** **(** ... **)** vararg
@@ -792,12 +888,16 @@ Converts one or more arguments to strings in the best way possible and prints th
a = [1, 2, 3] a = [1, 2, 3]
print("a", "b", a) # prints ab[1, 2, 3] print("a", "b", a) # prints ab[1, 2, 3]
----
.. _class_@GDScript_method_print_debug: .. _class_@GDScript_method_print_debug:
- void **print_debug** **(** ... **)** vararg - void **print_debug** **(** ... **)** vararg
Like :ref:`print<class_@GDScript_method_print>`, but prints only when used in debug mode. Like :ref:`print<class_@GDScript_method_print>`, but prints only when used in debug mode.
----
.. _class_@GDScript_method_print_stack: .. _class_@GDScript_method_print_stack:
- void **print_stack** **(** **)** - void **print_stack** **(** **)**
@@ -810,6 +910,8 @@ Output in the console would look something like this:
Frame 0 - res://test.gd:16 in function '_process' Frame 0 - res://test.gd:16 in function '_process'
----
.. _class_@GDScript_method_printerr: .. _class_@GDScript_method_printerr:
- void **printerr** **(** ... **)** vararg - void **printerr** **(** ... **)** vararg
@@ -820,6 +922,8 @@ Prints one or more arguments to strings in the best way possible to standard err
printerr("prints to stderr") printerr("prints to stderr")
----
.. _class_@GDScript_method_printraw: .. _class_@GDScript_method_printraw:
- void **printraw** **(** ... **)** vararg - void **printraw** **(** ... **)** vararg
@@ -832,6 +936,8 @@ Prints one or more arguments to strings in the best way possible to console. No
printraw("B") printraw("B")
# prints AB # prints AB
----
.. _class_@GDScript_method_prints: .. _class_@GDScript_method_prints:
- void **prints** **(** ... **)** vararg - void **prints** **(** ... **)** vararg
@@ -842,6 +948,8 @@ Prints one or more arguments to the console with a space between each argument.
prints("A", "B", "C") # prints A B C prints("A", "B", "C") # prints A B C
----
.. _class_@GDScript_method_printt: .. _class_@GDScript_method_printt:
- void **printt** **(** ... **)** vararg - void **printt** **(** ... **)** vararg
@@ -852,6 +960,8 @@ Prints one or more arguments to the console with a tab between each argument.
printt("A", "B", "C") # prints A B C printt("A", "B", "C") # prints A B C
----
.. _class_@GDScript_method_push_error: .. _class_@GDScript_method_push_error:
- void **push_error** **(** :ref:`String<class_String>` message **)** - void **push_error** **(** :ref:`String<class_String>` message **)**
@@ -862,6 +972,8 @@ Pushes an error message to Godot's built-in debugger and to the OS terminal.
push_error("test error") # prints "test error" to debugger and terminal as error call push_error("test error") # prints "test error" to debugger and terminal as error call
----
.. _class_@GDScript_method_push_warning: .. _class_@GDScript_method_push_warning:
- void **push_warning** **(** :ref:`String<class_String>` message **)** - void **push_warning** **(** :ref:`String<class_String>` message **)**
@@ -872,6 +984,8 @@ Pushes a warning message to Godot's built-in debugger and to the OS terminal.
push_warning("test warning") # prints "test warning" to debugger and terminal as warning call push_warning("test warning") # prints "test warning" to debugger and terminal as warning call
----
.. _class_@GDScript_method_rad2deg: .. _class_@GDScript_method_rad2deg:
- :ref:`float<class_float>` **rad2deg** **(** :ref:`float<class_float>` rad **)** - :ref:`float<class_float>` **rad2deg** **(** :ref:`float<class_float>` rad **)**
@@ -882,6 +996,8 @@ Converts from radians to degrees.
rad2deg(0.523599) # returns 30 rad2deg(0.523599) # returns 30
----
.. _class_@GDScript_method_rand_range: .. _class_@GDScript_method_rand_range:
- :ref:`float<class_float>` **rand_range** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to **)** - :ref:`float<class_float>` **rand_range** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to **)**
@@ -892,12 +1008,16 @@ Random range, any floating point value between ``from`` and ``to``.
prints(rand_range(0, 1), rand_range(0, 1)) # prints e.g. 0.135591 0.405263 prints(rand_range(0, 1), rand_range(0, 1)) # prints e.g. 0.135591 0.405263
----
.. _class_@GDScript_method_rand_seed: .. _class_@GDScript_method_rand_seed:
- :ref:`Array<class_Array>` **rand_seed** **(** :ref:`int<class_int>` seed **)** - :ref:`Array<class_Array>` **rand_seed** **(** :ref:`int<class_int>` seed **)**
Random from seed: pass a ``seed``, and an array with both number and new seed is returned. "Seed" here refers to the internal state of the pseudo random number generator. The internal state of the current implementation is 64 bits. 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_method_randf: .. _class_@GDScript_method_randf:
- :ref:`float<class_float>` **randf** **(** **)** - :ref:`float<class_float>` **randf** **(** **)**
@@ -908,6 +1028,8 @@ Returns a random floating point value on the interval ``[0, 1]``.
randf() # returns e.g. 0.375671 randf() # returns e.g. 0.375671
----
.. _class_@GDScript_method_randi: .. _class_@GDScript_method_randi:
- :ref:`int<class_int>` **randi** **(** **)** - :ref:`int<class_int>` **randi** **(** **)**
@@ -921,6 +1043,8 @@ Returns a random unsigned 32 bit integer. Use remainder to obtain a random value
randi() % 100 # returns random integer between 0 and 99 randi() % 100 # returns random integer between 0 and 99
randi() % 100 + 1 # returns random integer between 1 and 100 randi() % 100 + 1 # returns random integer between 1 and 100
----
.. _class_@GDScript_method_randomize: .. _class_@GDScript_method_randomize:
- void **randomize** **(** **)** - void **randomize** **(** **)**
@@ -932,6 +1056,8 @@ Randomizes the seed (or the internal state) of the random number generator. Curr
func _ready(): func _ready():
randomize() randomize()
----
.. _class_@GDScript_method_range: .. _class_@GDScript_method_range:
- :ref:`Array<class_Array>` **range** **(** ... **)** vararg - :ref:`Array<class_Array>` **range** **(** ... **)** vararg
@@ -964,6 +1090,8 @@ Output:
2 2
4 4
----
.. _class_@GDScript_method_range_lerp: .. _class_@GDScript_method_range_lerp:
- :ref:`float<class_float>` **range_lerp** **(** :ref:`float<class_float>` value, :ref:`float<class_float>` istart, :ref:`float<class_float>` istop, :ref:`float<class_float>` ostart, :ref:`float<class_float>` ostop **)** - :ref:`float<class_float>` **range_lerp** **(** :ref:`float<class_float>` value, :ref:`float<class_float>` istart, :ref:`float<class_float>` istop, :ref:`float<class_float>` ostart, :ref:`float<class_float>` ostop **)**
@@ -974,6 +1102,8 @@ Maps a ``value`` from range ``[istart, istop]`` to ``[ostart, ostop]``.
range_lerp(75, 0, 100, -1, 1) # returns 0.5 range_lerp(75, 0, 100, -1, 1) # returns 0.5
----
.. _class_@GDScript_method_round: .. _class_@GDScript_method_round:
- :ref:`float<class_float>` **round** **(** :ref:`float<class_float>` s **)** - :ref:`float<class_float>` **round** **(** :ref:`float<class_float>` s **)**
@@ -984,6 +1114,8 @@ Returns the integral value that is nearest to ``s``, with halfway cases rounded
round(2.6) # returns 3 round(2.6) # returns 3
----
.. _class_@GDScript_method_seed: .. _class_@GDScript_method_seed:
- void **seed** **(** :ref:`int<class_int>` seed **)** - void **seed** **(** :ref:`int<class_int>` seed **)**
@@ -995,6 +1127,8 @@ Sets seed for the random number generator.
my_seed = "Godot Rocks" my_seed = "Godot Rocks"
seed(my_seed.hash()) seed(my_seed.hash())
----
.. _class_@GDScript_method_sign: .. _class_@GDScript_method_sign:
- :ref:`float<class_float>` **sign** **(** :ref:`float<class_float>` s **)** - :ref:`float<class_float>` **sign** **(** :ref:`float<class_float>` s **)**
@@ -1007,6 +1141,8 @@ Returns the sign of ``s``: -1 or 1. Returns 0 if ``s`` is 0.
sign(0) # returns 0 sign(0) # returns 0
sign(6) # returns 1 sign(6) # returns 1
----
.. _class_@GDScript_method_sin: .. _class_@GDScript_method_sin:
- :ref:`float<class_float>` **sin** **(** :ref:`float<class_float>` s **)** - :ref:`float<class_float>` **sin** **(** :ref:`float<class_float>` s **)**
@@ -1017,6 +1153,8 @@ Returns the sine of angle ``s`` in radians.
sin(0.523599) # returns 0.5 sin(0.523599) # returns 0.5
----
.. _class_@GDScript_method_sinh: .. _class_@GDScript_method_sinh:
- :ref:`float<class_float>` **sinh** **(** :ref:`float<class_float>` s **)** - :ref:`float<class_float>` **sinh** **(** :ref:`float<class_float>` s **)**
@@ -1028,6 +1166,8 @@ Returns the hyperbolic sine of ``s``.
a = log(2.0) # returns 0.693147 a = log(2.0) # returns 0.693147
sinh(a) # returns 0.75 sinh(a) # returns 0.75
----
.. _class_@GDScript_method_smoothstep: .. _class_@GDScript_method_smoothstep:
- :ref:`float<class_float>` **smoothstep** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight **)** - :ref:`float<class_float>` **smoothstep** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight **)**
@@ -1040,6 +1180,8 @@ Returns a number smoothly interpolated between the ``from`` and ``to``, based on
smoothstep(0, 2, 1.0) # returns 0.5 smoothstep(0, 2, 1.0) # returns 0.5
smoothstep(0, 2, 2.0) # returns 1.0 smoothstep(0, 2, 2.0) # returns 1.0
----
.. _class_@GDScript_method_sqrt: .. _class_@GDScript_method_sqrt:
- :ref:`float<class_float>` **sqrt** **(** :ref:`float<class_float>` s **)** - :ref:`float<class_float>` **sqrt** **(** :ref:`float<class_float>` s **)**
@@ -1050,12 +1192,16 @@ Returns the square root of ``s``.
sqrt(9) # returns 3 sqrt(9) # returns 3
----
.. _class_@GDScript_method_stepify: .. _class_@GDScript_method_stepify:
- :ref:`float<class_float>` **stepify** **(** :ref:`float<class_float>` s, :ref:`float<class_float>` step **)** - :ref:`float<class_float>` **stepify** **(** :ref:`float<class_float>` s, :ref:`float<class_float>` step **)**
Snaps float value ``s`` to a given ``step``. Snaps float value ``s`` to a given ``step``.
----
.. _class_@GDScript_method_str: .. _class_@GDScript_method_str:
- :ref:`String<class_String>` **str** **(** ... **)** vararg - :ref:`String<class_String>` **str** **(** ... **)** vararg
@@ -1069,6 +1215,8 @@ Converts one or more arguments to string in the best way possible.
len(a) # returns 3 len(a) # returns 3
len(b) # returns 12 len(b) # returns 12
----
.. _class_@GDScript_method_str2var: .. _class_@GDScript_method_str2var:
- :ref:`Variant<class_Variant>` **str2var** **(** :ref:`String<class_String>` string **)** - :ref:`Variant<class_Variant>` **str2var** **(** :ref:`String<class_String>` string **)**
@@ -1081,6 +1229,8 @@ Converts a formatted string that was returned by :ref:`var2str<class_@GDScript_m
b = str2var(a) b = str2var(a)
print(b['a']) # prints 1 print(b['a']) # prints 1
----
.. _class_@GDScript_method_tan: .. _class_@GDScript_method_tan:
- :ref:`float<class_float>` **tan** **(** :ref:`float<class_float>` s **)** - :ref:`float<class_float>` **tan** **(** :ref:`float<class_float>` s **)**
@@ -1091,6 +1241,8 @@ Returns the tangent of angle ``s`` in radians.
tan(deg2rad(45)) # returns 1 tan(deg2rad(45)) # returns 1
----
.. _class_@GDScript_method_tanh: .. _class_@GDScript_method_tanh:
- :ref:`float<class_float>` **tanh** **(** :ref:`float<class_float>` s **)** - :ref:`float<class_float>` **tanh** **(** :ref:`float<class_float>` s **)**
@@ -1102,6 +1254,8 @@ Returns the hyperbolic tangent of ``s``.
a = log(2.0) # returns 0.693147 a = log(2.0) # returns 0.693147
tanh(a) # returns 0.6 tanh(a) # returns 0.6
----
.. _class_@GDScript_method_to_json: .. _class_@GDScript_method_to_json:
- :ref:`String<class_String>` **to_json** **(** :ref:`Variant<class_Variant>` var **)** - :ref:`String<class_String>` **to_json** **(** :ref:`Variant<class_Variant>` var **)**
@@ -1114,6 +1268,8 @@ Converts a Variant ``var`` to JSON text and return the result. Useful for serial
b = to_json(a) b = to_json(a)
print(b) # {"a":1, "b":2} print(b) # {"a":1, "b":2}
----
.. _class_@GDScript_method_type_exists: .. _class_@GDScript_method_type_exists:
- :ref:`bool<class_bool>` **type_exists** **(** :ref:`String<class_String>` type **)** - :ref:`bool<class_bool>` **type_exists** **(** :ref:`String<class_String>` type **)**
@@ -1125,6 +1281,8 @@ Returns whether the given class exists in :ref:`ClassDB<class_ClassDB>`.
type_exists("Sprite") # returns true type_exists("Sprite") # returns true
type_exists("Variant") # returns false type_exists("Variant") # returns false
----
.. _class_@GDScript_method_typeof: .. _class_@GDScript_method_typeof:
- :ref:`int<class_int>` **typeof** **(** :ref:`Variant<class_Variant>` what **)** - :ref:`int<class_int>` **typeof** **(** :ref:`Variant<class_Variant>` what **)**
@@ -1139,6 +1297,8 @@ Returns the internal type of the given Variant object, using the TYPE\_\* enum i
else: else:
print("unexpected results") print("unexpected results")
----
.. _class_@GDScript_method_validate_json: .. _class_@GDScript_method_validate_json:
- :ref:`String<class_String>` **validate_json** **(** :ref:`String<class_String>` json **)** - :ref:`String<class_String>` **validate_json** **(** :ref:`String<class_String>` json **)**
@@ -1154,12 +1314,16 @@ Checks that ``json`` is valid JSON data. Returns empty string if valid. Returns
else: else:
prints("invalid", v) prints("invalid", v)
----
.. _class_@GDScript_method_var2bytes: .. _class_@GDScript_method_var2bytes:
- :ref:`PoolByteArray<class_PoolByteArray>` **var2bytes** **(** :ref:`Variant<class_Variant>` var, :ref:`bool<class_bool>` full_objects=false **)** - :ref:`PoolByteArray<class_PoolByteArray>` **var2bytes** **(** :ref:`Variant<class_Variant>` var, :ref:`bool<class_bool>` full_objects=false **)**
Encodes a variable value to a byte array. When ``full_objects`` is ``true`` encoding objects is allowed (and can potentially include code). Encodes a variable value to a byte array. When ``full_objects`` is ``true`` encoding objects is allowed (and can potentially include code).
----
.. _class_@GDScript_method_var2str: .. _class_@GDScript_method_var2str:
- :ref:`String<class_String>` **var2str** **(** :ref:`Variant<class_Variant>` var **)** - :ref:`String<class_String>` **var2str** **(** :ref:`Variant<class_Variant>` var **)**
@@ -1180,6 +1344,8 @@ prints
"b": 2 "b": 2
} }
----
.. _class_@GDScript_method_weakref: .. _class_@GDScript_method_weakref:
- :ref:`WeakRef<class_WeakRef>` **weakref** **(** :ref:`Object<class_Object>` obj **)** - :ref:`WeakRef<class_WeakRef>` **weakref** **(** :ref:`Object<class_Object>` obj **)**
@@ -1188,6 +1354,8 @@ Returns a weak reference to an object.
A weak reference to an object is not enough to keep the object alive: when the only remaining references to a referent are weak references, garbage collection is free to destroy the referent and reuse its memory for something else. However, until the object is actually destroyed the weak reference may return the object even if there are no strong references to it. A weak reference to an object is not enough to keep the object alive: when the only remaining references to a referent are weak references, garbage collection is free to destroy the referent and reuse its memory for something else. However, until the object is actually destroyed the weak reference may return the object even if there are no strong references to it.
----
.. _class_@GDScript_method_wrapf: .. _class_@GDScript_method_wrapf:
- :ref:`float<class_float>` **wrapf** **(** :ref:`float<class_float>` value, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)** - :ref:`float<class_float>` **wrapf** **(** :ref:`float<class_float>` value, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)**
@@ -1225,6 +1393,8 @@ The usage of ``wrapf`` is more flexible than using the :ref:`fmod<class_@GDScrip
# infinite rotation (in radians) # infinite rotation (in radians)
angle = wrapf(angle + 0.1, -PI, PI) angle = wrapf(angle + 0.1, -PI, PI)
----
.. _class_@GDScript_method_wrapi: .. _class_@GDScript_method_wrapi:
- :ref:`int<class_int>` **wrapi** **(** :ref:`int<class_int>` value, :ref:`int<class_int>` min, :ref:`int<class_int>` max **)** - :ref:`int<class_int>` **wrapi** **(** :ref:`int<class_int>` value, :ref:`int<class_int>` min, :ref:`int<class_int>` max **)**
@@ -1257,6 +1427,8 @@ The usage of ``wrapi`` is more flexible than using the modulo approach by giving
# result is -2 # result is -2
var result = wrapi(-6, -5, -1) var result = wrapi(-6, -5, -1)
----
.. _class_@GDScript_method_yield: .. _class_@GDScript_method_yield:
- :ref:`GDScriptFunctionState<class_GDScriptFunctionState>` **yield** **(** :ref:`Object<class_Object>` object=null, :ref:`String<class_String>` signal="" **)** - :ref:`GDScriptFunctionState<class_GDScriptFunctionState>` **yield** **(** :ref:`Object<class_Object>` object=null, :ref:`String<class_String>` signal="" **)**

74
classes/class_@globalscope.rst
View File

@@ -86,6 +86,8 @@ enum **Margin**:
- **MARGIN_BOTTOM** = **3** --- Bottom margin, used usually for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>` derived classes. - **MARGIN_BOTTOM** = **3** --- Bottom margin, used usually for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>` derived classes.
----
.. _enum_@GlobalScope_Corner: .. _enum_@GlobalScope_Corner:
.. _class_@GlobalScope_constant_CORNER_TOP_LEFT: .. _class_@GlobalScope_constant_CORNER_TOP_LEFT:
@@ -106,6 +108,8 @@ enum **Corner**:
- **CORNER_BOTTOM_LEFT** = **3** - **CORNER_BOTTOM_LEFT** = **3**
----
.. _enum_@GlobalScope_Orientation: .. _enum_@GlobalScope_Orientation:
.. _class_@GlobalScope_constant_VERTICAL: .. _class_@GlobalScope_constant_VERTICAL:
@@ -118,6 +122,8 @@ enum **Orientation**:
- **HORIZONTAL** = **0** --- General horizontal alignment, used usually for :ref:`Separator<class_Separator>`, :ref:`ScrollBar<class_ScrollBar>`, :ref:`Slider<class_Slider>`, etc. - **HORIZONTAL** = **0** --- General horizontal alignment, used usually for :ref:`Separator<class_Separator>`, :ref:`ScrollBar<class_ScrollBar>`, :ref:`Slider<class_Slider>`, etc.
----
.. _enum_@GlobalScope_HAlign: .. _enum_@GlobalScope_HAlign:
.. _class_@GlobalScope_constant_HALIGN_LEFT: .. _class_@GlobalScope_constant_HALIGN_LEFT:
@@ -134,6 +140,8 @@ enum **HAlign**:
- **HALIGN_RIGHT** = **2** --- Horizontal right alignment, usually for text-derived classes. - **HALIGN_RIGHT** = **2** --- Horizontal right alignment, usually for text-derived classes.
----
.. _enum_@GlobalScope_VAlign: .. _enum_@GlobalScope_VAlign:
.. _class_@GlobalScope_constant_VALIGN_TOP: .. _class_@GlobalScope_constant_VALIGN_TOP:
@@ -150,6 +158,8 @@ enum **VAlign**:
- **VALIGN_BOTTOM** = **2** --- Vertical bottom alignment, usually for text-derived classes. - **VALIGN_BOTTOM** = **2** --- Vertical bottom alignment, usually for text-derived classes.
----
.. _enum_@GlobalScope_KeyList: .. _enum_@GlobalScope_KeyList:
.. _class_@GlobalScope_constant_KEY_ESCAPE: .. _class_@GlobalScope_constant_KEY_ESCAPE:
@@ -1122,6 +1132,8 @@ enum **KeyList**:
- **KEY_YDIAERESIS** = **255** --- ÿ key - **KEY_YDIAERESIS** = **255** --- ÿ key
----
.. _enum_@GlobalScope_KeyModifierMask: .. _enum_@GlobalScope_KeyModifierMask:
.. _class_@GlobalScope_constant_KEY_CODE_MASK: .. _class_@GlobalScope_constant_KEY_CODE_MASK:
@@ -1162,6 +1174,8 @@ enum **KeyModifierMask**:
- **KEY_MASK_GROUP_SWITCH** = **1073741824** --- Group Switch Key Mask - **KEY_MASK_GROUP_SWITCH** = **1073741824** --- Group Switch Key Mask
----
.. _enum_@GlobalScope_ButtonList: .. _enum_@GlobalScope_ButtonList:
.. _class_@GlobalScope_constant_BUTTON_LEFT: .. _class_@GlobalScope_constant_BUTTON_LEFT:
@@ -1222,6 +1236,8 @@ enum **ButtonList**:
- **BUTTON_MASK_XBUTTON2** = **256** --- Extra Mouse Button 2 Mask - **BUTTON_MASK_XBUTTON2** = **256** --- Extra Mouse Button 2 Mask
----
.. _enum_@GlobalScope_JoystickList: .. _enum_@GlobalScope_JoystickList:
.. _class_@GlobalScope_constant_JOY_BUTTON_0: .. _class_@GlobalScope_constant_JOY_BUTTON_0:
@@ -1458,6 +1474,8 @@ enum **JoystickList**:
- **JOY_ANALOG_R2** = **7** --- Joypad Right Analog Trigger - **JOY_ANALOG_R2** = **7** --- Joypad Right Analog Trigger
----
.. _enum_@GlobalScope_MidiMessageList: .. _enum_@GlobalScope_MidiMessageList:
.. _class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_OFF: .. _class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_OFF:
@@ -1490,6 +1508,8 @@ enum **MidiMessageList**:
- **MIDI_MESSAGE_PITCH_BEND** = **14** --- MIDI pitch bend message. - **MIDI_MESSAGE_PITCH_BEND** = **14** --- MIDI pitch bend message.
----
.. _enum_@GlobalScope_Error: .. _enum_@GlobalScope_Error:
.. _class_@GlobalScope_constant_OK: .. _class_@GlobalScope_constant_OK:
@@ -1701,6 +1721,8 @@ Since :ref:`OK<class_@GlobalScope_constant_OK>` has value 0, and all other failu
- **ERR_PRINTER_ON_FIRE** = **48** --- Printer on fire error. (This is an easter egg, no engine methods return this error code.) - **ERR_PRINTER_ON_FIRE** = **48** --- Printer on fire error. (This is an easter egg, no engine methods return this error code.)
----
.. _enum_@GlobalScope_PropertyHint: .. _enum_@GlobalScope_PropertyHint:
.. _class_@GlobalScope_constant_PROPERTY_HINT_NONE: .. _class_@GlobalScope_constant_PROPERTY_HINT_NONE:
@@ -1751,9 +1773,9 @@ enum **PropertyHint**:
- **PROPERTY_HINT_NONE** = **0** --- No hint for edited property. - **PROPERTY_HINT_NONE** = **0** --- No hint for edited property.
- **PROPERTY_HINT_RANGE** = **1** --- Hints that an integer or float property should be within a range specified via the hint string ``"min,max"`` or ``"min,max,step"``. The hint string can optionally include ``"allow_greater"`` and/or ``"allow_lesser"`` to allow manual input going respectively above the max or below the min values. Example: ``"-360,360,1,allow_greater,allow_lesser"``. - **PROPERTY_HINT_RANGE** = **1** --- Hints that an integer or float property should be within a range specified via the hint string ``"min,max"`` or ``"min,max,step"``. The hint string can optionally include ``"or_greater"`` and/or ``"or_lesser"`` to allow manual input going respectively above the max or below the min values. Example: ``"-360,360,1,or_greater,or_lesser"``.
- **PROPERTY_HINT_EXP_RANGE** = **2** --- Hints that an integer or float property should be within an exponential range specified via the hint string ``"min,max"`` or ``"min,max,step"``. The hint string can optionally include ``"allow_greater"`` and/or ``"allow_lesser"`` to allow manual input going respectively above the max or below the min values. Example: ``"0.01,100,0.01,allow_greater"``. - **PROPERTY_HINT_EXP_RANGE** = **2** --- Hints that an integer or float property should be within an exponential range specified via the hint string ``"min,max"`` or ``"min,max,step"``. The hint string can optionally include ``"or_greater"`` and/or ``"or_lesser"`` to allow manual input going respectively above the max or below the min values. Example: ``"0.01,100,0.01,or_greater"``.
- **PROPERTY_HINT_ENUM** = **3** --- Hints that an integer, float or string property is an enumerated value to pick in a list specified via a hint string such as ``"Hello,Something,Else"``. - **PROPERTY_HINT_ENUM** = **3** --- Hints that an integer, float or string property is an enumerated value to pick in a list specified via a hint string such as ``"Hello,Something,Else"``.
@@ -1793,6 +1815,8 @@ enum **PropertyHint**:
- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **22** --- Hints that an image is compressed using lossless compression. - **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **22** --- Hints that an image is compressed using lossless compression.
----
.. _enum_@GlobalScope_PropertyUsageFlags: .. _enum_@GlobalScope_PropertyUsageFlags:
.. _class_@GlobalScope_constant_PROPERTY_USAGE_STORAGE: .. _class_@GlobalScope_constant_PROPERTY_USAGE_STORAGE:
@@ -1857,6 +1881,8 @@ enum **PropertyUsageFlags**:
- **PROPERTY_USAGE_NOEDITOR** = **5** --- Default usage but without showing the property in the editor (storage, network). - **PROPERTY_USAGE_NOEDITOR** = **5** --- Default usage but without showing the property in the editor (storage, network).
----
.. _enum_@GlobalScope_MethodFlags: .. _enum_@GlobalScope_MethodFlags:
.. _class_@GlobalScope_constant_METHOD_FLAG_NORMAL: .. _class_@GlobalScope_constant_METHOD_FLAG_NORMAL:
@@ -1893,6 +1919,8 @@ enum **MethodFlags**:
- **METHOD_FLAGS_DEFAULT** = **1** --- Default method flags - **METHOD_FLAGS_DEFAULT** = **1** --- Default method flags
----
.. _enum_@GlobalScope_Variant.Type: .. _enum_@GlobalScope_Variant.Type:
.. _class_@GlobalScope_constant_TYPE_NIL: .. _class_@GlobalScope_constant_TYPE_NIL:
@@ -2009,6 +2037,8 @@ enum **Variant.Type**:
- **TYPE_MAX** = **27** --- Represents the size of the :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` enum. - **TYPE_MAX** = **27** --- Represents the size of the :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` enum.
----
.. _enum_@GlobalScope_Variant.Operator: .. _enum_@GlobalScope_Variant.Operator:
.. _class_@GlobalScope_constant_OP_EQUAL: .. _class_@GlobalScope_constant_OP_EQUAL:
@@ -2140,120 +2170,160 @@ Property Descriptions
:ref:`ARVRServer<class_ARVRServer>` singleton :ref:`ARVRServer<class_ARVRServer>` singleton
----
.. _class_@GlobalScope_property_AudioServer: .. _class_@GlobalScope_property_AudioServer:
- :ref:`AudioServer<class_AudioServer>` **AudioServer** - :ref:`AudioServer<class_AudioServer>` **AudioServer**
:ref:`AudioServer<class_AudioServer>` singleton :ref:`AudioServer<class_AudioServer>` singleton
----
.. _class_@GlobalScope_property_ClassDB: .. _class_@GlobalScope_property_ClassDB:
- :ref:`ClassDB<class_ClassDB>` **ClassDB** - :ref:`ClassDB<class_ClassDB>` **ClassDB**
:ref:`ClassDB<class_ClassDB>` singleton :ref:`ClassDB<class_ClassDB>` singleton
----
.. _class_@GlobalScope_property_Engine: .. _class_@GlobalScope_property_Engine:
- :ref:`Engine<class_Engine>` **Engine** - :ref:`Engine<class_Engine>` **Engine**
:ref:`Engine<class_Engine>` singleton :ref:`Engine<class_Engine>` singleton
----
.. _class_@GlobalScope_property_Geometry: .. _class_@GlobalScope_property_Geometry:
- :ref:`Geometry<class_Geometry>` **Geometry** - :ref:`Geometry<class_Geometry>` **Geometry**
:ref:`Geometry<class_Geometry>` singleton :ref:`Geometry<class_Geometry>` singleton
----
.. _class_@GlobalScope_property_IP: .. _class_@GlobalScope_property_IP:
- :ref:`IP<class_IP>` **IP** - :ref:`IP<class_IP>` **IP**
:ref:`IP<class_IP>` singleton :ref:`IP<class_IP>` singleton
----
.. _class_@GlobalScope_property_Input: .. _class_@GlobalScope_property_Input:
- :ref:`Input<class_Input>` **Input** - :ref:`Input<class_Input>` **Input**
:ref:`Input<class_Input>` singleton :ref:`Input<class_Input>` singleton
----
.. _class_@GlobalScope_property_InputMap: .. _class_@GlobalScope_property_InputMap:
- :ref:`InputMap<class_InputMap>` **InputMap** - :ref:`InputMap<class_InputMap>` **InputMap**
:ref:`InputMap<class_InputMap>` singleton :ref:`InputMap<class_InputMap>` singleton
----
.. _class_@GlobalScope_property_JSON: .. _class_@GlobalScope_property_JSON:
- :ref:`JSON<class_JSON>` **JSON** - :ref:`JSON<class_JSON>` **JSON**
:ref:`JSON<class_JSON>` singleton :ref:`JSON<class_JSON>` singleton
----
.. _class_@GlobalScope_property_JavaScript: .. _class_@GlobalScope_property_JavaScript:
- :ref:`JavaScript<class_JavaScript>` **JavaScript** - :ref:`JavaScript<class_JavaScript>` **JavaScript**
:ref:`JavaScript<class_JavaScript>` singleton :ref:`JavaScript<class_JavaScript>` singleton
----
.. _class_@GlobalScope_property_Marshalls: .. _class_@GlobalScope_property_Marshalls:
- :ref:`Reference<class_Reference>` **Marshalls** - :ref:`Reference<class_Reference>` **Marshalls**
:ref:`Marshalls<class_Marshalls>` singleton :ref:`Marshalls<class_Marshalls>` singleton
----
.. _class_@GlobalScope_property_OS: .. _class_@GlobalScope_property_OS:
- :ref:`OS<class_OS>` **OS** - :ref:`OS<class_OS>` **OS**
:ref:`OS<class_OS>` singleton :ref:`OS<class_OS>` singleton
----
.. _class_@GlobalScope_property_Performance: .. _class_@GlobalScope_property_Performance:
- :ref:`Performance<class_Performance>` **Performance** - :ref:`Performance<class_Performance>` **Performance**
:ref:`Performance<class_Performance>` singleton :ref:`Performance<class_Performance>` singleton
----
.. _class_@GlobalScope_property_Physics2DServer: .. _class_@GlobalScope_property_Physics2DServer:
- :ref:`Physics2DServer<class_Physics2DServer>` **Physics2DServer** - :ref:`Physics2DServer<class_Physics2DServer>` **Physics2DServer**
:ref:`Physics2DServer<class_Physics2DServer>` singleton :ref:`Physics2DServer<class_Physics2DServer>` singleton
----
.. _class_@GlobalScope_property_PhysicsServer: .. _class_@GlobalScope_property_PhysicsServer:
- :ref:`PhysicsServer<class_PhysicsServer>` **PhysicsServer** - :ref:`PhysicsServer<class_PhysicsServer>` **PhysicsServer**
:ref:`PhysicsServer<class_PhysicsServer>` singleton :ref:`PhysicsServer<class_PhysicsServer>` singleton
----
.. _class_@GlobalScope_property_ProjectSettings: .. _class_@GlobalScope_property_ProjectSettings:
- :ref:`ProjectSettings<class_ProjectSettings>` **ProjectSettings** - :ref:`ProjectSettings<class_ProjectSettings>` **ProjectSettings**
:ref:`ProjectSettings<class_ProjectSettings>` singleton :ref:`ProjectSettings<class_ProjectSettings>` singleton
----
.. _class_@GlobalScope_property_ResourceLoader: .. _class_@GlobalScope_property_ResourceLoader:
- :ref:`ResourceLoader<class_ResourceLoader>` **ResourceLoader** - :ref:`ResourceLoader<class_ResourceLoader>` **ResourceLoader**
:ref:`ResourceLoader<class_ResourceLoader>` singleton :ref:`ResourceLoader<class_ResourceLoader>` singleton
----
.. _class_@GlobalScope_property_ResourceSaver: .. _class_@GlobalScope_property_ResourceSaver:
- :ref:`ResourceSaver<class_ResourceSaver>` **ResourceSaver** - :ref:`ResourceSaver<class_ResourceSaver>` **ResourceSaver**
:ref:`ResourceSaver<class_ResourceSaver>` singleton :ref:`ResourceSaver<class_ResourceSaver>` singleton
----
.. _class_@GlobalScope_property_TranslationServer: .. _class_@GlobalScope_property_TranslationServer:
- :ref:`TranslationServer<class_TranslationServer>` **TranslationServer** - :ref:`TranslationServer<class_TranslationServer>` **TranslationServer**
:ref:`TranslationServer<class_TranslationServer>` singleton :ref:`TranslationServer<class_TranslationServer>` singleton
----
.. _class_@GlobalScope_property_VisualScriptEditor: .. _class_@GlobalScope_property_VisualScriptEditor:
- :ref:`VisualScriptEditor<class_VisualScriptEditor>` **VisualScriptEditor** - :ref:`VisualScriptEditor<class_VisualScriptEditor>` **VisualScriptEditor**
:ref:`VisualScriptEditor<class_VisualScriptEditor>` singleton :ref:`VisualScriptEditor<class_VisualScriptEditor>` singleton
----
.. _class_@GlobalScope_property_VisualServer: .. _class_@GlobalScope_property_VisualServer:
- :ref:`VisualServer<class_VisualServer>` **VisualServer** - :ref:`VisualServer<class_VisualServer>` **VisualServer**

44
classes/class_aabb.rst
View File

@@ -93,12 +93,16 @@ Property Descriptions
Ending corner. Ending corner.
----
.. _class_AABB_property_position: .. _class_AABB_property_position:
- :ref:`Vector3<class_Vector3>` **position** - :ref:`Vector3<class_Vector3>` **position**
Beginning corner. Beginning corner.
----
.. _class_AABB_property_size: .. _class_AABB_property_size:
- :ref:`Vector3<class_Vector3>` **size** - :ref:`Vector3<class_Vector3>` **size**
@@ -114,120 +118,160 @@ Method Descriptions
Optional constructor, accepts position and size. Optional constructor, accepts position and size.
----
.. _class_AABB_method_encloses: .. _class_AABB_method_encloses:
- :ref:`bool<class_bool>` **encloses** **(** :ref:`AABB<class_AABB>` with **)** - :ref:`bool<class_bool>` **encloses** **(** :ref:`AABB<class_AABB>` with **)**
Returns ``true`` if this ``AABB`` completely encloses another one. Returns ``true`` if this ``AABB`` completely encloses another one.
----
.. _class_AABB_method_expand: .. _class_AABB_method_expand:
- :ref:`AABB<class_AABB>` **expand** **(** :ref:`Vector3<class_Vector3>` to_point **)** - :ref:`AABB<class_AABB>` **expand** **(** :ref:`Vector3<class_Vector3>` to_point **)**
Returns this ``AABB`` expanded to include a given point. Returns this ``AABB`` expanded to include a given point.
----
.. _class_AABB_method_get_area: .. _class_AABB_method_get_area:
- :ref:`float<class_float>` **get_area** **(** **)** - :ref:`float<class_float>` **get_area** **(** **)**
Gets the area of the ``AABB``. Gets the area of the ``AABB``.
----
.. _class_AABB_method_get_endpoint: .. _class_AABB_method_get_endpoint:
- :ref:`Vector3<class_Vector3>` **get_endpoint** **(** :ref:`int<class_int>` idx **)** - :ref:`Vector3<class_Vector3>` **get_endpoint** **(** :ref:`int<class_int>` idx **)**
Gets the position of the 8 endpoints of the ``AABB`` in space. Gets the position of the 8 endpoints of the ``AABB`` in space.
----
.. _class_AABB_method_get_longest_axis: .. _class_AABB_method_get_longest_axis:
- :ref:`Vector3<class_Vector3>` **get_longest_axis** **(** **)** - :ref:`Vector3<class_Vector3>` **get_longest_axis** **(** **)**
Returns the normalized longest axis of the ``AABB``. Returns the normalized longest axis of the ``AABB``.
----
.. _class_AABB_method_get_longest_axis_index: .. _class_AABB_method_get_longest_axis_index:
- :ref:`int<class_int>` **get_longest_axis_index** **(** **)** - :ref:`int<class_int>` **get_longest_axis_index** **(** **)**
Returns the index of the longest axis of the ``AABB`` (according to :ref:`Vector3<class_Vector3>`::AXIS\* enum). Returns the index of the longest axis of the ``AABB`` (according to :ref:`Vector3<class_Vector3>`::AXIS\* enum).
----
.. _class_AABB_method_get_longest_axis_size: .. _class_AABB_method_get_longest_axis_size:
- :ref:`float<class_float>` **get_longest_axis_size** **(** **)** - :ref:`float<class_float>` **get_longest_axis_size** **(** **)**
Returns the scalar length of the longest axis of the ``AABB``. Returns the scalar length of the longest axis of the ``AABB``.
----
.. _class_AABB_method_get_shortest_axis: .. _class_AABB_method_get_shortest_axis:
- :ref:`Vector3<class_Vector3>` **get_shortest_axis** **(** **)** - :ref:`Vector3<class_Vector3>` **get_shortest_axis** **(** **)**
Returns the normalized shortest axis of the ``AABB``. Returns the normalized shortest axis of the ``AABB``.
----
.. _class_AABB_method_get_shortest_axis_index: .. _class_AABB_method_get_shortest_axis_index:
- :ref:`int<class_int>` **get_shortest_axis_index** **(** **)** - :ref:`int<class_int>` **get_shortest_axis_index** **(** **)**
Returns the index of the shortest axis of the ``AABB`` (according to :ref:`Vector3<class_Vector3>`::AXIS\* enum). Returns the index of the shortest axis of the ``AABB`` (according to :ref:`Vector3<class_Vector3>`::AXIS\* enum).
----
.. _class_AABB_method_get_shortest_axis_size: .. _class_AABB_method_get_shortest_axis_size:
- :ref:`float<class_float>` **get_shortest_axis_size** **(** **)** - :ref:`float<class_float>` **get_shortest_axis_size** **(** **)**
Returns the scalar length of the shortest axis of the ``AABB``. Returns the scalar length of the shortest axis of the ``AABB``.
----
.. _class_AABB_method_get_support: .. _class_AABB_method_get_support:
- :ref:`Vector3<class_Vector3>` **get_support** **(** :ref:`Vector3<class_Vector3>` dir **)** - :ref:`Vector3<class_Vector3>` **get_support** **(** :ref:`Vector3<class_Vector3>` dir **)**
Returns the support point in a given direction. This is useful for collision detection algorithms. Returns the support point in a given direction. This is useful for collision detection algorithms.
----
.. _class_AABB_method_grow: .. _class_AABB_method_grow:
- :ref:`AABB<class_AABB>` **grow** **(** :ref:`float<class_float>` by **)** - :ref:`AABB<class_AABB>` **grow** **(** :ref:`float<class_float>` by **)**
Returns a copy of the ``AABB`` grown a given amount of units towards all the sides. Returns a copy of the ``AABB`` grown a given amount of units towards all the sides.
----
.. _class_AABB_method_has_no_area: .. _class_AABB_method_has_no_area:
- :ref:`bool<class_bool>` **has_no_area** **(** **)** - :ref:`bool<class_bool>` **has_no_area** **(** **)**
Returns ``true`` if the ``AABB`` is flat or empty. Returns ``true`` if the ``AABB`` is flat or empty.
----
.. _class_AABB_method_has_no_surface: .. _class_AABB_method_has_no_surface:
- :ref:`bool<class_bool>` **has_no_surface** **(** **)** - :ref:`bool<class_bool>` **has_no_surface** **(** **)**
Returns ``true`` if the ``AABB`` is empty. Returns ``true`` if the ``AABB`` is empty.
----
.. _class_AABB_method_has_point: .. _class_AABB_method_has_point:
- :ref:`bool<class_bool>` **has_point** **(** :ref:`Vector3<class_Vector3>` point **)** - :ref:`bool<class_bool>` **has_point** **(** :ref:`Vector3<class_Vector3>` point **)**
Returns ``true`` if the ``AABB`` contains a point. Returns ``true`` if the ``AABB`` contains a point.
----
.. _class_AABB_method_intersection: .. _class_AABB_method_intersection:
- :ref:`AABB<class_AABB>` **intersection** **(** :ref:`AABB<class_AABB>` with **)** - :ref:`AABB<class_AABB>` **intersection** **(** :ref:`AABB<class_AABB>` with **)**
Returns the intersection between two ``AABB``. An empty AABB (size 0,0,0) is returned on failure. Returns the intersection between two ``AABB``. An empty AABB (size 0,0,0) is returned on failure.
----
.. _class_AABB_method_intersects: .. _class_AABB_method_intersects:
- :ref:`bool<class_bool>` **intersects** **(** :ref:`AABB<class_AABB>` with **)** - :ref:`bool<class_bool>` **intersects** **(** :ref:`AABB<class_AABB>` with **)**
Returns ``true`` if the ``AABB`` overlaps with another. Returns ``true`` if the ``AABB`` overlaps with another.
----
.. _class_AABB_method_intersects_plane: .. _class_AABB_method_intersects_plane:
- :ref:`bool<class_bool>` **intersects_plane** **(** :ref:`Plane<class_Plane>` plane **)** - :ref:`bool<class_bool>` **intersects_plane** **(** :ref:`Plane<class_Plane>` plane **)**
Returns ``true`` if the ``AABB`` is on both sides of a plane. Returns ``true`` if the ``AABB`` is on both sides of a plane.
----
.. _class_AABB_method_intersects_segment: .. _class_AABB_method_intersects_segment:
- :ref:`bool<class_bool>` **intersects_segment** **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` to **)** - :ref:`bool<class_bool>` **intersects_segment** **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` to **)**
Returns ``true`` if the ``AABB`` intersects the line segment between ``from`` and ``to``. Returns ``true`` if the ``AABB`` intersects the line segment between ``from`` and ``to``.
----
.. _class_AABB_method_merge: .. _class_AABB_method_merge:
- :ref:`AABB<class_AABB>` **merge** **(** :ref:`AABB<class_AABB>` with **)** - :ref:`AABB<class_AABB>` **merge** **(** :ref:`AABB<class_AABB>` with **)**

12
classes/class_acceptdialog.rst
View File

@@ -53,6 +53,8 @@ Signals
Emitted when the dialog is accepted, i.e. the OK button is pressed. Emitted when the dialog is accepted, i.e. the OK button is pressed.
----
.. _class_AcceptDialog_signal_custom_action: .. _class_AcceptDialog_signal_custom_action:
- **custom_action** **(** :ref:`String<class_String>` action **)** - **custom_action** **(** :ref:`String<class_String>` action **)**
@@ -81,6 +83,8 @@ If ``true``, the dialog is hidden when the OK button is pressed. You can set it
Note: Some nodes derived from this class can have a different default value, and potentially their own built-in logic overriding this setting. For example :ref:`FileDialog<class_FileDialog>` defaults to ``false``, and has its own input validation code that is called when you press OK, which eventually hides the dialog if the input is valid. As such this property can't be used in :ref:`FileDialog<class_FileDialog>` to disable hiding the dialog when pressing OK. Note: Some nodes derived from this class can have a different default value, and potentially their own built-in logic overriding this setting. For example :ref:`FileDialog<class_FileDialog>` defaults to ``false``, and has its own input validation code that is called when you press OK, which eventually hides the dialog if the input is valid. As such this property can't be used in :ref:`FileDialog<class_FileDialog>` to disable hiding the dialog when pressing OK.
----
.. _class_AcceptDialog_property_dialog_text: .. _class_AcceptDialog_property_dialog_text:
- :ref:`String<class_String>` **dialog_text** - :ref:`String<class_String>` **dialog_text**
@@ -104,24 +108,32 @@ Adds a button with label *text* and a custom *action* to the dialog and returns
If ``true``, *right* will place the button to the right of any sibling buttons. Default value: ``false``. If ``true``, *right* will place the button to the right of any sibling buttons. Default value: ``false``.
----
.. _class_AcceptDialog_method_add_cancel: .. _class_AcceptDialog_method_add_cancel:
- :ref:`Button<class_Button>` **add_cancel** **(** :ref:`String<class_String>` name **)** - :ref:`Button<class_Button>` **add_cancel** **(** :ref:`String<class_String>` name **)**
Adds a button with label *name* and a cancel action to the dialog and returns the created button. Adds a button with label *name* and a cancel action to the dialog and returns the created button.
----
.. _class_AcceptDialog_method_get_label: .. _class_AcceptDialog_method_get_label:
- :ref:`Label<class_Label>` **get_label** **(** **)** - :ref:`Label<class_Label>` **get_label** **(** **)**
Returns the label used for built-in text. Returns the label used for built-in text.
----
.. _class_AcceptDialog_method_get_ok: .. _class_AcceptDialog_method_get_ok:
- :ref:`Button<class_Button>` **get_ok** **(** **)** - :ref:`Button<class_Button>` **get_ok** **(** **)**
Returns the OK Button. Returns the OK Button.
----
.. _class_AcceptDialog_method_register_text_enter: .. _class_AcceptDialog_method_register_text_enter:
- void **register_text_enter** **(** :ref:`Node<class_Node>` line_edit **)** - void **register_text_enter** **(** :ref:`Node<class_Node>` line_edit **)**

22
classes/class_animatedsprite.rst
View File

@@ -61,6 +61,8 @@ Signals
Emitted when the animation is finished (when it plays the last frame). If the animation is looping, this signal is emitted every time the last frame is drawn. Emitted when the animation is finished (when it plays the last frame). If the animation is looping, this signal is emitted every time the last frame is drawn.
----
.. _class_AnimatedSprite_signal_frame_changed: .. _class_AnimatedSprite_signal_frame_changed:
- **frame_changed** **(** **)** - **frame_changed** **(** **)**
@@ -87,6 +89,8 @@ Property Descriptions
The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset. The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset.
----
.. _class_AnimatedSprite_property_centered: .. _class_AnimatedSprite_property_centered:
- :ref:`bool<class_bool>` **centered** - :ref:`bool<class_bool>` **centered**
@@ -99,6 +103,8 @@ The current animation from the ``frames`` resource. If this value changes, the `
If ``true``, texture will be centered. Default value: ``true``. If ``true``, texture will be centered. Default value: ``true``.
----
.. _class_AnimatedSprite_property_flip_h: .. _class_AnimatedSprite_property_flip_h:
- :ref:`bool<class_bool>` **flip_h** - :ref:`bool<class_bool>` **flip_h**
@@ -111,6 +117,8 @@ If ``true``, texture will be centered. Default value: ``true``.
If ``true``, texture is flipped horizontally. Default value: ``false``. If ``true``, texture is flipped horizontally. Default value: ``false``.
----
.. _class_AnimatedSprite_property_flip_v: .. _class_AnimatedSprite_property_flip_v:
- :ref:`bool<class_bool>` **flip_v** - :ref:`bool<class_bool>` **flip_v**
@@ -123,6 +131,8 @@ If ``true``, texture is flipped horizontally. Default value: ``false``.
If ``true``, texture is flipped vertically. Default value: ``false``. If ``true``, texture is flipped vertically. Default value: ``false``.
----
.. _class_AnimatedSprite_property_frame: .. _class_AnimatedSprite_property_frame:
- :ref:`int<class_int>` **frame** - :ref:`int<class_int>` **frame**
@@ -135,6 +145,8 @@ If ``true``, texture is flipped vertically. Default value: ``false``.
The displayed animation frame's index. The displayed animation frame's index.
----
.. _class_AnimatedSprite_property_frames: .. _class_AnimatedSprite_property_frames:
- :ref:`SpriteFrames<class_SpriteFrames>` **frames** - :ref:`SpriteFrames<class_SpriteFrames>` **frames**
@@ -147,6 +159,8 @@ The displayed animation frame's index.
The :ref:`SpriteFrames<class_SpriteFrames>` resource containing the animation(s). The :ref:`SpriteFrames<class_SpriteFrames>` resource containing the animation(s).
----
.. _class_AnimatedSprite_property_offset: .. _class_AnimatedSprite_property_offset:
- :ref:`Vector2<class_Vector2>` **offset** - :ref:`Vector2<class_Vector2>` **offset**
@@ -159,12 +173,16 @@ The :ref:`SpriteFrames<class_SpriteFrames>` resource containing the animation(s)
The texture's drawing offset. The texture's drawing offset.
----
.. _class_AnimatedSprite_property_playing: .. _class_AnimatedSprite_property_playing:
- :ref:`bool<class_bool>` **playing** - :ref:`bool<class_bool>` **playing**
If ``true``, the :ref:`animation<class_AnimatedSprite_property_animation>` is currently playing. If ``true``, the :ref:`animation<class_AnimatedSprite_property_animation>` is currently playing.
----
.. _class_AnimatedSprite_property_speed_scale: .. _class_AnimatedSprite_property_speed_scale:
- :ref:`float<class_float>` **speed_scale** - :ref:`float<class_float>` **speed_scale**
@@ -186,12 +204,16 @@ Method Descriptions
Returns ``true`` if an animation if currently being played. Returns ``true`` if an animation if currently being played.
----
.. _class_AnimatedSprite_method_play: .. _class_AnimatedSprite_method_play:
- void **play** **(** :ref:`String<class_String>` anim="", :ref:`bool<class_bool>` backwards=false **)** - void **play** **(** :ref:`String<class_String>` anim="", :ref:`bool<class_bool>` backwards=false **)**
Play the animation set in parameter. If no parameter is provided, the current animation is played. Property ``backwards`` plays the animation in reverse if set to ``true``. Play the animation set in parameter. If no parameter is provided, the current animation is played. Property ``backwards`` plays the animation in reverse if set to ``true``.
----
.. _class_AnimatedSprite_method_stop: .. _class_AnimatedSprite_method_stop:
- void **stop** **(** **)** - void **stop** **(** **)**

10
classes/class_animatedsprite3d.rst
View File

@@ -71,6 +71,8 @@ Property Descriptions
The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset. The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset.
----
.. _class_AnimatedSprite3D_property_frame: .. _class_AnimatedSprite3D_property_frame:
- :ref:`int<class_int>` **frame** - :ref:`int<class_int>` **frame**
@@ -83,6 +85,8 @@ The current animation from the ``frames`` resource. If this value changes, the `
The displayed animation frame's index. The displayed animation frame's index.
----
.. _class_AnimatedSprite3D_property_frames: .. _class_AnimatedSprite3D_property_frames:
- :ref:`SpriteFrames<class_SpriteFrames>` **frames** - :ref:`SpriteFrames<class_SpriteFrames>` **frames**
@@ -95,6 +99,8 @@ The displayed animation frame's index.
The :ref:`SpriteFrames<class_SpriteFrames>` resource containing the animation(s). The :ref:`SpriteFrames<class_SpriteFrames>` resource containing the animation(s).
----
.. _class_AnimatedSprite3D_property_playing: .. _class_AnimatedSprite3D_property_playing:
- :ref:`bool<class_bool>` **playing** - :ref:`bool<class_bool>` **playing**
@@ -110,12 +116,16 @@ Method Descriptions
Returns ``true`` if an animation if currently being played. Returns ``true`` if an animation if currently being played.
----
.. _class_AnimatedSprite3D_method_play: .. _class_AnimatedSprite3D_method_play:
- void **play** **(** :ref:`String<class_String>` anim="" **)** - void **play** **(** :ref:`String<class_String>` anim="" **)**
Play the animation set in parameter. If no parameter is provided, the current animation is played. Play the animation set in parameter. If no parameter is provided, the current animation is played.
----
.. _class_AnimatedSprite3D_method_stop: .. _class_AnimatedSprite3D_method_stop:
- void **stop** **(** **)** - void **stop** **(** **)**

8
classes/class_animatedtexture.rst
View File

@@ -73,6 +73,8 @@ Animation speed in frames per second. This value defines the default time interv
For example, an animation with 8 frames, no frame delay and a ``fps`` value of 2 will run for 4 seconds, with each frame lasting 0.5 seconds. For example, an animation with 8 frames, no frame delay and a ``fps`` value of 2 will run for 4 seconds, with each frame lasting 0.5 seconds.
----
.. _class_AnimatedTexture_property_frames: .. _class_AnimatedTexture_property_frames:
- :ref:`int<class_int>` **frames** - :ref:`int<class_int>` **frames**
@@ -94,12 +96,16 @@ Method Descriptions
Returns the given frame's delay value. Returns the given frame's delay value.
----
.. _class_AnimatedTexture_method_get_frame_texture: .. _class_AnimatedTexture_method_get_frame_texture:
- :ref:`Texture<class_Texture>` **get_frame_texture** **(** :ref:`int<class_int>` frame **)** const - :ref:`Texture<class_Texture>` **get_frame_texture** **(** :ref:`int<class_int>` frame **)** const
Returns the given frame's :ref:`Texture<class_Texture>`. Returns the given frame's :ref:`Texture<class_Texture>`.
----
.. _class_AnimatedTexture_method_set_frame_delay: .. _class_AnimatedTexture_method_set_frame_delay:
- void **set_frame_delay** **(** :ref:`int<class_int>` frame, :ref:`float<class_float>` delay **)** - void **set_frame_delay** **(** :ref:`int<class_int>` frame, :ref:`float<class_float>` delay **)**
@@ -115,6 +121,8 @@ For example, for an animation with 3 frames, 2 FPS and a frame delay on the seco
Frame 2: 0.5 s (1 / fps) Frame 2: 0.5 s (1 / fps)
Total duration: 2.7 s Total duration: 2.7 s
----
.. _class_AnimatedTexture_method_set_frame_texture: .. _class_AnimatedTexture_method_set_frame_texture:
- void **set_frame_texture** **(** :ref:`int<class_int>` frame, :ref:`Texture<class_Texture>` texture **)** - void **set_frame_texture** **(** :ref:`int<class_int>` frame, :ref:`Texture<class_Texture>` texture **)**

118
classes/class_animation.rst
View File

@@ -184,6 +184,8 @@ enum **TrackType**:
- **TYPE_ANIMATION** = **5** - **TYPE_ANIMATION** = **5**
----
.. _enum_Animation_InterpolationType: .. _enum_Animation_InterpolationType:
.. _class_Animation_constant_INTERPOLATION_NEAREST: .. _class_Animation_constant_INTERPOLATION_NEAREST:
@@ -200,6 +202,8 @@ enum **InterpolationType**:
- **INTERPOLATION_CUBIC** = **2** --- Cubic interpolation. - **INTERPOLATION_CUBIC** = **2** --- Cubic interpolation.
----
.. _enum_Animation_UpdateMode: .. _enum_Animation_UpdateMode:
.. _class_Animation_constant_UPDATE_CONTINUOUS: .. _class_Animation_constant_UPDATE_CONTINUOUS:
@@ -257,6 +261,8 @@ Property Descriptions
The total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping. The total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.
----
.. _class_Animation_property_loop: .. _class_Animation_property_loop:
- :ref:`bool<class_bool>` **loop** - :ref:`bool<class_bool>` **loop**
@@ -269,6 +275,8 @@ The total length of the animation (in seconds). Note that length is not delimite
A flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation. A flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.
----
.. _class_Animation_property_step: .. _class_Animation_property_step:
- :ref:`float<class_float>` **step** - :ref:`float<class_float>` **step**
@@ -290,258 +298,356 @@ Method Descriptions
Add a track to the Animation. The track type must be specified as any of the values in the TYPE\_\* enumeration. Add a track to the Animation. The track type must be specified as any of the values in the TYPE\_\* enumeration.
----
.. _class_Animation_method_animation_track_get_key_animation: .. _class_Animation_method_animation_track_get_key_animation:
- :ref:`String<class_String>` **animation_track_get_key_animation** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const - :ref:`String<class_String>` **animation_track_get_key_animation** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
----
.. _class_Animation_method_animation_track_insert_key: .. _class_Animation_method_animation_track_insert_key:
- :ref:`int<class_int>` **animation_track_insert_key** **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time, :ref:`String<class_String>` animation **)** - :ref:`int<class_int>` **animation_track_insert_key** **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time, :ref:`String<class_String>` animation **)**
----
.. _class_Animation_method_animation_track_set_key_animation: .. _class_Animation_method_animation_track_set_key_animation:
- void **animation_track_set_key_animation** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`String<class_String>` animation **)** - void **animation_track_set_key_animation** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`String<class_String>` animation **)**
----
.. _class_Animation_method_audio_track_get_key_end_offset: .. _class_Animation_method_audio_track_get_key_end_offset:
- :ref:`float<class_float>` **audio_track_get_key_end_offset** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const - :ref:`float<class_float>` **audio_track_get_key_end_offset** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
----
.. _class_Animation_method_audio_track_get_key_start_offset: .. _class_Animation_method_audio_track_get_key_start_offset:
- :ref:`float<class_float>` **audio_track_get_key_start_offset** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const - :ref:`float<class_float>` **audio_track_get_key_start_offset** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
----
.. _class_Animation_method_audio_track_get_key_stream: .. _class_Animation_method_audio_track_get_key_stream:
- :ref:`Resource<class_Resource>` **audio_track_get_key_stream** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const - :ref:`Resource<class_Resource>` **audio_track_get_key_stream** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
----
.. _class_Animation_method_audio_track_insert_key: .. _class_Animation_method_audio_track_insert_key:
- :ref:`int<class_int>` **audio_track_insert_key** **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time, :ref:`Resource<class_Resource>` stream, :ref:`float<class_float>` start_offset=0, :ref:`float<class_float>` end_offset=0 **)** - :ref:`int<class_int>` **audio_track_insert_key** **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time, :ref:`Resource<class_Resource>` stream, :ref:`float<class_float>` start_offset=0, :ref:`float<class_float>` end_offset=0 **)**
----
.. _class_Animation_method_audio_track_set_key_end_offset: .. _class_Animation_method_audio_track_set_key_end_offset:
- void **audio_track_set_key_end_offset** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` offset **)** - void **audio_track_set_key_end_offset** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` offset **)**
----
.. _class_Animation_method_audio_track_set_key_start_offset: .. _class_Animation_method_audio_track_set_key_start_offset:
- void **audio_track_set_key_start_offset** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` offset **)** - void **audio_track_set_key_start_offset** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` offset **)**
----
.. _class_Animation_method_audio_track_set_key_stream: .. _class_Animation_method_audio_track_set_key_stream:
- void **audio_track_set_key_stream** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`Resource<class_Resource>` stream **)** - void **audio_track_set_key_stream** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`Resource<class_Resource>` stream **)**
----
.. _class_Animation_method_bezier_track_get_key_in_handle: .. _class_Animation_method_bezier_track_get_key_in_handle:
- :ref:`Vector2<class_Vector2>` **bezier_track_get_key_in_handle** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const - :ref:`Vector2<class_Vector2>` **bezier_track_get_key_in_handle** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
----
.. _class_Animation_method_bezier_track_get_key_out_handle: .. _class_Animation_method_bezier_track_get_key_out_handle:
- :ref:`Vector2<class_Vector2>` **bezier_track_get_key_out_handle** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const - :ref:`Vector2<class_Vector2>` **bezier_track_get_key_out_handle** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
----
.. _class_Animation_method_bezier_track_get_key_value: .. _class_Animation_method_bezier_track_get_key_value:
- :ref:`float<class_float>` **bezier_track_get_key_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const - :ref:`float<class_float>` **bezier_track_get_key_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
----
.. _class_Animation_method_bezier_track_insert_key: .. _class_Animation_method_bezier_track_insert_key:
- :ref:`int<class_int>` **bezier_track_insert_key** **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time, :ref:`float<class_float>` value, :ref:`Vector2<class_Vector2>` in_handle=Vector2( 0, 0 ), :ref:`Vector2<class_Vector2>` out_handle=Vector2( 0, 0 ) **)** - :ref:`int<class_int>` **bezier_track_insert_key** **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time, :ref:`float<class_float>` value, :ref:`Vector2<class_Vector2>` in_handle=Vector2( 0, 0 ), :ref:`Vector2<class_Vector2>` out_handle=Vector2( 0, 0 ) **)**
----
.. _class_Animation_method_bezier_track_interpolate: .. _class_Animation_method_bezier_track_interpolate:
- :ref:`float<class_float>` **bezier_track_interpolate** **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time **)** const - :ref:`float<class_float>` **bezier_track_interpolate** **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time **)** const
----
.. _class_Animation_method_bezier_track_set_key_in_handle: .. _class_Animation_method_bezier_track_set_key_in_handle:
- void **bezier_track_set_key_in_handle** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`Vector2<class_Vector2>` in_handle **)** - void **bezier_track_set_key_in_handle** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`Vector2<class_Vector2>` in_handle **)**
----
.. _class_Animation_method_bezier_track_set_key_out_handle: .. _class_Animation_method_bezier_track_set_key_out_handle:
- void **bezier_track_set_key_out_handle** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`Vector2<class_Vector2>` out_handle **)** - void **bezier_track_set_key_out_handle** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`Vector2<class_Vector2>` out_handle **)**
----
.. _class_Animation_method_bezier_track_set_key_value: .. _class_Animation_method_bezier_track_set_key_value:
- void **bezier_track_set_key_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` value **)** - void **bezier_track_set_key_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` value **)**
----
.. _class_Animation_method_clear: .. _class_Animation_method_clear:
- void **clear** **(** **)** - void **clear** **(** **)**
Clear the animation (clear all tracks and reset all). Clear the animation (clear all tracks and reset all).
----
.. _class_Animation_method_copy_track: .. _class_Animation_method_copy_track:
- void **copy_track** **(** :ref:`int<class_int>` track, :ref:`Animation<class_Animation>` to_animation **)** - void **copy_track** **(** :ref:`int<class_int>` track, :ref:`Animation<class_Animation>` to_animation **)**
Adds a new track that is a copy of the given track from ``to_animation``. Adds a new track that is a copy of the given track from ``to_animation``.
----
.. _class_Animation_method_find_track: .. _class_Animation_method_find_track:
- :ref:`int<class_int>` **find_track** **(** :ref:`NodePath<class_NodePath>` path **)** const - :ref:`int<class_int>` **find_track** **(** :ref:`NodePath<class_NodePath>` path **)** const
Returns the index of the specified track. If the track is not found, return -1. Returns the index of the specified track. If the track is not found, return -1.
----
.. _class_Animation_method_get_track_count: .. _class_Animation_method_get_track_count:
- :ref:`int<class_int>` **get_track_count** **(** **)** const - :ref:`int<class_int>` **get_track_count** **(** **)** const
Returns the amount of tracks in the animation. Returns the amount of tracks in the animation.
----
.. _class_Animation_method_method_track_get_key_indices: .. _class_Animation_method_method_track_get_key_indices:
- :ref:`PoolIntArray<class_PoolIntArray>` **method_track_get_key_indices** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const - :ref:`PoolIntArray<class_PoolIntArray>` **method_track_get_key_indices** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const
Returns all the key indices of a method track, given a position and delta time. Returns all the key indices of a method track, given a position and delta time.
----
.. _class_Animation_method_method_track_get_name: .. _class_Animation_method_method_track_get_name:
- :ref:`String<class_String>` **method_track_get_name** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const - :ref:`String<class_String>` **method_track_get_name** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
Returns the method name of a method track. Returns the method name of a method track.
----
.. _class_Animation_method_method_track_get_params: .. _class_Animation_method_method_track_get_params:
- :ref:`Array<class_Array>` **method_track_get_params** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const - :ref:`Array<class_Array>` **method_track_get_params** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
Returns the arguments values to be called on a method track for a given key in a given track. Returns the arguments values to be called on a method track for a given key in a given track.
----
.. _class_Animation_method_remove_track: .. _class_Animation_method_remove_track:
- void **remove_track** **(** :ref:`int<class_int>` idx **)** - void **remove_track** **(** :ref:`int<class_int>` idx **)**
Remove a track by specifying the track index. Remove a track by specifying the track index.
----
.. _class_Animation_method_track_find_key: .. _class_Animation_method_track_find_key:
- :ref:`int<class_int>` **track_find_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`bool<class_bool>` exact=false **)** const - :ref:`int<class_int>` **track_find_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`bool<class_bool>` exact=false **)** const
Find the key index by time in a given track. Optionally, only find it if the exact time is given. Find the key index by time in a given track. Optionally, only find it if the exact time is given.
----
.. _class_Animation_method_track_get_interpolation_loop_wrap: .. _class_Animation_method_track_get_interpolation_loop_wrap:
- :ref:`bool<class_bool>` **track_get_interpolation_loop_wrap** **(** :ref:`int<class_int>` idx **)** const - :ref:`bool<class_bool>` **track_get_interpolation_loop_wrap** **(** :ref:`int<class_int>` idx **)** const
Returns ``true`` if the track at ``idx`` wraps the interpolation loop. Default value: ``true``. Returns ``true`` if the track at ``idx`` wraps the interpolation loop. Default value: ``true``.
----
.. _class_Animation_method_track_get_interpolation_type: .. _class_Animation_method_track_get_interpolation_type:
- :ref:`InterpolationType<enum_Animation_InterpolationType>` **track_get_interpolation_type** **(** :ref:`int<class_int>` idx **)** const - :ref:`InterpolationType<enum_Animation_InterpolationType>` **track_get_interpolation_type** **(** :ref:`int<class_int>` idx **)** const
Returns the interpolation type of a given track, from the INTERPOLATION\_\* enum. Returns the interpolation type of a given track, from the INTERPOLATION\_\* enum.
----
.. _class_Animation_method_track_get_key_count: .. _class_Animation_method_track_get_key_count:
- :ref:`int<class_int>` **track_get_key_count** **(** :ref:`int<class_int>` idx **)** const - :ref:`int<class_int>` **track_get_key_count** **(** :ref:`int<class_int>` idx **)** const
Returns the amount of keys in a given track. Returns the amount of keys in a given track.
----
.. _class_Animation_method_track_get_key_time: .. _class_Animation_method_track_get_key_time:
- :ref:`float<class_float>` **track_get_key_time** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const - :ref:`float<class_float>` **track_get_key_time** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
Returns the time at which the key is located. Returns the time at which the key is located.
----
.. _class_Animation_method_track_get_key_transition: .. _class_Animation_method_track_get_key_transition:
- :ref:`float<class_float>` **track_get_key_transition** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const - :ref:`float<class_float>` **track_get_key_transition** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
Returns the transition curve (easing) for a specific key (see built-in math function "ease"). Returns the transition curve (easing) for a specific key (see built-in math function "ease").
----
.. _class_Animation_method_track_get_key_value: .. _class_Animation_method_track_get_key_value:
- :ref:`Variant<class_Variant>` **track_get_key_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const - :ref:`Variant<class_Variant>` **track_get_key_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
Returns the value of a given key in a given track. Returns the value of a given key in a given track.
----
.. _class_Animation_method_track_get_path: .. _class_Animation_method_track_get_path:
- :ref:`NodePath<class_NodePath>` **track_get_path** **(** :ref:`int<class_int>` idx **)** const - :ref:`NodePath<class_NodePath>` **track_get_path** **(** :ref:`int<class_int>` idx **)** const
Get the path of a track. for more information on the path format, see :ref:`track_set_path<class_Animation_method_track_set_path>` Get the path of a track. for more information on the path format, see :ref:`track_set_path<class_Animation_method_track_set_path>`
----
.. _class_Animation_method_track_get_type: .. _class_Animation_method_track_get_type:
- :ref:`TrackType<enum_Animation_TrackType>` **track_get_type** **(** :ref:`int<class_int>` idx **)** const - :ref:`TrackType<enum_Animation_TrackType>` **track_get_type** **(** :ref:`int<class_int>` idx **)** const
Get the type of a track. Get the type of a track.
----
.. _class_Animation_method_track_insert_key: .. _class_Animation_method_track_insert_key:
- void **track_insert_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Variant<class_Variant>` key, :ref:`float<class_float>` transition=1 **)** - void **track_insert_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Variant<class_Variant>` key, :ref:`float<class_float>` transition=1 **)**
Insert a generic key in a given track. Insert a generic key in a given track.
----
.. _class_Animation_method_track_is_enabled: .. _class_Animation_method_track_is_enabled:
- :ref:`bool<class_bool>` **track_is_enabled** **(** :ref:`int<class_int>` idx **)** const - :ref:`bool<class_bool>` **track_is_enabled** **(** :ref:`int<class_int>` idx **)** const
Returns ``true`` if the track at index ``idx`` is enabled. Returns ``true`` if the track at index ``idx`` is enabled.
----
.. _class_Animation_method_track_is_imported: .. _class_Animation_method_track_is_imported:
- :ref:`bool<class_bool>` **track_is_imported** **(** :ref:`int<class_int>` idx **)** const - :ref:`bool<class_bool>` **track_is_imported** **(** :ref:`int<class_int>` idx **)** const
Returns ``true`` if the given track is imported. Else, return ``false``. Returns ``true`` if the given track is imported. Else, return ``false``.
----
.. _class_Animation_method_track_move_down: .. _class_Animation_method_track_move_down:
- void **track_move_down** **(** :ref:`int<class_int>` idx **)** - void **track_move_down** **(** :ref:`int<class_int>` idx **)**
Move a track down. Move a track down.
----
.. _class_Animation_method_track_move_up: .. _class_Animation_method_track_move_up:
- void **track_move_up** **(** :ref:`int<class_int>` idx **)** - void **track_move_up** **(** :ref:`int<class_int>` idx **)**
Move a track up. Move a track up.
----
.. _class_Animation_method_track_remove_key: .. _class_Animation_method_track_remove_key:
- void **track_remove_key** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** - void **track_remove_key** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)**
Remove a key by index in a given track. Remove a key by index in a given track.
----
.. _class_Animation_method_track_remove_key_at_position: .. _class_Animation_method_track_remove_key_at_position:
- void **track_remove_key_at_position** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` position **)** - void **track_remove_key_at_position** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` position **)**
Remove a key by position (seconds) in a given track. Remove a key by position (seconds) in a given track.
----
.. _class_Animation_method_track_set_enabled: .. _class_Animation_method_track_set_enabled:
- void **track_set_enabled** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enabled **)** - void **track_set_enabled** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enabled **)**
Enables/disables the given track. Tracks are enabled by default. Enables/disables the given track. Tracks are enabled by default.
----
.. _class_Animation_method_track_set_imported: .. _class_Animation_method_track_set_imported:
- void **track_set_imported** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` imported **)** - void **track_set_imported** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` imported **)**
Set the given track as imported or not. Set the given track as imported or not.
----
.. _class_Animation_method_track_set_interpolation_loop_wrap: .. _class_Animation_method_track_set_interpolation_loop_wrap:
- void **track_set_interpolation_loop_wrap** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` interpolation **)** - void **track_set_interpolation_loop_wrap** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` interpolation **)**
If ``true``, the track at ``idx`` wraps the interpolation loop. If ``true``, the track at ``idx`` wraps the interpolation loop.
----
.. _class_Animation_method_track_set_interpolation_type: .. _class_Animation_method_track_set_interpolation_type:
- void **track_set_interpolation_type** **(** :ref:`int<class_int>` idx, :ref:`InterpolationType<enum_Animation_InterpolationType>` interpolation **)** - void **track_set_interpolation_type** **(** :ref:`int<class_int>` idx, :ref:`InterpolationType<enum_Animation_InterpolationType>` interpolation **)**
Set the interpolation type of a given track, from the INTERPOLATION\_\* enum. Set the interpolation type of a given track, from the INTERPOLATION\_\* enum.
----
.. _class_Animation_method_track_set_key_transition: .. _class_Animation_method_track_set_key_transition:
- void **track_set_key_transition** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` transition **)** - void **track_set_key_transition** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` transition **)**
Set the transition curve (easing) for a specific key (see built-in math function "ease"). Set the transition curve (easing) for a specific key (see built-in math function "ease").
----
.. _class_Animation_method_track_set_key_value: .. _class_Animation_method_track_set_key_value:
- void **track_set_key_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key, :ref:`Variant<class_Variant>` value **)** - void **track_set_key_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key, :ref:`Variant<class_Variant>` value **)**
Set the value of an existing key. Set the value of an existing key.
----
.. _class_Animation_method_track_set_path: .. _class_Animation_method_track_set_path:
- void **track_set_path** **(** :ref:`int<class_int>` idx, :ref:`NodePath<class_NodePath>` path **)** - void **track_set_path** **(** :ref:`int<class_int>` idx, :ref:`NodePath<class_NodePath>` path **)**
@@ -550,34 +656,46 @@ Set the path of a track. Paths must be valid scene-tree paths to a node, and mus
**Example:** "character/skeleton:ankle" or "character/mesh:transform/local". **Example:** "character/skeleton:ankle" or "character/mesh:transform/local".
----
.. _class_Animation_method_track_swap: .. _class_Animation_method_track_swap:
- void **track_swap** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` with_idx **)** - void **track_swap** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` with_idx **)**
----
.. _class_Animation_method_transform_track_insert_key: .. _class_Animation_method_transform_track_insert_key:
- :ref:`int<class_int>` **transform_track_insert_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Vector3<class_Vector3>` location, :ref:`Quat<class_Quat>` rotation, :ref:`Vector3<class_Vector3>` scale **)** - :ref:`int<class_int>` **transform_track_insert_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Vector3<class_Vector3>` location, :ref:`Quat<class_Quat>` rotation, :ref:`Vector3<class_Vector3>` scale **)**
Insert a transform key for a transform track. Insert a transform key for a transform track.
----
.. _class_Animation_method_transform_track_interpolate: .. _class_Animation_method_transform_track_interpolate:
- :ref:`Array<class_Array>` **transform_track_interpolate** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec **)** const - :ref:`Array<class_Array>` **transform_track_interpolate** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec **)** const
Returns the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position (:ref:`Vector3<class_Vector3>`), rotation (:ref:`Quat<class_Quat>`) and scale (:ref:`Vector3<class_Vector3>`). Returns the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position (:ref:`Vector3<class_Vector3>`), rotation (:ref:`Quat<class_Quat>`) and scale (:ref:`Vector3<class_Vector3>`).
----
.. _class_Animation_method_value_track_get_key_indices: .. _class_Animation_method_value_track_get_key_indices:
- :ref:`PoolIntArray<class_PoolIntArray>` **value_track_get_key_indices** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const - :ref:`PoolIntArray<class_PoolIntArray>` **value_track_get_key_indices** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const
Returns all the key indices of a value track, given a position and delta time. Returns all the key indices of a value track, given a position and delta time.
----
.. _class_Animation_method_value_track_get_update_mode: .. _class_Animation_method_value_track_get_update_mode:
- :ref:`UpdateMode<enum_Animation_UpdateMode>` **value_track_get_update_mode** **(** :ref:`int<class_int>` idx **)** const - :ref:`UpdateMode<enum_Animation_UpdateMode>` **value_track_get_update_mode** **(** :ref:`int<class_int>` idx **)** const
Returns the update mode of a value track. Returns the update mode of a value track.
----
.. _class_Animation_method_value_track_set_update_mode: .. _class_Animation_method_value_track_set_update_mode:
- void **value_track_set_update_mode** **(** :ref:`int<class_int>` idx, :ref:`UpdateMode<enum_Animation_UpdateMode>` mode **)** - void **value_track_set_update_mode** **(** :ref:`int<class_int>` idx, :ref:`UpdateMode<enum_Animation_UpdateMode>` mode **)**

36
classes/class_animationnode.rst
View File

@@ -77,6 +77,8 @@ Signals
Called when the node was removed from the graph. Called when the node was removed from the graph.
----
.. _class_AnimationNode_signal_tree_changed: .. _class_AnimationNode_signal_tree_changed:
- **tree_changed** **(** **)** - **tree_changed** **(** **)**
@@ -137,84 +139,112 @@ Method Descriptions
Add an input to the node. This is only useful for nodes created for use in an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>` Add an input to the node. This is only useful for nodes created for use in an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`
----
.. _class_AnimationNode_method_blend_animation: .. _class_AnimationNode_method_blend_animation:
- void **blend_animation** **(** :ref:`String<class_String>` animation, :ref:`float<class_float>` time, :ref:`float<class_float>` delta, :ref:`bool<class_bool>` seeked, :ref:`float<class_float>` blend **)** - void **blend_animation** **(** :ref:`String<class_String>` animation, :ref:`float<class_float>` time, :ref:`float<class_float>` delta, :ref:`bool<class_bool>` seeked, :ref:`float<class_float>` blend **)**
Blend an animation by "blend" amount (name must be valid in the linked :ref:`AnimationPlayer<class_AnimationPlayer>`). A time and delta mas be passed, as well as whether seek happened. Blend an animation by "blend" amount (name must be valid in the linked :ref:`AnimationPlayer<class_AnimationPlayer>`). A time and delta mas be passed, as well as whether seek happened.
----
.. _class_AnimationNode_method_blend_input: .. _class_AnimationNode_method_blend_input:
- :ref:`float<class_float>` **blend_input** **(** :ref:`int<class_int>` input_index, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)** - :ref:`float<class_float>` **blend_input** **(** :ref:`int<class_int>` input_index, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)**
Blend an input. This is only useful for nodes created for an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`. Time is a delta, unless "seek" is ``true``, in which case it is absolute. A filter mode may be optionally passed. Blend an input. This is only useful for nodes created for an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`. Time is a delta, unless "seek" is ``true``, in which case it is absolute. A filter mode may be optionally passed.
----
.. _class_AnimationNode_method_blend_node: .. _class_AnimationNode_method_blend_node:
- :ref:`float<class_float>` **blend_node** **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)** - :ref:`float<class_float>` **blend_node** **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)**
Blend another animaiton node (in case this node contains children animation nodes). This function is only useful if you inherit from :ref:`AnimationRootNode<class_AnimationRootNode>` instead, else editors will not display your node for addition. Blend another animaiton node (in case this node contains children animation nodes). This function is only useful if you inherit from :ref:`AnimationRootNode<class_AnimationRootNode>` instead, else editors will not display your node for addition.
----
.. _class_AnimationNode_method_get_caption: .. _class_AnimationNode_method_get_caption:
- :ref:`String<class_String>` **get_caption** **(** **)** virtual - :ref:`String<class_String>` **get_caption** **(** **)** virtual
Get the text caption for this node (used by some editors) Get the text caption for this node (used by some editors)
----
.. _class_AnimationNode_method_get_child_by_name: .. _class_AnimationNode_method_get_child_by_name:
- :ref:`Object<class_Object>` **get_child_by_name** **(** :ref:`String<class_String>` name **)** virtual - :ref:`Object<class_Object>` **get_child_by_name** **(** :ref:`String<class_String>` name **)** virtual
Get the a child node by index (used by editors inheriting from :ref:`AnimationRootNode<class_AnimationRootNode>`). Get the a child node by index (used by editors inheriting from :ref:`AnimationRootNode<class_AnimationRootNode>`).
----
.. _class_AnimationNode_method_get_child_nodes: .. _class_AnimationNode_method_get_child_nodes:
- :ref:`Dictionary<class_Dictionary>` **get_child_nodes** **(** **)** virtual - :ref:`Dictionary<class_Dictionary>` **get_child_nodes** **(** **)** virtual
Get all children nodes, in order as a name:node dictionary. Only useful when inheriting :ref:`AnimationRootNode<class_AnimationRootNode>`. Get all children nodes, in order as a name:node dictionary. Only useful when inheriting :ref:`AnimationRootNode<class_AnimationRootNode>`.
----
.. _class_AnimationNode_method_get_input_count: .. _class_AnimationNode_method_get_input_count:
- :ref:`int<class_int>` **get_input_count** **(** **)** const - :ref:`int<class_int>` **get_input_count** **(** **)** const
Amount of inputs in this node, only useful for nodes that go into :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`. Amount of inputs in this node, only useful for nodes that go into :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
----
.. _class_AnimationNode_method_get_input_name: .. _class_AnimationNode_method_get_input_name:
- :ref:`String<class_String>` **get_input_name** **(** :ref:`int<class_int>` input **)** - :ref:`String<class_String>` **get_input_name** **(** :ref:`int<class_int>` input **)**
Get the name of an input by index. Get the name of an input by index.
----
.. _class_AnimationNode_method_get_parameter: .. _class_AnimationNode_method_get_parameter:
- :ref:`Variant<class_Variant>` **get_parameter** **(** :ref:`String<class_String>` name **)** const - :ref:`Variant<class_Variant>` **get_parameter** **(** :ref:`String<class_String>` name **)** const
Get the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Get the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
----
.. _class_AnimationNode_method_get_parameter_default_value: .. _class_AnimationNode_method_get_parameter_default_value:
- :ref:`Variant<class_Variant>` **get_parameter_default_value** **(** :ref:`String<class_String>` name **)** virtual - :ref:`Variant<class_Variant>` **get_parameter_default_value** **(** :ref:`String<class_String>` name **)** virtual
Get the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Get the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
----
.. _class_AnimationNode_method_get_parameter_list: .. _class_AnimationNode_method_get_parameter_list:
- :ref:`Array<class_Array>` **get_parameter_list** **(** **)** virtual - :ref:`Array<class_Array>` **get_parameter_list** **(** **)** virtual
Get the property information for parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Format is similar to :ref:`Object.get_property_list<class_Object_method_get_property_list>`. Get the property information for parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Format is similar to :ref:`Object.get_property_list<class_Object_method_get_property_list>`.
----
.. _class_AnimationNode_method_has_filter: .. _class_AnimationNode_method_has_filter:
- :ref:`String<class_String>` **has_filter** **(** **)** virtual - :ref:`String<class_String>` **has_filter** **(** **)** virtual
Returns ``true`` whether you want the blend tree editor to display filter editing on this node. Returns ``true`` whether you want the blend tree editor to display filter editing on this node.
----
.. _class_AnimationNode_method_is_path_filtered: .. _class_AnimationNode_method_is_path_filtered:
- :ref:`bool<class_bool>` **is_path_filtered** **(** :ref:`NodePath<class_NodePath>` path **)** const - :ref:`bool<class_bool>` **is_path_filtered** **(** :ref:`NodePath<class_NodePath>` path **)** const
Returns ``true`` whether a given path is filtered. Returns ``true`` whether a given path is filtered.
----
.. _class_AnimationNode_method_process: .. _class_AnimationNode_method_process:
- void **process** **(** :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek **)** virtual - void **process** **(** :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek **)** virtual
@@ -227,18 +257,24 @@ You can also use :ref:`get_parameter<class_AnimationNode_method_get_parameter>`
This function returns the time left for the current animation to finish (if unsure, just pass the value from the main blend being called). This function returns the time left for the current animation to finish (if unsure, just pass the value from the main blend being called).
----
.. _class_AnimationNode_method_remove_input: .. _class_AnimationNode_method_remove_input:
- void **remove_input** **(** :ref:`int<class_int>` index **)** - void **remove_input** **(** :ref:`int<class_int>` index **)**
Remove an input, call this only when inactive. Remove an input, call this only when inactive.
----
.. _class_AnimationNode_method_set_filter_path: .. _class_AnimationNode_method_set_filter_path:
- void **set_filter_path** **(** :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)** - void **set_filter_path** **(** :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)**
Add/Remove a path for the filter. Add/Remove a path for the filter.
----
.. _class_AnimationNode_method_set_parameter: .. _class_AnimationNode_method_set_parameter:
- void **set_parameter** **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` value **)** - void **set_parameter** **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` value **)**

18
classes/class_animationnodeblendspace1d.rst
View File

@@ -76,6 +76,8 @@ Property Descriptions
The blend space's axis's upper limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace1D_method_add_blend_point>`. The blend space's axis's upper limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace1D_method_add_blend_point>`.
----
.. _class_AnimationNodeBlendSpace1D_property_min_space: .. _class_AnimationNodeBlendSpace1D_property_min_space:
- :ref:`float<class_float>` **min_space** - :ref:`float<class_float>` **min_space**
@@ -88,6 +90,8 @@ The blend space's axis's upper limit for the points' position. See :ref:`add_ble
The blend space's axis's lower limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace1D_method_add_blend_point>`. The blend space's axis's lower limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace1D_method_add_blend_point>`.
----
.. _class_AnimationNodeBlendSpace1D_property_snap: .. _class_AnimationNodeBlendSpace1D_property_snap:
- :ref:`float<class_float>` **snap** - :ref:`float<class_float>` **snap**
@@ -100,6 +104,8 @@ The blend space's axis's lower limit for the points' position. See :ref:`add_ble
Position increment to snap to when moving a point on the axis. Position increment to snap to when moving a point on the axis.
----
.. _class_AnimationNodeBlendSpace1D_property_value_label: .. _class_AnimationNodeBlendSpace1D_property_value_label:
- :ref:`String<class_String>` **value_label** - :ref:`String<class_String>` **value_label**
@@ -121,36 +127,48 @@ Method Descriptions
Add a new point that represents a ``node`` on the virtual axis at a given position set by ``pos``. You can insert it at a specific index using the ``at_index`` argument. If you use the default value for ``at_index`` , the point is inserted at the end of the blend points array. Add a new point that represents a ``node`` on the virtual axis at a given position set by ``pos``. You can insert it at a specific index using the ``at_index`` argument. If you use the default value for ``at_index`` , the point is inserted at the end of the blend points array.
----
.. _class_AnimationNodeBlendSpace1D_method_get_blend_point_count: .. _class_AnimationNodeBlendSpace1D_method_get_blend_point_count:
- :ref:`int<class_int>` **get_blend_point_count** **(** **)** const - :ref:`int<class_int>` **get_blend_point_count** **(** **)** const
Returns the number of points on the blend axis. Returns the number of points on the blend axis.
----
.. _class_AnimationNodeBlendSpace1D_method_get_blend_point_node: .. _class_AnimationNodeBlendSpace1D_method_get_blend_point_node:
- :ref:`AnimationRootNode<class_AnimationRootNode>` **get_blend_point_node** **(** :ref:`int<class_int>` point **)** const - :ref:`AnimationRootNode<class_AnimationRootNode>` **get_blend_point_node** **(** :ref:`int<class_int>` point **)** const
Returns the ``AnimationNode`` referenced by the point at index ``point``. Returns the ``AnimationNode`` referenced by the point at index ``point``.
----
.. _class_AnimationNodeBlendSpace1D_method_get_blend_point_position: .. _class_AnimationNodeBlendSpace1D_method_get_blend_point_position:
- :ref:`float<class_float>` **get_blend_point_position** **(** :ref:`int<class_int>` point **)** const - :ref:`float<class_float>` **get_blend_point_position** **(** :ref:`int<class_int>` point **)** const
Returns the position of the point at index ``point``. Returns the position of the point at index ``point``.
----
.. _class_AnimationNodeBlendSpace1D_method_remove_blend_point: .. _class_AnimationNodeBlendSpace1D_method_remove_blend_point:
- void **remove_blend_point** **(** :ref:`int<class_int>` point **)** - void **remove_blend_point** **(** :ref:`int<class_int>` point **)**
Removes the point at index ``point`` from the blend axis. Removes the point at index ``point`` from the blend axis.
----
.. _class_AnimationNodeBlendSpace1D_method_set_blend_point_node: .. _class_AnimationNodeBlendSpace1D_method_set_blend_point_node:
- void **set_blend_point_node** **(** :ref:`int<class_int>` point, :ref:`AnimationRootNode<class_AnimationRootNode>` node **)** - void **set_blend_point_node** **(** :ref:`int<class_int>` point, :ref:`AnimationRootNode<class_AnimationRootNode>` node **)**
Changes the AnimationNode referenced by the point at index ``point``. Changes the AnimationNode referenced by the point at index ``point``.
----
.. _class_AnimationNodeBlendSpace1D_method_set_blend_point_position: .. _class_AnimationNodeBlendSpace1D_method_set_blend_point_position:
- void **set_blend_point_position** **(** :ref:`int<class_int>` point, :ref:`float<class_float>` pos **)** - void **set_blend_point_position** **(** :ref:`int<class_int>` point, :ref:`float<class_float>` pos **)**

32
classes/class_animationnodeblendspace2d.rst
View File

@@ -116,6 +116,8 @@ Property Descriptions
If true, the blend space is triangulated automatically. The mesh updates every time you add or remove points with :ref:`add_blend_point<class_AnimationNodeBlendSpace2D_method_add_blend_point>` and :ref:`remove_blend_point<class_AnimationNodeBlendSpace2D_method_remove_blend_point>`. If true, the blend space is triangulated automatically. The mesh updates every time you add or remove points with :ref:`add_blend_point<class_AnimationNodeBlendSpace2D_method_add_blend_point>` and :ref:`remove_blend_point<class_AnimationNodeBlendSpace2D_method_remove_blend_point>`.
----
.. _class_AnimationNodeBlendSpace2D_property_blend_mode: .. _class_AnimationNodeBlendSpace2D_property_blend_mode:
- :ref:`BlendMode<enum_AnimationNodeBlendSpace2D_BlendMode>` **blend_mode** - :ref:`BlendMode<enum_AnimationNodeBlendSpace2D_BlendMode>` **blend_mode**
@@ -128,6 +130,8 @@ If true, the blend space is triangulated automatically. The mesh updates every t
Controls the interpolation between animations. See :ref:`BlendMode<enum_AnimationNodeBlendSpace2D_BlendMode>` constants. Controls the interpolation between animations. See :ref:`BlendMode<enum_AnimationNodeBlendSpace2D_BlendMode>` constants.
----
.. _class_AnimationNodeBlendSpace2D_property_max_space: .. _class_AnimationNodeBlendSpace2D_property_max_space:
- :ref:`Vector2<class_Vector2>` **max_space** - :ref:`Vector2<class_Vector2>` **max_space**
@@ -140,6 +144,8 @@ Controls the interpolation between animations. See :ref:`BlendMode<enum_Animatio
The blend space's X and Y axes' upper limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace2D_method_add_blend_point>`. The blend space's X and Y axes' upper limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace2D_method_add_blend_point>`.
----
.. _class_AnimationNodeBlendSpace2D_property_min_space: .. _class_AnimationNodeBlendSpace2D_property_min_space:
- :ref:`Vector2<class_Vector2>` **min_space** - :ref:`Vector2<class_Vector2>` **min_space**
@@ -152,6 +158,8 @@ The blend space's X and Y axes' upper limit for the points' position. See :ref:`
The blend space's X and Y axes' lower limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace2D_method_add_blend_point>`. The blend space's X and Y axes' lower limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace2D_method_add_blend_point>`.
----
.. _class_AnimationNodeBlendSpace2D_property_snap: .. _class_AnimationNodeBlendSpace2D_property_snap:
- :ref:`Vector2<class_Vector2>` **snap** - :ref:`Vector2<class_Vector2>` **snap**
@@ -164,6 +172,8 @@ The blend space's X and Y axes' lower limit for the points' position. See :ref:`
Position increment to snap to when moving a point. Position increment to snap to when moving a point.
----
.. _class_AnimationNodeBlendSpace2D_property_x_label: .. _class_AnimationNodeBlendSpace2D_property_x_label:
- :ref:`String<class_String>` **x_label** - :ref:`String<class_String>` **x_label**
@@ -176,6 +186,8 @@ Position increment to snap to when moving a point.
Name of the blend space's X axis. Name of the blend space's X axis.
----
.. _class_AnimationNodeBlendSpace2D_property_y_label: .. _class_AnimationNodeBlendSpace2D_property_y_label:
- :ref:`String<class_String>` **y_label** - :ref:`String<class_String>` **y_label**
@@ -197,60 +209,80 @@ Method Descriptions
Add a new point that represents a ``node`` at the position set by ``pos``. You can insert it at a specific index using the ``at_index`` argument. If you use the default value for ``at_index`` , the point is inserted at the end of the blend points array. Add a new point that represents a ``node`` at the position set by ``pos``. You can insert it at a specific index using the ``at_index`` argument. If you use the default value for ``at_index`` , the point is inserted at the end of the blend points array.
----
.. _class_AnimationNodeBlendSpace2D_method_add_triangle: .. _class_AnimationNodeBlendSpace2D_method_add_triangle:
- void **add_triangle** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` at_index=-1 **)** - void **add_triangle** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` at_index=-1 **)**
Creates a new triangle using three points ``x``, ``y``, and ``z``. Triangles can overlap. You can insert the triangle at a specific index using the ``at_index`` argument. If you use the default value for ``at_index`` , the point is inserted at the end of the blend points array. Creates a new triangle using three points ``x``, ``y``, and ``z``. Triangles can overlap. You can insert the triangle at a specific index using the ``at_index`` argument. If you use the default value for ``at_index`` , the point is inserted at the end of the blend points array.
----
.. _class_AnimationNodeBlendSpace2D_method_get_blend_point_count: .. _class_AnimationNodeBlendSpace2D_method_get_blend_point_count:
- :ref:`int<class_int>` **get_blend_point_count** **(** **)** const - :ref:`int<class_int>` **get_blend_point_count** **(** **)** const
Returns the number of points in the blend space. Returns the number of points in the blend space.
----
.. _class_AnimationNodeBlendSpace2D_method_get_blend_point_node: .. _class_AnimationNodeBlendSpace2D_method_get_blend_point_node:
- :ref:`AnimationRootNode<class_AnimationRootNode>` **get_blend_point_node** **(** :ref:`int<class_int>` point **)** const - :ref:`AnimationRootNode<class_AnimationRootNode>` **get_blend_point_node** **(** :ref:`int<class_int>` point **)** const
Returns the ``AnimationRootNode`` referenced by the point at index ``point``. Returns the ``AnimationRootNode`` referenced by the point at index ``point``.
----
.. _class_AnimationNodeBlendSpace2D_method_get_blend_point_position: .. _class_AnimationNodeBlendSpace2D_method_get_blend_point_position:
- :ref:`Vector2<class_Vector2>` **get_blend_point_position** **(** :ref:`int<class_int>` point **)** const - :ref:`Vector2<class_Vector2>` **get_blend_point_position** **(** :ref:`int<class_int>` point **)** const
Returns the position of the point at index ``point``. Returns the position of the point at index ``point``.
----
.. _class_AnimationNodeBlendSpace2D_method_get_triangle_count: .. _class_AnimationNodeBlendSpace2D_method_get_triangle_count:
- :ref:`int<class_int>` **get_triangle_count** **(** **)** const - :ref:`int<class_int>` **get_triangle_count** **(** **)** const
Returns the number of triangles in the blend space. Returns the number of triangles in the blend space.
----
.. _class_AnimationNodeBlendSpace2D_method_get_triangle_point: .. _class_AnimationNodeBlendSpace2D_method_get_triangle_point:
- :ref:`int<class_int>` **get_triangle_point** **(** :ref:`int<class_int>` triangle, :ref:`int<class_int>` point **)** - :ref:`int<class_int>` **get_triangle_point** **(** :ref:`int<class_int>` triangle, :ref:`int<class_int>` point **)**
Returns the position of the point at index ``point`` in the triangle of index ``triangle``. Returns the position of the point at index ``point`` in the triangle of index ``triangle``.
----
.. _class_AnimationNodeBlendSpace2D_method_remove_blend_point: .. _class_AnimationNodeBlendSpace2D_method_remove_blend_point:
- void **remove_blend_point** **(** :ref:`int<class_int>` point **)** - void **remove_blend_point** **(** :ref:`int<class_int>` point **)**
Removes the point at index ``point`` from the blend space. Removes the point at index ``point`` from the blend space.
----
.. _class_AnimationNodeBlendSpace2D_method_remove_triangle: .. _class_AnimationNodeBlendSpace2D_method_remove_triangle:
- void **remove_triangle** **(** :ref:`int<class_int>` triangle **)** - void **remove_triangle** **(** :ref:`int<class_int>` triangle **)**
Removes the triangle at index ``triangle`` from the blend space. Removes the triangle at index ``triangle`` from the blend space.
----
.. _class_AnimationNodeBlendSpace2D_method_set_blend_point_node: .. _class_AnimationNodeBlendSpace2D_method_set_blend_point_node:
- void **set_blend_point_node** **(** :ref:`int<class_int>` point, :ref:`AnimationRootNode<class_AnimationRootNode>` node **)** - void **set_blend_point_node** **(** :ref:`int<class_int>` point, :ref:`AnimationRootNode<class_AnimationRootNode>` node **)**
Changes the AnimationNode referenced by the point at index ``point``. Changes the AnimationNode referenced by the point at index ``point``.
----
.. _class_AnimationNodeBlendSpace2D_method_set_blend_point_position: .. _class_AnimationNodeBlendSpace2D_method_set_blend_point_position:
- void **set_blend_point_position** **(** :ref:`int<class_int>` point, :ref:`Vector2<class_Vector2>` pos **)** - void **set_blend_point_position** **(** :ref:`int<class_int>` point, :ref:`Vector2<class_Vector2>` pos **)**

16
classes/class_animationnodeblendtree.rst
View File

@@ -95,34 +95,50 @@ Method Descriptions
- void **add_node** **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)** - void **add_node** **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)**
----
.. _class_AnimationNodeBlendTree_method_connect_node: .. _class_AnimationNodeBlendTree_method_connect_node:
- void **connect_node** **(** :ref:`String<class_String>` input_node, :ref:`int<class_int>` input_index, :ref:`String<class_String>` output_node **)** - void **connect_node** **(** :ref:`String<class_String>` input_node, :ref:`int<class_int>` input_index, :ref:`String<class_String>` output_node **)**
----
.. _class_AnimationNodeBlendTree_method_disconnect_node: .. _class_AnimationNodeBlendTree_method_disconnect_node:
- void **disconnect_node** **(** :ref:`String<class_String>` input_node, :ref:`int<class_int>` input_index **)** - void **disconnect_node** **(** :ref:`String<class_String>` input_node, :ref:`int<class_int>` input_index **)**
----
.. _class_AnimationNodeBlendTree_method_get_node: .. _class_AnimationNodeBlendTree_method_get_node:
- :ref:`AnimationNode<class_AnimationNode>` **get_node** **(** :ref:`String<class_String>` name **)** const - :ref:`AnimationNode<class_AnimationNode>` **get_node** **(** :ref:`String<class_String>` name **)** const
----
.. _class_AnimationNodeBlendTree_method_get_node_position: .. _class_AnimationNodeBlendTree_method_get_node_position:
- :ref:`Vector2<class_Vector2>` **get_node_position** **(** :ref:`String<class_String>` name **)** const - :ref:`Vector2<class_Vector2>` **get_node_position** **(** :ref:`String<class_String>` name **)** const
----
.. _class_AnimationNodeBlendTree_method_has_node: .. _class_AnimationNodeBlendTree_method_has_node:
- :ref:`bool<class_bool>` **has_node** **(** :ref:`String<class_String>` name **)** const - :ref:`bool<class_bool>` **has_node** **(** :ref:`String<class_String>` name **)** const
----
.. _class_AnimationNodeBlendTree_method_remove_node: .. _class_AnimationNodeBlendTree_method_remove_node:
- void **remove_node** **(** :ref:`String<class_String>` name **)** - void **remove_node** **(** :ref:`String<class_String>` name **)**
----
.. _class_AnimationNodeBlendTree_method_rename_node: .. _class_AnimationNodeBlendTree_method_rename_node:
- void **rename_node** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)** - void **rename_node** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)**
----
.. _class_AnimationNodeBlendTree_method_set_node_position: .. _class_AnimationNodeBlendTree_method_set_node_position:
- void **set_node_position** **(** :ref:`String<class_String>` name, :ref:`Vector2<class_Vector2>` position **)** - void **set_node_position** **(** :ref:`String<class_String>` name, :ref:`Vector2<class_Vector2>` position **)**

12
classes/class_animationnodeoneshot.rst
View File

@@ -72,6 +72,8 @@ Property Descriptions
| *Getter* | has_autorestart() | | *Getter* | has_autorestart() |
+----------+------------------------+ +----------+------------------------+
----
.. _class_AnimationNodeOneShot_property_autorestart_delay: .. _class_AnimationNodeOneShot_property_autorestart_delay:
- :ref:`float<class_float>` **autorestart_delay** - :ref:`float<class_float>` **autorestart_delay**
@@ -82,6 +84,8 @@ Property Descriptions
| *Getter* | get_autorestart_delay() | | *Getter* | get_autorestart_delay() |
+----------+------------------------------+ +----------+------------------------------+
----
.. _class_AnimationNodeOneShot_property_autorestart_random_delay: .. _class_AnimationNodeOneShot_property_autorestart_random_delay:
- :ref:`float<class_float>` **autorestart_random_delay** - :ref:`float<class_float>` **autorestart_random_delay**
@@ -92,6 +96,8 @@ Property Descriptions
| *Getter* | get_autorestart_random_delay() | | *Getter* | get_autorestart_random_delay() |
+----------+-------------------------------------+ +----------+-------------------------------------+
----
.. _class_AnimationNodeOneShot_property_fadein_time: .. _class_AnimationNodeOneShot_property_fadein_time:
- :ref:`float<class_float>` **fadein_time** - :ref:`float<class_float>` **fadein_time**
@@ -102,6 +108,8 @@ Property Descriptions
| *Getter* | get_fadein_time() | | *Getter* | get_fadein_time() |
+----------+------------------------+ +----------+------------------------+
----
.. _class_AnimationNodeOneShot_property_fadeout_time: .. _class_AnimationNodeOneShot_property_fadeout_time:
- :ref:`float<class_float>` **fadeout_time** - :ref:`float<class_float>` **fadeout_time**
@@ -112,6 +120,8 @@ Property Descriptions
| *Getter* | get_fadeout_time() | | *Getter* | get_fadeout_time() |
+----------+-------------------------+ +----------+-------------------------+
----
.. _class_AnimationNodeOneShot_property_sync: .. _class_AnimationNodeOneShot_property_sync:
- :ref:`bool<class_bool>` **sync** - :ref:`bool<class_bool>` **sync**
@@ -129,6 +139,8 @@ Method Descriptions
- :ref:`MixMode<enum_AnimationNodeOneShot_MixMode>` **get_mix_mode** **(** **)** const - :ref:`MixMode<enum_AnimationNodeOneShot_MixMode>` **get_mix_mode** **(** **)** const
----
.. _class_AnimationNodeOneShot_method_set_mix_mode: .. _class_AnimationNodeOneShot_method_set_mix_mode:
- void **set_mix_mode** **(** :ref:`MixMode<enum_AnimationNodeOneShot_MixMode>` mode **)** - void **set_mix_mode** **(** :ref:`MixMode<enum_AnimationNodeOneShot_MixMode>` mode **)**

42
classes/class_animationnodestatemachine.rst
View File

@@ -86,126 +86,168 @@ Method Descriptions
Adds a new node to the graph. The ``position`` is used for display in the editor. Adds a new node to the graph. The ``position`` is used for display in the editor.
----
.. _class_AnimationNodeStateMachine_method_add_transition: .. _class_AnimationNodeStateMachine_method_add_transition:
- void **add_transition** **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to, :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` transition **)** - void **add_transition** **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to, :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` transition **)**
Adds a transition between the given nodes. Adds a transition between the given nodes.
----
.. _class_AnimationNodeStateMachine_method_get_end_node: .. _class_AnimationNodeStateMachine_method_get_end_node:
- :ref:`String<class_String>` **get_end_node** **(** **)** const - :ref:`String<class_String>` **get_end_node** **(** **)** const
Returns the graph's end node. Returns the graph's end node.
----
.. _class_AnimationNodeStateMachine_method_get_graph_offset: .. _class_AnimationNodeStateMachine_method_get_graph_offset:
- :ref:`Vector2<class_Vector2>` **get_graph_offset** **(** **)** const - :ref:`Vector2<class_Vector2>` **get_graph_offset** **(** **)** const
Returns the draw offset of the graph. Used for display in the editor. Returns the draw offset of the graph. Used for display in the editor.
----
.. _class_AnimationNodeStateMachine_method_get_node: .. _class_AnimationNodeStateMachine_method_get_node:
- :ref:`AnimationNode<class_AnimationNode>` **get_node** **(** :ref:`String<class_String>` name **)** const - :ref:`AnimationNode<class_AnimationNode>` **get_node** **(** :ref:`String<class_String>` name **)** const
Returns the animation node with the given name. Returns the animation node with the given name.
----
.. _class_AnimationNodeStateMachine_method_get_node_name: .. _class_AnimationNodeStateMachine_method_get_node_name:
- :ref:`String<class_String>` **get_node_name** **(** :ref:`AnimationNode<class_AnimationNode>` node **)** const - :ref:`String<class_String>` **get_node_name** **(** :ref:`AnimationNode<class_AnimationNode>` node **)** const
Returns the given animation node's name. Returns the given animation node's name.
----
.. _class_AnimationNodeStateMachine_method_get_node_position: .. _class_AnimationNodeStateMachine_method_get_node_position:
- :ref:`Vector2<class_Vector2>` **get_node_position** **(** :ref:`String<class_String>` name **)** const - :ref:`Vector2<class_Vector2>` **get_node_position** **(** :ref:`String<class_String>` name **)** const
Returns the given node's coordinates. Used for display in the editor. Returns the given node's coordinates. Used for display in the editor.
----
.. _class_AnimationNodeStateMachine_method_get_start_node: .. _class_AnimationNodeStateMachine_method_get_start_node:
- :ref:`String<class_String>` **get_start_node** **(** **)** const - :ref:`String<class_String>` **get_start_node** **(** **)** const
Returns the graph's end node. Returns the graph's end node.
----
.. _class_AnimationNodeStateMachine_method_get_transition: .. _class_AnimationNodeStateMachine_method_get_transition:
- :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` **get_transition** **(** :ref:`int<class_int>` idx **)** const - :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` **get_transition** **(** :ref:`int<class_int>` idx **)** const
Returns the given transition. Returns the given transition.
----
.. _class_AnimationNodeStateMachine_method_get_transition_count: .. _class_AnimationNodeStateMachine_method_get_transition_count:
- :ref:`int<class_int>` **get_transition_count** **(** **)** const - :ref:`int<class_int>` **get_transition_count** **(** **)** const
Returns the number of connections in the graph. Returns the number of connections in the graph.
----
.. _class_AnimationNodeStateMachine_method_get_transition_from: .. _class_AnimationNodeStateMachine_method_get_transition_from:
- :ref:`String<class_String>` **get_transition_from** **(** :ref:`int<class_int>` idx **)** const - :ref:`String<class_String>` **get_transition_from** **(** :ref:`int<class_int>` idx **)** const
Returns the given transition's start node. Returns the given transition's start node.
----
.. _class_AnimationNodeStateMachine_method_get_transition_to: .. _class_AnimationNodeStateMachine_method_get_transition_to:
- :ref:`String<class_String>` **get_transition_to** **(** :ref:`int<class_int>` idx **)** const - :ref:`String<class_String>` **get_transition_to** **(** :ref:`int<class_int>` idx **)** const
Returns the given transition's end node. Returns the given transition's end node.
----
.. _class_AnimationNodeStateMachine_method_has_node: .. _class_AnimationNodeStateMachine_method_has_node:
- :ref:`bool<class_bool>` **has_node** **(** :ref:`String<class_String>` name **)** const - :ref:`bool<class_bool>` **has_node** **(** :ref:`String<class_String>` name **)** const
Returns ``true`` if the graph contains the given node. Returns ``true`` if the graph contains the given node.
----
.. _class_AnimationNodeStateMachine_method_has_transition: .. _class_AnimationNodeStateMachine_method_has_transition:
- :ref:`bool<class_bool>` **has_transition** **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to **)** const - :ref:`bool<class_bool>` **has_transition** **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to **)** const
Returns ``true`` if there is a transition between the given nodes. Returns ``true`` if there is a transition between the given nodes.
----
.. _class_AnimationNodeStateMachine_method_remove_node: .. _class_AnimationNodeStateMachine_method_remove_node:
- void **remove_node** **(** :ref:`String<class_String>` name **)** - void **remove_node** **(** :ref:`String<class_String>` name **)**
Deletes the given node from the graph. Deletes the given node from the graph.
----
.. _class_AnimationNodeStateMachine_method_remove_transition: .. _class_AnimationNodeStateMachine_method_remove_transition:
- void **remove_transition** **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to **)** - void **remove_transition** **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to **)**
Deletes the given transition. Deletes the given transition.
----
.. _class_AnimationNodeStateMachine_method_remove_transition_by_index: .. _class_AnimationNodeStateMachine_method_remove_transition_by_index:
- void **remove_transition_by_index** **(** :ref:`int<class_int>` idx **)** - void **remove_transition_by_index** **(** :ref:`int<class_int>` idx **)**
Deletes the given transition. Deletes the given transition.
----
.. _class_AnimationNodeStateMachine_method_rename_node: .. _class_AnimationNodeStateMachine_method_rename_node:
- void **rename_node** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)** - void **rename_node** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)**
Renames the given node. Renames the given node.
----
.. _class_AnimationNodeStateMachine_method_set_end_node: .. _class_AnimationNodeStateMachine_method_set_end_node:
- void **set_end_node** **(** :ref:`String<class_String>` name **)** - void **set_end_node** **(** :ref:`String<class_String>` name **)**
Sets the given node as the graph end point. Sets the given node as the graph end point.
----
.. _class_AnimationNodeStateMachine_method_set_graph_offset: .. _class_AnimationNodeStateMachine_method_set_graph_offset:
- void **set_graph_offset** **(** :ref:`Vector2<class_Vector2>` offset **)** - void **set_graph_offset** **(** :ref:`Vector2<class_Vector2>` offset **)**
Sets the draw offset of the graph. Used for display in the editor. Sets the draw offset of the graph. Used for display in the editor.
----
.. _class_AnimationNodeStateMachine_method_set_node_position: .. _class_AnimationNodeStateMachine_method_set_node_position:
- void **set_node_position** **(** :ref:`String<class_String>` name, :ref:`Vector2<class_Vector2>` position **)** - void **set_node_position** **(** :ref:`String<class_String>` name, :ref:`Vector2<class_Vector2>` position **)**
Sets the node's coordinates. Used for display in the editor. Sets the node's coordinates. Used for display in the editor.
----
.. _class_AnimationNodeStateMachine_method_set_start_node: .. _class_AnimationNodeStateMachine_method_set_start_node:
- void **set_start_node** **(** :ref:`String<class_String>` name **)** - void **set_start_node** **(** :ref:`String<class_String>` name **)**

10
classes/class_animationnodestatemachineplayback.rst
View File

@@ -54,28 +54,38 @@ Method Descriptions
Returns the currently playing animation state. Returns the currently playing animation state.
----
.. _class_AnimationNodeStateMachinePlayback_method_get_travel_path: .. _class_AnimationNodeStateMachinePlayback_method_get_travel_path:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_travel_path** **(** **)** const - :ref:`PoolStringArray<class_PoolStringArray>` **get_travel_path** **(** **)** const
----
.. _class_AnimationNodeStateMachinePlayback_method_is_playing: .. _class_AnimationNodeStateMachinePlayback_method_is_playing:
- :ref:`bool<class_bool>` **is_playing** **(** **)** const - :ref:`bool<class_bool>` **is_playing** **(** **)** const
Returns ``true`` if an animation is playing. Returns ``true`` if an animation is playing.
----
.. _class_AnimationNodeStateMachinePlayback_method_start: .. _class_AnimationNodeStateMachinePlayback_method_start:
- void **start** **(** :ref:`String<class_String>` node **)** - void **start** **(** :ref:`String<class_String>` node **)**
Starts playing the given animation. Starts playing the given animation.
----
.. _class_AnimationNodeStateMachinePlayback_method_stop: .. _class_AnimationNodeStateMachinePlayback_method_stop:
- void **stop** **(** **)** - void **stop** **(** **)**
Stops the currently playing animation. Stops the currently playing animation.
----
.. _class_AnimationNodeStateMachinePlayback_method_travel: .. _class_AnimationNodeStateMachinePlayback_method_travel:
- void **travel** **(** :ref:`String<class_String>` to_node **)** - void **travel** **(** :ref:`String<class_String>` to_node **)**

10
classes/class_animationnodestatemachinetransition.rst
View File

@@ -80,6 +80,8 @@ Turn on auto advance when this condition is set. The provided name will become a
$animation_tree["parameters/conditions/idle"] = is_on_floor and linear_velocity.x == 0 $animation_tree["parameters/conditions/idle"] = is_on_floor and linear_velocity.x == 0
----
.. _class_AnimationNodeStateMachineTransition_property_auto_advance: .. _class_AnimationNodeStateMachineTransition_property_auto_advance:
- :ref:`bool<class_bool>` **auto_advance** - :ref:`bool<class_bool>` **auto_advance**
@@ -92,6 +94,8 @@ Turn on auto advance when this condition is set. The provided name will become a
Turn on the transition automatically when this state is reached. This works best with :ref:`SWITCH_MODE_AT_END<class_AnimationNodeStateMachineTransition_constant_SWITCH_MODE_AT_END>`. Turn on the transition automatically when this state is reached. This works best with :ref:`SWITCH_MODE_AT_END<class_AnimationNodeStateMachineTransition_constant_SWITCH_MODE_AT_END>`.
----
.. _class_AnimationNodeStateMachineTransition_property_disabled: .. _class_AnimationNodeStateMachineTransition_property_disabled:
- :ref:`bool<class_bool>` **disabled** - :ref:`bool<class_bool>` **disabled**
@@ -104,6 +108,8 @@ Turn on the transition automatically when this state is reached. This works best
Don't use this transition during :ref:`AnimationNodeStateMachinePlayback.travel<class_AnimationNodeStateMachinePlayback_method_travel>` or :ref:`auto_advance<class_AnimationNodeStateMachineTransition_property_auto_advance>`. Don't use this transition during :ref:`AnimationNodeStateMachinePlayback.travel<class_AnimationNodeStateMachinePlayback_method_travel>` or :ref:`auto_advance<class_AnimationNodeStateMachineTransition_property_auto_advance>`.
----
.. _class_AnimationNodeStateMachineTransition_property_priority: .. _class_AnimationNodeStateMachineTransition_property_priority:
- :ref:`int<class_int>` **priority** - :ref:`int<class_int>` **priority**
@@ -116,6 +122,8 @@ Don't use this transition during :ref:`AnimationNodeStateMachinePlayback.travel<
Lower priority transitions are preferred when travelling through the tree via :ref:`AnimationNodeStateMachinePlayback.travel<class_AnimationNodeStateMachinePlayback_method_travel>` or :ref:`auto_advance<class_AnimationNodeStateMachineTransition_property_auto_advance>`. Lower priority transitions are preferred when travelling through the tree via :ref:`AnimationNodeStateMachinePlayback.travel<class_AnimationNodeStateMachinePlayback_method_travel>` or :ref:`auto_advance<class_AnimationNodeStateMachineTransition_property_auto_advance>`.
----
.. _class_AnimationNodeStateMachineTransition_property_switch_mode: .. _class_AnimationNodeStateMachineTransition_property_switch_mode:
- :ref:`SwitchMode<enum_AnimationNodeStateMachineTransition_SwitchMode>` **switch_mode** - :ref:`SwitchMode<enum_AnimationNodeStateMachineTransition_SwitchMode>` **switch_mode**
@@ -128,6 +136,8 @@ Lower priority transitions are preferred when travelling through the tree via :r
The transition type. The transition type.
----
.. _class_AnimationNodeStateMachineTransition_property_xfade_time: .. _class_AnimationNodeStateMachineTransition_property_xfade_time:
- :ref:`float<class_float>` **xfade_time** - :ref:`float<class_float>` **xfade_time**

130
classes/class_animationnodetransition.rst
View File

@@ -168,6 +168,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_0/name: .. _class_AnimationNodeTransition_property_input_0/name:
- :ref:`String<class_String>` **input_0/name** - :ref:`String<class_String>` **input_0/name**
@@ -178,6 +180,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_1/auto_advance: .. _class_AnimationNodeTransition_property_input_1/auto_advance:
- :ref:`bool<class_bool>` **input_1/auto_advance** - :ref:`bool<class_bool>` **input_1/auto_advance**
@@ -188,6 +192,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_1/name: .. _class_AnimationNodeTransition_property_input_1/name:
- :ref:`String<class_String>` **input_1/name** - :ref:`String<class_String>` **input_1/name**
@@ -198,6 +204,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_10/auto_advance: .. _class_AnimationNodeTransition_property_input_10/auto_advance:
- :ref:`bool<class_bool>` **input_10/auto_advance** - :ref:`bool<class_bool>` **input_10/auto_advance**
@@ -208,6 +216,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_10/name: .. _class_AnimationNodeTransition_property_input_10/name:
- :ref:`String<class_String>` **input_10/name** - :ref:`String<class_String>` **input_10/name**
@@ -218,6 +228,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_11/auto_advance: .. _class_AnimationNodeTransition_property_input_11/auto_advance:
- :ref:`bool<class_bool>` **input_11/auto_advance** - :ref:`bool<class_bool>` **input_11/auto_advance**
@@ -228,6 +240,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_11/name: .. _class_AnimationNodeTransition_property_input_11/name:
- :ref:`String<class_String>` **input_11/name** - :ref:`String<class_String>` **input_11/name**
@@ -238,6 +252,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_12/auto_advance: .. _class_AnimationNodeTransition_property_input_12/auto_advance:
- :ref:`bool<class_bool>` **input_12/auto_advance** - :ref:`bool<class_bool>` **input_12/auto_advance**
@@ -248,6 +264,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_12/name: .. _class_AnimationNodeTransition_property_input_12/name:
- :ref:`String<class_String>` **input_12/name** - :ref:`String<class_String>` **input_12/name**
@@ -258,6 +276,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_13/auto_advance: .. _class_AnimationNodeTransition_property_input_13/auto_advance:
- :ref:`bool<class_bool>` **input_13/auto_advance** - :ref:`bool<class_bool>` **input_13/auto_advance**
@@ -268,6 +288,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_13/name: .. _class_AnimationNodeTransition_property_input_13/name:
- :ref:`String<class_String>` **input_13/name** - :ref:`String<class_String>` **input_13/name**
@@ -278,6 +300,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_14/auto_advance: .. _class_AnimationNodeTransition_property_input_14/auto_advance:
- :ref:`bool<class_bool>` **input_14/auto_advance** - :ref:`bool<class_bool>` **input_14/auto_advance**
@@ -288,6 +312,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_14/name: .. _class_AnimationNodeTransition_property_input_14/name:
- :ref:`String<class_String>` **input_14/name** - :ref:`String<class_String>` **input_14/name**
@@ -298,6 +324,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_15/auto_advance: .. _class_AnimationNodeTransition_property_input_15/auto_advance:
- :ref:`bool<class_bool>` **input_15/auto_advance** - :ref:`bool<class_bool>` **input_15/auto_advance**
@@ -308,6 +336,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_15/name: .. _class_AnimationNodeTransition_property_input_15/name:
- :ref:`String<class_String>` **input_15/name** - :ref:`String<class_String>` **input_15/name**
@@ -318,6 +348,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_16/auto_advance: .. _class_AnimationNodeTransition_property_input_16/auto_advance:
- :ref:`bool<class_bool>` **input_16/auto_advance** - :ref:`bool<class_bool>` **input_16/auto_advance**
@@ -328,6 +360,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_16/name: .. _class_AnimationNodeTransition_property_input_16/name:
- :ref:`String<class_String>` **input_16/name** - :ref:`String<class_String>` **input_16/name**
@@ -338,6 +372,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_17/auto_advance: .. _class_AnimationNodeTransition_property_input_17/auto_advance:
- :ref:`bool<class_bool>` **input_17/auto_advance** - :ref:`bool<class_bool>` **input_17/auto_advance**
@@ -348,6 +384,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_17/name: .. _class_AnimationNodeTransition_property_input_17/name:
- :ref:`String<class_String>` **input_17/name** - :ref:`String<class_String>` **input_17/name**
@@ -358,6 +396,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_18/auto_advance: .. _class_AnimationNodeTransition_property_input_18/auto_advance:
- :ref:`bool<class_bool>` **input_18/auto_advance** - :ref:`bool<class_bool>` **input_18/auto_advance**
@@ -368,6 +408,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_18/name: .. _class_AnimationNodeTransition_property_input_18/name:
- :ref:`String<class_String>` **input_18/name** - :ref:`String<class_String>` **input_18/name**
@@ -378,6 +420,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_19/auto_advance: .. _class_AnimationNodeTransition_property_input_19/auto_advance:
- :ref:`bool<class_bool>` **input_19/auto_advance** - :ref:`bool<class_bool>` **input_19/auto_advance**
@@ -388,6 +432,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_19/name: .. _class_AnimationNodeTransition_property_input_19/name:
- :ref:`String<class_String>` **input_19/name** - :ref:`String<class_String>` **input_19/name**
@@ -398,6 +444,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_2/auto_advance: .. _class_AnimationNodeTransition_property_input_2/auto_advance:
- :ref:`bool<class_bool>` **input_2/auto_advance** - :ref:`bool<class_bool>` **input_2/auto_advance**
@@ -408,6 +456,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_2/name: .. _class_AnimationNodeTransition_property_input_2/name:
- :ref:`String<class_String>` **input_2/name** - :ref:`String<class_String>` **input_2/name**
@@ -418,6 +468,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_20/auto_advance: .. _class_AnimationNodeTransition_property_input_20/auto_advance:
- :ref:`bool<class_bool>` **input_20/auto_advance** - :ref:`bool<class_bool>` **input_20/auto_advance**
@@ -428,6 +480,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_20/name: .. _class_AnimationNodeTransition_property_input_20/name:
- :ref:`String<class_String>` **input_20/name** - :ref:`String<class_String>` **input_20/name**
@@ -438,6 +492,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_21/auto_advance: .. _class_AnimationNodeTransition_property_input_21/auto_advance:
- :ref:`bool<class_bool>` **input_21/auto_advance** - :ref:`bool<class_bool>` **input_21/auto_advance**
@@ -448,6 +504,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_21/name: .. _class_AnimationNodeTransition_property_input_21/name:
- :ref:`String<class_String>` **input_21/name** - :ref:`String<class_String>` **input_21/name**
@@ -458,6 +516,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_22/auto_advance: .. _class_AnimationNodeTransition_property_input_22/auto_advance:
- :ref:`bool<class_bool>` **input_22/auto_advance** - :ref:`bool<class_bool>` **input_22/auto_advance**
@@ -468,6 +528,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_22/name: .. _class_AnimationNodeTransition_property_input_22/name:
- :ref:`String<class_String>` **input_22/name** - :ref:`String<class_String>` **input_22/name**
@@ -478,6 +540,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_23/auto_advance: .. _class_AnimationNodeTransition_property_input_23/auto_advance:
- :ref:`bool<class_bool>` **input_23/auto_advance** - :ref:`bool<class_bool>` **input_23/auto_advance**
@@ -488,6 +552,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_23/name: .. _class_AnimationNodeTransition_property_input_23/name:
- :ref:`String<class_String>` **input_23/name** - :ref:`String<class_String>` **input_23/name**
@@ -498,6 +564,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_24/auto_advance: .. _class_AnimationNodeTransition_property_input_24/auto_advance:
- :ref:`bool<class_bool>` **input_24/auto_advance** - :ref:`bool<class_bool>` **input_24/auto_advance**
@@ -508,6 +576,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_24/name: .. _class_AnimationNodeTransition_property_input_24/name:
- :ref:`String<class_String>` **input_24/name** - :ref:`String<class_String>` **input_24/name**
@@ -518,6 +588,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_25/auto_advance: .. _class_AnimationNodeTransition_property_input_25/auto_advance:
- :ref:`bool<class_bool>` **input_25/auto_advance** - :ref:`bool<class_bool>` **input_25/auto_advance**
@@ -528,6 +600,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_25/name: .. _class_AnimationNodeTransition_property_input_25/name:
- :ref:`String<class_String>` **input_25/name** - :ref:`String<class_String>` **input_25/name**
@@ -538,6 +612,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_26/auto_advance: .. _class_AnimationNodeTransition_property_input_26/auto_advance:
- :ref:`bool<class_bool>` **input_26/auto_advance** - :ref:`bool<class_bool>` **input_26/auto_advance**
@@ -548,6 +624,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_26/name: .. _class_AnimationNodeTransition_property_input_26/name:
- :ref:`String<class_String>` **input_26/name** - :ref:`String<class_String>` **input_26/name**
@@ -558,6 +636,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_27/auto_advance: .. _class_AnimationNodeTransition_property_input_27/auto_advance:
- :ref:`bool<class_bool>` **input_27/auto_advance** - :ref:`bool<class_bool>` **input_27/auto_advance**
@@ -568,6 +648,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_27/name: .. _class_AnimationNodeTransition_property_input_27/name:
- :ref:`String<class_String>` **input_27/name** - :ref:`String<class_String>` **input_27/name**
@@ -578,6 +660,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_28/auto_advance: .. _class_AnimationNodeTransition_property_input_28/auto_advance:
- :ref:`bool<class_bool>` **input_28/auto_advance** - :ref:`bool<class_bool>` **input_28/auto_advance**
@@ -588,6 +672,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_28/name: .. _class_AnimationNodeTransition_property_input_28/name:
- :ref:`String<class_String>` **input_28/name** - :ref:`String<class_String>` **input_28/name**
@@ -598,6 +684,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_29/auto_advance: .. _class_AnimationNodeTransition_property_input_29/auto_advance:
- :ref:`bool<class_bool>` **input_29/auto_advance** - :ref:`bool<class_bool>` **input_29/auto_advance**
@@ -608,6 +696,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_29/name: .. _class_AnimationNodeTransition_property_input_29/name:
- :ref:`String<class_String>` **input_29/name** - :ref:`String<class_String>` **input_29/name**
@@ -618,6 +708,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_3/auto_advance: .. _class_AnimationNodeTransition_property_input_3/auto_advance:
- :ref:`bool<class_bool>` **input_3/auto_advance** - :ref:`bool<class_bool>` **input_3/auto_advance**
@@ -628,6 +720,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_3/name: .. _class_AnimationNodeTransition_property_input_3/name:
- :ref:`String<class_String>` **input_3/name** - :ref:`String<class_String>` **input_3/name**
@@ -638,6 +732,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_30/auto_advance: .. _class_AnimationNodeTransition_property_input_30/auto_advance:
- :ref:`bool<class_bool>` **input_30/auto_advance** - :ref:`bool<class_bool>` **input_30/auto_advance**
@@ -648,6 +744,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_30/name: .. _class_AnimationNodeTransition_property_input_30/name:
- :ref:`String<class_String>` **input_30/name** - :ref:`String<class_String>` **input_30/name**
@@ -658,6 +756,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_31/auto_advance: .. _class_AnimationNodeTransition_property_input_31/auto_advance:
- :ref:`bool<class_bool>` **input_31/auto_advance** - :ref:`bool<class_bool>` **input_31/auto_advance**
@@ -668,6 +768,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_31/name: .. _class_AnimationNodeTransition_property_input_31/name:
- :ref:`String<class_String>` **input_31/name** - :ref:`String<class_String>` **input_31/name**
@@ -678,6 +780,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_4/auto_advance: .. _class_AnimationNodeTransition_property_input_4/auto_advance:
- :ref:`bool<class_bool>` **input_4/auto_advance** - :ref:`bool<class_bool>` **input_4/auto_advance**
@@ -688,6 +792,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_4/name: .. _class_AnimationNodeTransition_property_input_4/name:
- :ref:`String<class_String>` **input_4/name** - :ref:`String<class_String>` **input_4/name**
@@ -698,6 +804,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_5/auto_advance: .. _class_AnimationNodeTransition_property_input_5/auto_advance:
- :ref:`bool<class_bool>` **input_5/auto_advance** - :ref:`bool<class_bool>` **input_5/auto_advance**
@@ -708,6 +816,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_5/name: .. _class_AnimationNodeTransition_property_input_5/name:
- :ref:`String<class_String>` **input_5/name** - :ref:`String<class_String>` **input_5/name**
@@ -718,6 +828,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_6/auto_advance: .. _class_AnimationNodeTransition_property_input_6/auto_advance:
- :ref:`bool<class_bool>` **input_6/auto_advance** - :ref:`bool<class_bool>` **input_6/auto_advance**
@@ -728,6 +840,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_6/name: .. _class_AnimationNodeTransition_property_input_6/name:
- :ref:`String<class_String>` **input_6/name** - :ref:`String<class_String>` **input_6/name**
@@ -738,6 +852,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_7/auto_advance: .. _class_AnimationNodeTransition_property_input_7/auto_advance:
- :ref:`bool<class_bool>` **input_7/auto_advance** - :ref:`bool<class_bool>` **input_7/auto_advance**
@@ -748,6 +864,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_7/name: .. _class_AnimationNodeTransition_property_input_7/name:
- :ref:`String<class_String>` **input_7/name** - :ref:`String<class_String>` **input_7/name**
@@ -758,6 +876,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_8/auto_advance: .. _class_AnimationNodeTransition_property_input_8/auto_advance:
- :ref:`bool<class_bool>` **input_8/auto_advance** - :ref:`bool<class_bool>` **input_8/auto_advance**
@@ -768,6 +888,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_8/name: .. _class_AnimationNodeTransition_property_input_8/name:
- :ref:`String<class_String>` **input_8/name** - :ref:`String<class_String>` **input_8/name**
@@ -778,6 +900,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_9/auto_advance: .. _class_AnimationNodeTransition_property_input_9/auto_advance:
- :ref:`bool<class_bool>` **input_9/auto_advance** - :ref:`bool<class_bool>` **input_9/auto_advance**
@@ -788,6 +912,8 @@ Property Descriptions
| *Getter* | is_input_set_as_auto_advance() | | *Getter* | is_input_set_as_auto_advance() |
+----------+----------------------------------+ +----------+----------------------------------+
----
.. _class_AnimationNodeTransition_property_input_9/name: .. _class_AnimationNodeTransition_property_input_9/name:
- :ref:`String<class_String>` **input_9/name** - :ref:`String<class_String>` **input_9/name**
@@ -798,6 +924,8 @@ Property Descriptions
| *Getter* | get_input_caption() | | *Getter* | get_input_caption() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AnimationNodeTransition_property_input_count: .. _class_AnimationNodeTransition_property_input_count:
- :ref:`int<class_int>` **input_count** - :ref:`int<class_int>` **input_count**
@@ -808,6 +936,8 @@ Property Descriptions
| *Getter* | get_enabled_inputs() | | *Getter* | get_enabled_inputs() |
+----------+---------------------------+ +----------+---------------------------+
----
.. _class_AnimationNodeTransition_property_xfade_time: .. _class_AnimationNodeTransition_property_xfade_time:
- :ref:`float<class_float>` **xfade_time** - :ref:`float<class_float>` **xfade_time**

66
classes/class_animationplayer.rst
View File

@@ -101,18 +101,24 @@ Signals
If the currently being played animation changes, this signal will notify of such change. If the currently being played animation changes, this signal will notify of such change.
----
.. _class_AnimationPlayer_signal_animation_finished: .. _class_AnimationPlayer_signal_animation_finished:
- **animation_finished** **(** :ref:`String<class_String>` anim_name **)** - **animation_finished** **(** :ref:`String<class_String>` anim_name **)**
Notifies when an animation finished playing. Notifies when an animation finished playing.
----
.. _class_AnimationPlayer_signal_animation_started: .. _class_AnimationPlayer_signal_animation_started:
- **animation_started** **(** :ref:`String<class_String>` anim_name **)** - **animation_started** **(** :ref:`String<class_String>` anim_name **)**
Notifies when an animation starts playing. Notifies when an animation starts playing.
----
.. _class_AnimationPlayer_signal_caches_cleared: .. _class_AnimationPlayer_signal_caches_cleared:
- **caches_cleared** **(** **)** - **caches_cleared** **(** **)**
@@ -163,6 +169,8 @@ Property Descriptions
If playing, the current animation; otherwise, the animation last played. When set, would change the animation, but would not play it unless currently playing. See also :ref:`current_animation<class_AnimationPlayer_property_current_animation>`. If playing, the current animation; otherwise, the animation last played. When set, would change the animation, but would not play it unless currently playing. See also :ref:`current_animation<class_AnimationPlayer_property_current_animation>`.
----
.. _class_AnimationPlayer_property_autoplay: .. _class_AnimationPlayer_property_autoplay:
- :ref:`String<class_String>` **autoplay** - :ref:`String<class_String>` **autoplay**
@@ -175,6 +183,8 @@ If playing, the current animation; otherwise, the animation last played. When se
The name of the animation to play when the scene loads. Default value: ``""``. The name of the animation to play when the scene loads. Default value: ``""``.
----
.. _class_AnimationPlayer_property_current_animation: .. _class_AnimationPlayer_property_current_animation:
- :ref:`String<class_String>` **current_animation** - :ref:`String<class_String>` **current_animation**
@@ -187,6 +197,8 @@ The name of the animation to play when the scene loads. Default value: ``""``.
The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also :ref:`play<class_AnimationPlayer_method_play>`. Default value: ``""``. The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also :ref:`play<class_AnimationPlayer_method_play>`. Default value: ``""``.
----
.. _class_AnimationPlayer_property_current_animation_length: .. _class_AnimationPlayer_property_current_animation_length:
- :ref:`float<class_float>` **current_animation_length** - :ref:`float<class_float>` **current_animation_length**
@@ -197,6 +209,8 @@ The name of the current animation, "" if not playing anything. When being set, d
The length (in seconds) of the currently being played animation. The length (in seconds) of the currently being played animation.
----
.. _class_AnimationPlayer_property_current_animation_position: .. _class_AnimationPlayer_property_current_animation_position:
- :ref:`float<class_float>` **current_animation_position** - :ref:`float<class_float>` **current_animation_position**
@@ -207,6 +221,8 @@ The length (in seconds) of the currently being played animation.
The position (in seconds) of the currently playing animation. The position (in seconds) of the currently playing animation.
----
.. _class_AnimationPlayer_property_playback_active: .. _class_AnimationPlayer_property_playback_active:
- :ref:`bool<class_bool>` **playback_active** - :ref:`bool<class_bool>` **playback_active**
@@ -219,6 +235,8 @@ The position (in seconds) of the currently playing animation.
If ``true``, updates animations in response to process-related notifications. Default value: ``true``. If ``true``, updates animations in response to process-related notifications. Default value: ``true``.
----
.. _class_AnimationPlayer_property_playback_default_blend_time: .. _class_AnimationPlayer_property_playback_default_blend_time:
- :ref:`float<class_float>` **playback_default_blend_time** - :ref:`float<class_float>` **playback_default_blend_time**
@@ -231,6 +249,8 @@ If ``true``, updates animations in response to process-related notifications. De
The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: ``0``. The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: ``0``.
----
.. _class_AnimationPlayer_property_playback_process_mode: .. _class_AnimationPlayer_property_playback_process_mode:
- :ref:`AnimationProcessMode<enum_AnimationPlayer_AnimationProcessMode>` **playback_process_mode** - :ref:`AnimationProcessMode<enum_AnimationPlayer_AnimationProcessMode>` **playback_process_mode**
@@ -243,6 +263,8 @@ The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 p
The process notification in which to update animations. Default value: :ref:`ANIMATION_PROCESS_IDLE<class_AnimationPlayer_constant_ANIMATION_PROCESS_IDLE>`. The process notification in which to update animations. Default value: :ref:`ANIMATION_PROCESS_IDLE<class_AnimationPlayer_constant_ANIMATION_PROCESS_IDLE>`.
----
.. _class_AnimationPlayer_property_playback_speed: .. _class_AnimationPlayer_property_playback_speed:
- :ref:`float<class_float>` **playback_speed** - :ref:`float<class_float>` **playback_speed**
@@ -255,6 +277,8 @@ The process notification in which to update animations. Default value: :ref:`ANI
The speed scaling ratio. For instance, if this value is 1 then the animation plays at normal speed. If it's 0.5 then it plays at half speed. If it's 2 then it plays at double speed. Default value: ``1``. The speed scaling ratio. For instance, if this value is 1 then the animation plays at normal speed. If it's 0.5 then it plays at half speed. If it's 2 then it plays at double speed. Default value: ``1``.
----
.. _class_AnimationPlayer_property_root_node: .. _class_AnimationPlayer_property_root_node:
- :ref:`NodePath<class_NodePath>` **root_node** - :ref:`NodePath<class_NodePath>` **root_node**
@@ -276,82 +300,110 @@ Method Descriptions
Adds ``animation`` to the player accessible with the key ``name``. Adds ``animation`` to the player accessible with the key ``name``.
----
.. _class_AnimationPlayer_method_advance: .. _class_AnimationPlayer_method_advance:
- void **advance** **(** :ref:`float<class_float>` delta **)** - void **advance** **(** :ref:`float<class_float>` delta **)**
Shifts position in the animation timeline. Delta is the time in seconds to shift. Events between the current frame and ``delta`` are handled. Shifts position in the animation timeline. Delta is the time in seconds to shift. Events between the current frame and ``delta`` are handled.
----
.. _class_AnimationPlayer_method_animation_get_next: .. _class_AnimationPlayer_method_animation_get_next:
- :ref:`String<class_String>` **animation_get_next** **(** :ref:`String<class_String>` anim_from **)** const - :ref:`String<class_String>` **animation_get_next** **(** :ref:`String<class_String>` anim_from **)** const
Returns the name of the next animation in the queue. Returns the name of the next animation in the queue.
----
.. _class_AnimationPlayer_method_animation_set_next: .. _class_AnimationPlayer_method_animation_set_next:
- void **animation_set_next** **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to **)** - void **animation_set_next** **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to **)**
Triggers the ``anim_to`` animation when the ``anim_from`` animation completes. Triggers the ``anim_to`` animation when the ``anim_from`` animation completes.
----
.. _class_AnimationPlayer_method_clear_caches: .. _class_AnimationPlayer_method_clear_caches:
- void **clear_caches** **(** **)** - void **clear_caches** **(** **)**
``AnimationPlayer`` caches animated nodes. It may not notice if a node disappears, so clear_caches forces it to update the cache again. ``AnimationPlayer`` caches animated nodes. It may not notice if a node disappears, so clear_caches forces it to update the cache again.
----
.. _class_AnimationPlayer_method_clear_queue: .. _class_AnimationPlayer_method_clear_queue:
- void **clear_queue** **(** **)** - void **clear_queue** **(** **)**
Clears all queued, unplayed animations. Clears all queued, unplayed animations.
----
.. _class_AnimationPlayer_method_find_animation: .. _class_AnimationPlayer_method_find_animation:
- :ref:`String<class_String>` **find_animation** **(** :ref:`Animation<class_Animation>` animation **)** const - :ref:`String<class_String>` **find_animation** **(** :ref:`Animation<class_Animation>` animation **)** const
Returns the name of ``animation`` or empty string if not found. Returns the name of ``animation`` or empty string if not found.
----
.. _class_AnimationPlayer_method_get_animation: .. _class_AnimationPlayer_method_get_animation:
- :ref:`Animation<class_Animation>` **get_animation** **(** :ref:`String<class_String>` name **)** const - :ref:`Animation<class_Animation>` **get_animation** **(** :ref:`String<class_String>` name **)** const
Returns the :ref:`Animation<class_Animation>` with key ``name`` or ``null`` if not found. Returns the :ref:`Animation<class_Animation>` with key ``name`` or ``null`` if not found.
----
.. _class_AnimationPlayer_method_get_animation_list: .. _class_AnimationPlayer_method_get_animation_list:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_animation_list** **(** **)** const - :ref:`PoolStringArray<class_PoolStringArray>` **get_animation_list** **(** **)** const
Returns the list of stored animation names. Returns the list of stored animation names.
----
.. _class_AnimationPlayer_method_get_blend_time: .. _class_AnimationPlayer_method_get_blend_time:
- :ref:`float<class_float>` **get_blend_time** **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to **)** const - :ref:`float<class_float>` **get_blend_time** **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to **)** const
Get the blend time (in seconds) between two animations, referenced by their names. Get the blend time (in seconds) between two animations, referenced by their names.
----
.. _class_AnimationPlayer_method_get_playing_speed: .. _class_AnimationPlayer_method_get_playing_speed:
- :ref:`float<class_float>` **get_playing_speed** **(** **)** const - :ref:`float<class_float>` **get_playing_speed** **(** **)** const
Get the actual playing speed of current animation or 0 if not playing. This speed is the ``playback_speed`` property multiplied by ``custom_speed`` argument specified when calling the ``play`` method. Get the actual playing speed of current animation or 0 if not playing. This speed is the ``playback_speed`` property multiplied by ``custom_speed`` argument specified when calling the ``play`` method.
----
.. _class_AnimationPlayer_method_get_queue: .. _class_AnimationPlayer_method_get_queue:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_queue** **(** **)** - :ref:`PoolStringArray<class_PoolStringArray>` **get_queue** **(** **)**
----
.. _class_AnimationPlayer_method_has_animation: .. _class_AnimationPlayer_method_has_animation:
- :ref:`bool<class_bool>` **has_animation** **(** :ref:`String<class_String>` name **)** const - :ref:`bool<class_bool>` **has_animation** **(** :ref:`String<class_String>` name **)** const
Returns ``true`` if the ``AnimationPlayer`` stores an :ref:`Animation<class_Animation>` with key ``name``. Returns ``true`` if the ``AnimationPlayer`` stores an :ref:`Animation<class_Animation>` with key ``name``.
----
.. _class_AnimationPlayer_method_is_playing: .. _class_AnimationPlayer_method_is_playing:
- :ref:`bool<class_bool>` **is_playing** **(** **)** const - :ref:`bool<class_bool>` **is_playing** **(** **)** const
Returns ``true`` if playing an animation. Returns ``true`` if playing an animation.
----
.. _class_AnimationPlayer_method_play: .. _class_AnimationPlayer_method_play:
- void **play** **(** :ref:`String<class_String>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1.0, :ref:`bool<class_bool>` from_end=false **)** - void **play** **(** :ref:`String<class_String>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1.0, :ref:`bool<class_bool>` from_end=false **)**
@@ -360,6 +412,8 @@ Play the animation with key ``name``. Custom speed and blend times can be set. I
If the animation has been paused by ``stop(true)`` it will be resumed. Calling ``play()`` without arguments will also resume the animation. If the animation has been paused by ``stop(true)`` it will be resumed. Calling ``play()`` without arguments will also resume the animation.
----
.. _class_AnimationPlayer_method_play_backwards: .. _class_AnimationPlayer_method_play_backwards:
- void **play_backwards** **(** :ref:`String<class_String>` name="", :ref:`float<class_float>` custom_blend=-1 **)** - void **play_backwards** **(** :ref:`String<class_String>` name="", :ref:`float<class_float>` custom_blend=-1 **)**
@@ -368,36 +422,48 @@ Play the animation with key ``name`` in reverse.
If the animation has been paused by ``stop(true)`` it will be resumed backwards. Calling ``play_backwards()`` without arguments will also resume the animation backwards. If the animation has been paused by ``stop(true)`` it will be resumed backwards. Calling ``play_backwards()`` without arguments will also resume the animation backwards.
----
.. _class_AnimationPlayer_method_queue: .. _class_AnimationPlayer_method_queue:
- void **queue** **(** :ref:`String<class_String>` name **)** - void **queue** **(** :ref:`String<class_String>` name **)**
Queue an animation for playback once the current one is done. Queue an animation for playback once the current one is done.
----
.. _class_AnimationPlayer_method_remove_animation: .. _class_AnimationPlayer_method_remove_animation:
- void **remove_animation** **(** :ref:`String<class_String>` name **)** - void **remove_animation** **(** :ref:`String<class_String>` name **)**
Remove the animation with key ``name``. Remove the animation with key ``name``.
----
.. _class_AnimationPlayer_method_rename_animation: .. _class_AnimationPlayer_method_rename_animation:
- void **rename_animation** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` newname **)** - void **rename_animation** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` newname **)**
Rename an existing animation with key ``name`` to ``newname``. Rename an existing animation with key ``name`` to ``newname``.
----
.. _class_AnimationPlayer_method_seek: .. _class_AnimationPlayer_method_seek:
- void **seek** **(** :ref:`float<class_float>` seconds, :ref:`bool<class_bool>` update=false **)** - void **seek** **(** :ref:`float<class_float>` seconds, :ref:`bool<class_bool>` update=false **)**
Seek the animation to the ``seconds`` point in time (in seconds). If ``update`` is ``true``, the animation updates too, otherwise it updates at process time. Events between the current frame and ``seconds`` are skipped. Seek the animation to the ``seconds`` point in time (in seconds). If ``update`` is ``true``, the animation updates too, otherwise it updates at process time. Events between the current frame and ``seconds`` are skipped.
----
.. _class_AnimationPlayer_method_set_blend_time: .. _class_AnimationPlayer_method_set_blend_time:
- void **set_blend_time** **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to, :ref:`float<class_float>` sec **)** - void **set_blend_time** **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to, :ref:`float<class_float>` sec **)**
Specify a blend time (in seconds) between two animations, referenced by their names. Specify a blend time (in seconds) between two animations, referenced by their names.
----
.. _class_AnimationPlayer_method_stop: .. _class_AnimationPlayer_method_stop:
- void **stop** **(** :ref:`bool<class_bool>` reset=true **)** - void **stop** **(** :ref:`bool<class_bool>` reset=true **)**

12
classes/class_animationtree.rst
View File

@@ -83,6 +83,8 @@ Property Descriptions
| *Getter* | is_active() | | *Getter* | is_active() |
+----------+-------------------+ +----------+-------------------+
----
.. _class_AnimationTree_property_anim_player: .. _class_AnimationTree_property_anim_player:
- :ref:`NodePath<class_NodePath>` **anim_player** - :ref:`NodePath<class_NodePath>` **anim_player**
@@ -93,6 +95,8 @@ Property Descriptions
| *Getter* | get_animation_player() | | *Getter* | get_animation_player() |
+----------+-----------------------------+ +----------+-----------------------------+
----
.. _class_AnimationTree_property_process_mode: .. _class_AnimationTree_property_process_mode:
- :ref:`AnimationProcessMode<enum_AnimationTree_AnimationProcessMode>` **process_mode** - :ref:`AnimationProcessMode<enum_AnimationTree_AnimationProcessMode>` **process_mode**
@@ -103,6 +107,8 @@ Property Descriptions
| *Getter* | get_process_mode() | | *Getter* | get_process_mode() |
+----------+-------------------------+ +----------+-------------------------+
----
.. _class_AnimationTree_property_root_motion_track: .. _class_AnimationTree_property_root_motion_track:
- :ref:`NodePath<class_NodePath>` **root_motion_track** - :ref:`NodePath<class_NodePath>` **root_motion_track**
@@ -113,6 +119,8 @@ Property Descriptions
| *Getter* | get_root_motion_track() | | *Getter* | get_root_motion_track() |
+----------+------------------------------+ +----------+------------------------------+
----
.. _class_AnimationTree_property_tree_root: .. _class_AnimationTree_property_tree_root:
- :ref:`AnimationNode<class_AnimationNode>` **tree_root** - :ref:`AnimationNode<class_AnimationNode>` **tree_root**
@@ -130,10 +138,14 @@ Method Descriptions
- void **advance** **(** :ref:`float<class_float>` delta **)** - void **advance** **(** :ref:`float<class_float>` delta **)**
----
.. _class_AnimationTree_method_get_root_motion_transform: .. _class_AnimationTree_method_get_root_motion_transform:
- :ref:`Transform<class_Transform>` **get_root_motion_transform** **(** **)** const - :ref:`Transform<class_Transform>` **get_root_motion_transform** **(** **)** const
----
.. _class_AnimationTree_method_rename_parameter: .. _class_AnimationTree_method_rename_parameter:
- void **rename_parameter** **(** :ref:`String<class_String>` old_name, :ref:`String<class_String>` new_name **)** - void **rename_parameter** **(** :ref:`String<class_String>` old_name, :ref:`String<class_String>` new_name **)**

120
classes/class_animationtreeplayer.rst
View File

@@ -197,6 +197,8 @@ enum **NodeType**:
- **NODE_TRANSITION** = **9** --- Transition node. - **NODE_TRANSITION** = **9** --- Transition node.
----
.. _enum_AnimationTreePlayer_AnimationProcessMode: .. _enum_AnimationTreePlayer_AnimationProcessMode:
.. _class_AnimationTreePlayer_constant_ANIMATION_PROCESS_PHYSICS: .. _class_AnimationTreePlayer_constant_ANIMATION_PROCESS_PHYSICS:
@@ -231,6 +233,8 @@ Property Descriptions
If ``true``, the ``AnimationTreePlayer`` is able to play animations. Default value: ``false``. If ``true``, the ``AnimationTreePlayer`` is able to play animations. Default value: ``false``.
----
.. _class_AnimationTreePlayer_property_base_path: .. _class_AnimationTreePlayer_property_base_path:
- :ref:`NodePath<class_NodePath>` **base_path** - :ref:`NodePath<class_NodePath>` **base_path**
@@ -245,6 +249,8 @@ The node from which to relatively access other nodes. Default value: ``".."``.
It accesses the Bones, so it should point to the same Node the AnimationPlayer would point its Root Node at. It accesses the Bones, so it should point to the same Node the AnimationPlayer would point its Root Node at.
----
.. _class_AnimationTreePlayer_property_master_player: .. _class_AnimationTreePlayer_property_master_player:
- :ref:`NodePath<class_NodePath>` **master_player** - :ref:`NodePath<class_NodePath>` **master_player**
@@ -259,6 +265,8 @@ The path to the :ref:`AnimationPlayer<class_AnimationPlayer>` from which this ``
Once set, Animation nodes can be added to the AnimationTreePlayer. Once set, Animation nodes can be added to the AnimationTreePlayer.
----
.. _class_AnimationTreePlayer_property_playback_process_mode: .. _class_AnimationTreePlayer_property_playback_process_mode:
- :ref:`AnimationProcessMode<enum_AnimationTreePlayer_AnimationProcessMode>` **playback_process_mode** - :ref:`AnimationProcessMode<enum_AnimationTreePlayer_AnimationProcessMode>` **playback_process_mode**
@@ -280,58 +288,78 @@ Method Descriptions
Adds a ``type`` node to the graph with name ``id``. Adds a ``type`` node to the graph with name ``id``.
----
.. _class_AnimationTreePlayer_method_advance: .. _class_AnimationTreePlayer_method_advance:
- void **advance** **(** :ref:`float<class_float>` delta **)** - void **advance** **(** :ref:`float<class_float>` delta **)**
Shifts position in the animation timeline. Delta is the time in seconds to shift. Events between the current frame and ``delta`` are handled. Shifts position in the animation timeline. Delta is the time in seconds to shift. Events between the current frame and ``delta`` are handled.
----
.. _class_AnimationTreePlayer_method_animation_node_get_animation: .. _class_AnimationTreePlayer_method_animation_node_get_animation:
- :ref:`Animation<class_Animation>` **animation_node_get_animation** **(** :ref:`String<class_String>` id **)** const - :ref:`Animation<class_Animation>` **animation_node_get_animation** **(** :ref:`String<class_String>` id **)** const
Returns the :ref:`AnimationPlayer<class_AnimationPlayer>`'s :ref:`Animation<class_Animation>` bound to the ``AnimationTreePlayer``'s animation node with name ``id``. Returns the :ref:`AnimationPlayer<class_AnimationPlayer>`'s :ref:`Animation<class_Animation>` bound to the ``AnimationTreePlayer``'s animation node with name ``id``.
----
.. _class_AnimationTreePlayer_method_animation_node_get_master_animation: .. _class_AnimationTreePlayer_method_animation_node_get_master_animation:
- :ref:`String<class_String>` **animation_node_get_master_animation** **(** :ref:`String<class_String>` id **)** const - :ref:`String<class_String>` **animation_node_get_master_animation** **(** :ref:`String<class_String>` id **)** const
Returns the name of the :ref:`master_player<class_AnimationTreePlayer_property_master_player>`'s :ref:`Animation<class_Animation>` bound to this animation node. Returns the name of the :ref:`master_player<class_AnimationTreePlayer_property_master_player>`'s :ref:`Animation<class_Animation>` bound to this animation node.
----
.. _class_AnimationTreePlayer_method_animation_node_get_position: .. _class_AnimationTreePlayer_method_animation_node_get_position:
- :ref:`float<class_float>` **animation_node_get_position** **(** :ref:`String<class_String>` id **)** const - :ref:`float<class_float>` **animation_node_get_position** **(** :ref:`String<class_String>` id **)** const
----
.. _class_AnimationTreePlayer_method_animation_node_set_animation: .. _class_AnimationTreePlayer_method_animation_node_set_animation:
- void **animation_node_set_animation** **(** :ref:`String<class_String>` id, :ref:`Animation<class_Animation>` animation **)** - void **animation_node_set_animation** **(** :ref:`String<class_String>` id, :ref:`Animation<class_Animation>` animation **)**
Binds a new :ref:`Animation<class_Animation>` from the :ref:`master_player<class_AnimationTreePlayer_property_master_player>` to the ``AnimationTreePlayer``'s animation node with name ``id``. Binds a new :ref:`Animation<class_Animation>` from the :ref:`master_player<class_AnimationTreePlayer_property_master_player>` to the ``AnimationTreePlayer``'s animation node with name ``id``.
----
.. _class_AnimationTreePlayer_method_animation_node_set_filter_path: .. _class_AnimationTreePlayer_method_animation_node_set_filter_path:
- void **animation_node_set_filter_path** **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)** - void **animation_node_set_filter_path** **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)**
If ``enable`` is ``true``, the animation node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate. If ``enable`` is ``true``, the animation node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate.
----
.. _class_AnimationTreePlayer_method_animation_node_set_master_animation: .. _class_AnimationTreePlayer_method_animation_node_set_master_animation:
- void **animation_node_set_master_animation** **(** :ref:`String<class_String>` id, :ref:`String<class_String>` source **)** - void **animation_node_set_master_animation** **(** :ref:`String<class_String>` id, :ref:`String<class_String>` source **)**
Binds the :ref:`Animation<class_Animation>` named ``source`` from :ref:`master_player<class_AnimationTreePlayer_property_master_player>` to the animation node ``id``. Recalculates caches. Binds the :ref:`Animation<class_Animation>` named ``source`` from :ref:`master_player<class_AnimationTreePlayer_property_master_player>` to the animation node ``id``. Recalculates caches.
----
.. _class_AnimationTreePlayer_method_are_nodes_connected: .. _class_AnimationTreePlayer_method_are_nodes_connected:
- :ref:`bool<class_bool>` **are_nodes_connected** **(** :ref:`String<class_String>` id, :ref:`String<class_String>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const - :ref:`bool<class_bool>` **are_nodes_connected** **(** :ref:`String<class_String>` id, :ref:`String<class_String>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const
Returns whether node ``id`` and ``dst_id`` are connected at the specified slot. Returns whether node ``id`` and ``dst_id`` are connected at the specified slot.
----
.. _class_AnimationTreePlayer_method_blend2_node_get_amount: .. _class_AnimationTreePlayer_method_blend2_node_get_amount:
- :ref:`float<class_float>` **blend2_node_get_amount** **(** :ref:`String<class_String>` id **)** const - :ref:`float<class_float>` **blend2_node_get_amount** **(** :ref:`String<class_String>` id **)** const
Returns the blend amount of a Blend2 node given its name. Returns the blend amount of a Blend2 node given its name.
----
.. _class_AnimationTreePlayer_method_blend2_node_set_amount: .. _class_AnimationTreePlayer_method_blend2_node_set_amount:
- void **blend2_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` blend **)** - void **blend2_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` blend **)**
@@ -346,18 +374,24 @@ Towards 1, the influence of a gets lessened, the influence of b gets raised.
At 1, Output is input b. At 1, Output is input b.
----
.. _class_AnimationTreePlayer_method_blend2_node_set_filter_path: .. _class_AnimationTreePlayer_method_blend2_node_set_filter_path:
- void **blend2_node_set_filter_path** **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)** - void **blend2_node_set_filter_path** **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)**
If ``enable`` is ``true``, the blend2 node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate. If ``enable`` is ``true``, the blend2 node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate.
----
.. _class_AnimationTreePlayer_method_blend3_node_get_amount: .. _class_AnimationTreePlayer_method_blend3_node_get_amount:
- :ref:`float<class_float>` **blend3_node_get_amount** **(** :ref:`String<class_String>` id **)** const - :ref:`float<class_float>` **blend3_node_get_amount** **(** :ref:`String<class_String>` id **)** const
Returns the blend amount of a Blend3 node given its name. Returns the blend amount of a Blend3 node given its name.
----
.. _class_AnimationTreePlayer_method_blend3_node_set_amount: .. _class_AnimationTreePlayer_method_blend3_node_set_amount:
- void **blend3_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` blend **)** - void **blend3_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` blend **)**
@@ -376,12 +410,16 @@ From 0 to 1, the influence of a gets lessened, the influence of b+ gets raised a
At 1, Output is input b+. At 1, Output is input b+.
----
.. _class_AnimationTreePlayer_method_blend4_node_get_amount: .. _class_AnimationTreePlayer_method_blend4_node_get_amount:
- :ref:`Vector2<class_Vector2>` **blend4_node_get_amount** **(** :ref:`String<class_String>` id **)** const - :ref:`Vector2<class_Vector2>` **blend4_node_get_amount** **(** :ref:`String<class_String>` id **)** const
Returns the blend amount of a Blend4 node given its name. Returns the blend amount of a Blend4 node given its name.
----
.. _class_AnimationTreePlayer_method_blend4_node_set_amount: .. _class_AnimationTreePlayer_method_blend4_node_set_amount:
- void **blend4_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`Vector2<class_Vector2>` blend **)** - void **blend4_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`Vector2<class_Vector2>` blend **)**
@@ -392,30 +430,40 @@ A Blend4 Node blends two pairs of animations.
The two pairs are blended like blend2 and then added together. The two pairs are blended like blend2 and then added together.
----
.. _class_AnimationTreePlayer_method_connect_nodes: .. _class_AnimationTreePlayer_method_connect_nodes:
- :ref:`Error<enum_@GlobalScope_Error>` **connect_nodes** **(** :ref:`String<class_String>` id, :ref:`String<class_String>` dst_id, :ref:`int<class_int>` dst_input_idx **)** - :ref:`Error<enum_@GlobalScope_Error>` **connect_nodes** **(** :ref:`String<class_String>` id, :ref:`String<class_String>` dst_id, :ref:`int<class_int>` dst_input_idx **)**
Connects node ``id`` to ``dst_id`` at the specified input slot. Connects node ``id`` to ``dst_id`` at the specified input slot.
----
.. _class_AnimationTreePlayer_method_disconnect_nodes: .. _class_AnimationTreePlayer_method_disconnect_nodes:
- void **disconnect_nodes** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` dst_input_idx **)** - void **disconnect_nodes** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` dst_input_idx **)**
Disconnects nodes connected to ``id`` at the specified input slot. Disconnects nodes connected to ``id`` at the specified input slot.
----
.. _class_AnimationTreePlayer_method_get_node_list: .. _class_AnimationTreePlayer_method_get_node_list:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_node_list** **(** **)** - :ref:`PoolStringArray<class_PoolStringArray>` **get_node_list** **(** **)**
Returns a :ref:`PoolStringArray<class_PoolStringArray>` containing the name of all nodes. Returns a :ref:`PoolStringArray<class_PoolStringArray>` containing the name of all nodes.
----
.. _class_AnimationTreePlayer_method_mix_node_get_amount: .. _class_AnimationTreePlayer_method_mix_node_get_amount:
- :ref:`float<class_float>` **mix_node_get_amount** **(** :ref:`String<class_String>` id **)** const - :ref:`float<class_float>` **mix_node_get_amount** **(** :ref:`String<class_String>` id **)** const
Returns mix amount of a Mix node given its name. Returns mix amount of a Mix node given its name.
----
.. _class_AnimationTreePlayer_method_mix_node_set_amount: .. _class_AnimationTreePlayer_method_mix_node_set_amount:
- void **mix_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` ratio **)** - void **mix_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` ratio **)**
@@ -424,156 +472,208 @@ Sets mix amount of a Mix node given its name and value.
A Mix node adds input b to input a by a the amount given by ratio. A Mix node adds input b to input a by a the amount given by ratio.
----
.. _class_AnimationTreePlayer_method_node_exists: .. _class_AnimationTreePlayer_method_node_exists:
- :ref:`bool<class_bool>` **node_exists** **(** :ref:`String<class_String>` node **)** const - :ref:`bool<class_bool>` **node_exists** **(** :ref:`String<class_String>` node **)** const
Check if a node exists (by name). Check if a node exists (by name).
----
.. _class_AnimationTreePlayer_method_node_get_input_count: .. _class_AnimationTreePlayer_method_node_get_input_count:
- :ref:`int<class_int>` **node_get_input_count** **(** :ref:`String<class_String>` id **)** const - :ref:`int<class_int>` **node_get_input_count** **(** :ref:`String<class_String>` id **)** const
Returns the input count for a given node. Different types of nodes have different amount of inputs. Returns the input count for a given node. Different types of nodes have different amount of inputs.
----
.. _class_AnimationTreePlayer_method_node_get_input_source: .. _class_AnimationTreePlayer_method_node_get_input_source:
- :ref:`String<class_String>` **node_get_input_source** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` idx **)** const - :ref:`String<class_String>` **node_get_input_source** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` idx **)** const
Returns the input source for a given node input. Returns the input source for a given node input.
----
.. _class_AnimationTreePlayer_method_node_get_position: .. _class_AnimationTreePlayer_method_node_get_position:
- :ref:`Vector2<class_Vector2>` **node_get_position** **(** :ref:`String<class_String>` id **)** const - :ref:`Vector2<class_Vector2>` **node_get_position** **(** :ref:`String<class_String>` id **)** const
Returns position of a node in the graph given its name. Returns position of a node in the graph given its name.
----
.. _class_AnimationTreePlayer_method_node_get_type: .. _class_AnimationTreePlayer_method_node_get_type:
- :ref:`NodeType<enum_AnimationTreePlayer_NodeType>` **node_get_type** **(** :ref:`String<class_String>` id **)** const - :ref:`NodeType<enum_AnimationTreePlayer_NodeType>` **node_get_type** **(** :ref:`String<class_String>` id **)** const
Get the node type, will return from NODE\_\* enum. Get the node type, will return from NODE\_\* enum.
----
.. _class_AnimationTreePlayer_method_node_rename: .. _class_AnimationTreePlayer_method_node_rename:
- :ref:`Error<enum_@GlobalScope_Error>` **node_rename** **(** :ref:`String<class_String>` node, :ref:`String<class_String>` new_name **)** - :ref:`Error<enum_@GlobalScope_Error>` **node_rename** **(** :ref:`String<class_String>` node, :ref:`String<class_String>` new_name **)**
Rename a node in the graph. Rename a node in the graph.
----
.. _class_AnimationTreePlayer_method_node_set_position: .. _class_AnimationTreePlayer_method_node_set_position:
- void **node_set_position** **(** :ref:`String<class_String>` id, :ref:`Vector2<class_Vector2>` screen_position **)** - void **node_set_position** **(** :ref:`String<class_String>` id, :ref:`Vector2<class_Vector2>` screen_position **)**
Sets position of a node in the graph given its name and position. Sets position of a node in the graph given its name and position.
----
.. _class_AnimationTreePlayer_method_oneshot_node_get_autorestart_delay: .. _class_AnimationTreePlayer_method_oneshot_node_get_autorestart_delay:
- :ref:`float<class_float>` **oneshot_node_get_autorestart_delay** **(** :ref:`String<class_String>` id **)** const - :ref:`float<class_float>` **oneshot_node_get_autorestart_delay** **(** :ref:`String<class_String>` id **)** const
Returns autostart delay of a OneShot node given its name. Returns autostart delay of a OneShot node given its name.
----
.. _class_AnimationTreePlayer_method_oneshot_node_get_autorestart_random_delay: .. _class_AnimationTreePlayer_method_oneshot_node_get_autorestart_random_delay:
- :ref:`float<class_float>` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String<class_String>` id **)** const - :ref:`float<class_float>` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String<class_String>` id **)** const
Returns autostart random delay of a OneShot node given its name. Returns autostart random delay of a OneShot node given its name.
----
.. _class_AnimationTreePlayer_method_oneshot_node_get_fadein_time: .. _class_AnimationTreePlayer_method_oneshot_node_get_fadein_time:
- :ref:`float<class_float>` **oneshot_node_get_fadein_time** **(** :ref:`String<class_String>` id **)** const - :ref:`float<class_float>` **oneshot_node_get_fadein_time** **(** :ref:`String<class_String>` id **)** const
Returns fade in time of a OneShot node given its name. Returns fade in time of a OneShot node given its name.
----
.. _class_AnimationTreePlayer_method_oneshot_node_get_fadeout_time: .. _class_AnimationTreePlayer_method_oneshot_node_get_fadeout_time:
- :ref:`float<class_float>` **oneshot_node_get_fadeout_time** **(** :ref:`String<class_String>` id **)** const - :ref:`float<class_float>` **oneshot_node_get_fadeout_time** **(** :ref:`String<class_String>` id **)** const
Returns fade out time of a OneShot node given its name. Returns fade out time of a OneShot node given its name.
----
.. _class_AnimationTreePlayer_method_oneshot_node_has_autorestart: .. _class_AnimationTreePlayer_method_oneshot_node_has_autorestart:
- :ref:`bool<class_bool>` **oneshot_node_has_autorestart** **(** :ref:`String<class_String>` id **)** const - :ref:`bool<class_bool>` **oneshot_node_has_autorestart** **(** :ref:`String<class_String>` id **)** const
Returns whether a OneShot node will auto restart given its name. Returns whether a OneShot node will auto restart given its name.
----
.. _class_AnimationTreePlayer_method_oneshot_node_is_active: .. _class_AnimationTreePlayer_method_oneshot_node_is_active:
- :ref:`bool<class_bool>` **oneshot_node_is_active** **(** :ref:`String<class_String>` id **)** const - :ref:`bool<class_bool>` **oneshot_node_is_active** **(** :ref:`String<class_String>` id **)** const
Returns whether a OneShot node is active given its name. Returns whether a OneShot node is active given its name.
----
.. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart: .. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart:
- void **oneshot_node_set_autorestart** **(** :ref:`String<class_String>` id, :ref:`bool<class_bool>` enable **)** - void **oneshot_node_set_autorestart** **(** :ref:`String<class_String>` id, :ref:`bool<class_bool>` enable **)**
Sets autorestart property of a OneShot node given its name and value. Sets autorestart property of a OneShot node given its name and value.
----
.. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart_delay: .. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart_delay:
- void **oneshot_node_set_autorestart_delay** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` delay_sec **)** - void **oneshot_node_set_autorestart_delay** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` delay_sec **)**
Sets autorestart delay of a OneShot node given its name and value in seconds. Sets autorestart delay of a OneShot node given its name and value in seconds.
----
.. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart_random_delay: .. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart_random_delay:
- void **oneshot_node_set_autorestart_random_delay** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` rand_sec **)** - void **oneshot_node_set_autorestart_random_delay** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` rand_sec **)**
Sets autorestart random delay of a OneShot node given its name and value in seconds. Sets autorestart random delay of a OneShot node given its name and value in seconds.
----
.. _class_AnimationTreePlayer_method_oneshot_node_set_fadein_time: .. _class_AnimationTreePlayer_method_oneshot_node_set_fadein_time:
- void **oneshot_node_set_fadein_time** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)** - void **oneshot_node_set_fadein_time** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)**
Sets fade in time of a OneShot node given its name and value in seconds. Sets fade in time of a OneShot node given its name and value in seconds.
----
.. _class_AnimationTreePlayer_method_oneshot_node_set_fadeout_time: .. _class_AnimationTreePlayer_method_oneshot_node_set_fadeout_time:
- void **oneshot_node_set_fadeout_time** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)** - void **oneshot_node_set_fadeout_time** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)**
Sets fade out time of a OneShot node given its name and value in seconds. Sets fade out time of a OneShot node given its name and value in seconds.
----
.. _class_AnimationTreePlayer_method_oneshot_node_set_filter_path: .. _class_AnimationTreePlayer_method_oneshot_node_set_filter_path:
- void **oneshot_node_set_filter_path** **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)** - void **oneshot_node_set_filter_path** **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)**
If ``enable`` is ``true``, the oneshot node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate. If ``enable`` is ``true``, the oneshot node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate.
----
.. _class_AnimationTreePlayer_method_oneshot_node_start: .. _class_AnimationTreePlayer_method_oneshot_node_start:
- void **oneshot_node_start** **(** :ref:`String<class_String>` id **)** - void **oneshot_node_start** **(** :ref:`String<class_String>` id **)**
Starts a OneShot node given its name. Starts a OneShot node given its name.
----
.. _class_AnimationTreePlayer_method_oneshot_node_stop: .. _class_AnimationTreePlayer_method_oneshot_node_stop:
- void **oneshot_node_stop** **(** :ref:`String<class_String>` id **)** - void **oneshot_node_stop** **(** :ref:`String<class_String>` id **)**
Stops the OneShot node with name ``id``. Stops the OneShot node with name ``id``.
----
.. _class_AnimationTreePlayer_method_recompute_caches: .. _class_AnimationTreePlayer_method_recompute_caches:
- void **recompute_caches** **(** **)** - void **recompute_caches** **(** **)**
Manually recalculates the cache of track information generated from animation nodes. Needed when external sources modify the animation nodes' state. Manually recalculates the cache of track information generated from animation nodes. Needed when external sources modify the animation nodes' state.
----
.. _class_AnimationTreePlayer_method_remove_node: .. _class_AnimationTreePlayer_method_remove_node:
- void **remove_node** **(** :ref:`String<class_String>` id **)** - void **remove_node** **(** :ref:`String<class_String>` id **)**
Removes the animation node with name ``id``. Removes the animation node with name ``id``.
----
.. _class_AnimationTreePlayer_method_reset: .. _class_AnimationTreePlayer_method_reset:
- void **reset** **(** **)** - void **reset** **(** **)**
Resets this ``AnimationTreePlayer``. Resets this ``AnimationTreePlayer``.
----
.. _class_AnimationTreePlayer_method_timescale_node_get_scale: .. _class_AnimationTreePlayer_method_timescale_node_get_scale:
- :ref:`float<class_float>` **timescale_node_get_scale** **(** :ref:`String<class_String>` id **)** const - :ref:`float<class_float>` **timescale_node_get_scale** **(** :ref:`String<class_String>` id **)** const
Returns time scale value of the TimeScale node with name ``id``. Returns time scale value of the TimeScale node with name ``id``.
----
.. _class_AnimationTreePlayer_method_timescale_node_set_scale: .. _class_AnimationTreePlayer_method_timescale_node_set_scale:
- void **timescale_node_set_scale** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` scale **)** - void **timescale_node_set_scale** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` scale **)**
@@ -584,6 +684,8 @@ The timescale node is used to speed :ref:`Animation<class_Animation>`\ s up if t
If applied after a blend or mix, affects all input animations to that blend or mix. If applied after a blend or mix, affects all input animations to that blend or mix.
----
.. _class_AnimationTreePlayer_method_timeseek_node_seek: .. _class_AnimationTreePlayer_method_timeseek_node_seek:
- void **timeseek_node_seek** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` seconds **)** - void **timeseek_node_seek** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` seconds **)**
@@ -592,54 +694,72 @@ Sets the time seek value of the TimeSeek node with name ``id`` to ``seconds``
This functions as a seek in the :ref:`Animation<class_Animation>` or the blend or mix of :ref:`Animation<class_Animation>`\ s input in it. This functions as a seek in the :ref:`Animation<class_Animation>` or the blend or mix of :ref:`Animation<class_Animation>`\ s input in it.
----
.. _class_AnimationTreePlayer_method_transition_node_delete_input: .. _class_AnimationTreePlayer_method_transition_node_delete_input:
- void **transition_node_delete_input** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)** - void **transition_node_delete_input** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)**
Deletes the input at ``input_idx`` for the transition node with name ``id``. Deletes the input at ``input_idx`` for the transition node with name ``id``.
----
.. _class_AnimationTreePlayer_method_transition_node_get_current: .. _class_AnimationTreePlayer_method_transition_node_get_current:
- :ref:`int<class_int>` **transition_node_get_current** **(** :ref:`String<class_String>` id **)** const - :ref:`int<class_int>` **transition_node_get_current** **(** :ref:`String<class_String>` id **)** const
Returns the index of the currently evaluated input for the transition node with name ``id``. Returns the index of the currently evaluated input for the transition node with name ``id``.
----
.. _class_AnimationTreePlayer_method_transition_node_get_input_count: .. _class_AnimationTreePlayer_method_transition_node_get_input_count:
- :ref:`int<class_int>` **transition_node_get_input_count** **(** :ref:`String<class_String>` id **)** const - :ref:`int<class_int>` **transition_node_get_input_count** **(** :ref:`String<class_String>` id **)** const
Returns the number of inputs for the transition node with name ``id``. You can add inputs by rightclicking on the transition node. Returns the number of inputs for the transition node with name ``id``. You can add inputs by rightclicking on the transition node.
----
.. _class_AnimationTreePlayer_method_transition_node_get_xfade_time: .. _class_AnimationTreePlayer_method_transition_node_get_xfade_time:
- :ref:`float<class_float>` **transition_node_get_xfade_time** **(** :ref:`String<class_String>` id **)** const - :ref:`float<class_float>` **transition_node_get_xfade_time** **(** :ref:`String<class_String>` id **)** const
Returns the cross fade time for the transition node with name ``id``. Returns the cross fade time for the transition node with name ``id``.
----
.. _class_AnimationTreePlayer_method_transition_node_has_input_auto_advance: .. _class_AnimationTreePlayer_method_transition_node_has_input_auto_advance:
- :ref:`bool<class_bool>` **transition_node_has_input_auto_advance** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)** const - :ref:`bool<class_bool>` **transition_node_has_input_auto_advance** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)** const
Returns ``true`` if the input at ``input_idx`` on transition node with name ``id`` is set to automatically advance to the next input upon completion. Returns ``true`` if the input at ``input_idx`` on transition node with name ``id`` is set to automatically advance to the next input upon completion.
----
.. _class_AnimationTreePlayer_method_transition_node_set_current: .. _class_AnimationTreePlayer_method_transition_node_set_current:
- void **transition_node_set_current** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)** - void **transition_node_set_current** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)**
The transition node with name ``id`` sets its current input at ``input_idx``. The transition node with name ``id`` sets its current input at ``input_idx``.
----
.. _class_AnimationTreePlayer_method_transition_node_set_input_auto_advance: .. _class_AnimationTreePlayer_method_transition_node_set_input_auto_advance:
- void **transition_node_set_input_auto_advance** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)** - void **transition_node_set_input_auto_advance** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)**
The transition node with name ``id`` advances to its next input automatically when the input at ``input_idx`` completes. The transition node with name ``id`` advances to its next input automatically when the input at ``input_idx`` completes.
----
.. _class_AnimationTreePlayer_method_transition_node_set_input_count: .. _class_AnimationTreePlayer_method_transition_node_set_input_count:
- void **transition_node_set_input_count** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` count **)** - void **transition_node_set_input_count** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` count **)**
Resizes the number of inputs available for the transition node with name ``id``. Resizes the number of inputs available for the transition node with name ``id``.
----
.. _class_AnimationTreePlayer_method_transition_node_set_xfade_time: .. _class_AnimationTreePlayer_method_transition_node_set_xfade_time:
- void **transition_node_set_xfade_time** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)** - void **transition_node_set_xfade_time** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)**

62
classes/class_area.rst
View File

@@ -89,42 +89,56 @@ Signals
Emitted when another area enters. Emitted when another area enters.
----
.. _class_Area_signal_area_exited: .. _class_Area_signal_area_exited:
- **area_exited** **(** :ref:`Area<class_Area>` area **)** - **area_exited** **(** :ref:`Area<class_Area>` area **)**
Emitted when another area exits. Emitted when another area exits.
----
.. _class_Area_signal_area_shape_entered: .. _class_Area_signal_area_shape_entered:
- **area_shape_entered** **(** :ref:`int<class_int>` area_id, :ref:`Area<class_Area>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)** - **area_shape_entered** **(** :ref:`int<class_int>` area_id, :ref:`Area<class_Area>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
Emitted when another area enters, reporting which areas overlapped. Emitted when another area enters, reporting which areas overlapped.
----
.. _class_Area_signal_area_shape_exited: .. _class_Area_signal_area_shape_exited:
- **area_shape_exited** **(** :ref:`int<class_int>` area_id, :ref:`Area<class_Area>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)** - **area_shape_exited** **(** :ref:`int<class_int>` area_id, :ref:`Area<class_Area>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
Emitted when another area exits, reporting which areas were overlapping. Emitted when another area exits, reporting which areas were overlapping.
----
.. _class_Area_signal_body_entered: .. _class_Area_signal_body_entered:
- **body_entered** **(** :ref:`Node<class_Node>` body **)** - **body_entered** **(** :ref:`Node<class_Node>` body **)**
Emitted when a :ref:`PhysicsBody<class_PhysicsBody>` object enters. Emitted when a :ref:`PhysicsBody<class_PhysicsBody>` object enters.
----
.. _class_Area_signal_body_exited: .. _class_Area_signal_body_exited:
- **body_exited** **(** :ref:`Node<class_Node>` body **)** - **body_exited** **(** :ref:`Node<class_Node>` body **)**
Emitted when a :ref:`PhysicsBody<class_PhysicsBody>` object exits. Emitted when a :ref:`PhysicsBody<class_PhysicsBody>` object exits.
----
.. _class_Area_signal_body_shape_entered: .. _class_Area_signal_body_shape_entered:
- **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`Node<class_Node>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)** - **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`Node<class_Node>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
Emitted when a :ref:`PhysicsBody<class_PhysicsBody>` object enters, reporting which shapes overlapped. Emitted when a :ref:`PhysicsBody<class_PhysicsBody>` object enters, reporting which shapes overlapped.
----
.. _class_Area_signal_body_shape_exited: .. _class_Area_signal_body_shape_exited:
- **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`Node<class_Node>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)** - **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`Node<class_Node>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
@@ -178,6 +192,8 @@ Property Descriptions
The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping).
----
.. _class_Area_property_audio_bus_name: .. _class_Area_property_audio_bus_name:
- :ref:`String<class_String>` **audio_bus_name** - :ref:`String<class_String>` **audio_bus_name**
@@ -190,6 +206,8 @@ The rate at which objects stop spinning in this area. Represents the angular vel
The name of the area's audio bus. The name of the area's audio bus.
----
.. _class_Area_property_audio_bus_override: .. _class_Area_property_audio_bus_override:
- :ref:`bool<class_bool>` **audio_bus_override** - :ref:`bool<class_bool>` **audio_bus_override**
@@ -202,6 +220,8 @@ The name of the area's audio bus.
If ``true``, the area's audio bus overrides the default audio bus. Default value: ``false``. If ``true``, the area's audio bus overrides the default audio bus. Default value: ``false``.
----
.. _class_Area_property_collision_layer: .. _class_Area_property_collision_layer:
- :ref:`int<class_int>` **collision_layer** - :ref:`int<class_int>` **collision_layer**
@@ -214,6 +234,8 @@ If ``true``, the area's audio bus overrides the default audio bus. Default value
The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also :ref:`collision_mask<class_Area_property_collision_mask>`. The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also :ref:`collision_mask<class_Area_property_collision_mask>`.
----
.. _class_Area_property_collision_mask: .. _class_Area_property_collision_mask:
- :ref:`int<class_int>` **collision_mask** - :ref:`int<class_int>` **collision_mask**
@@ -226,6 +248,8 @@ The area's physics layer(s). Collidable objects can exist in any of 32 different
The physics layers this area scans to determine collision detection. The physics layers this area scans to determine collision detection.
----
.. _class_Area_property_gravity: .. _class_Area_property_gravity:
- :ref:`float<class_float>` **gravity** - :ref:`float<class_float>` **gravity**
@@ -238,6 +262,8 @@ The physics layers this area scans to determine collision detection.
The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction.
----
.. _class_Area_property_gravity_distance_scale: .. _class_Area_property_gravity_distance_scale:
- :ref:`float<class_float>` **gravity_distance_scale** - :ref:`float<class_float>` **gravity_distance_scale**
@@ -250,6 +276,8 @@ The area's gravity intensity (ranges from -1024 to 1024). This value multiplies
The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance.
----
.. _class_Area_property_gravity_point: .. _class_Area_property_gravity_point:
- :ref:`bool<class_bool>` **gravity_point** - :ref:`bool<class_bool>` **gravity_point**
@@ -262,6 +290,8 @@ The falloff factor for point gravity. The greater the value, the faster gravity
If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class_Area_property_gravity_vec>`). Also see :ref:`space_override<class_Area_property_space_override>`. Default value: ``false``. If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class_Area_property_gravity_vec>`). Also see :ref:`space_override<class_Area_property_space_override>`. Default value: ``false``.
----
.. _class_Area_property_gravity_vec: .. _class_Area_property_gravity_vec:
- :ref:`Vector3<class_Vector3>` **gravity_vec** - :ref:`Vector3<class_Vector3>` **gravity_vec**
@@ -274,6 +304,8 @@ If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class
The area's gravity vector (not normalized). If gravity is a point (see :ref:`gravity_point<class_Area_property_gravity_point>`), this will be the point of attraction. The area's gravity vector (not normalized). If gravity is a point (see :ref:`gravity_point<class_Area_property_gravity_point>`), this will be the point of attraction.
----
.. _class_Area_property_linear_damp: .. _class_Area_property_linear_damp:
- :ref:`float<class_float>` **linear_damp** - :ref:`float<class_float>` **linear_damp**
@@ -286,6 +318,8 @@ The area's gravity vector (not normalized). If gravity is a point (see :ref:`gra
The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping).
----
.. _class_Area_property_monitorable: .. _class_Area_property_monitorable:
- :ref:`bool<class_bool>` **monitorable** - :ref:`bool<class_bool>` **monitorable**
@@ -298,6 +332,8 @@ The rate at which objects stop moving in this area. Represents the linear veloci
If ``true``, other monitoring areas can detect this area. Default value: ``true``. If ``true``, other monitoring areas can detect this area. Default value: ``true``.
----
.. _class_Area_property_monitoring: .. _class_Area_property_monitoring:
- :ref:`bool<class_bool>` **monitoring** - :ref:`bool<class_bool>` **monitoring**
@@ -310,6 +346,8 @@ If ``true``, other monitoring areas can detect this area. Default value: ``true`
If ``true``, the area detects bodies or areas entering and exiting it. Default value: ``true``. If ``true``, the area detects bodies or areas entering and exiting it. Default value: ``true``.
----
.. _class_Area_property_priority: .. _class_Area_property_priority:
- :ref:`float<class_float>` **priority** - :ref:`float<class_float>` **priority**
@@ -322,6 +360,8 @@ If ``true``, the area detects bodies or areas entering and exiting it. Default v
The area's priority. Higher priority areas are processed first. Default value: 0. The area's priority. Higher priority areas are processed first. Default value: 0.
----
.. _class_Area_property_reverb_bus_amount: .. _class_Area_property_reverb_bus_amount:
- :ref:`float<class_float>` **reverb_bus_amount** - :ref:`float<class_float>` **reverb_bus_amount**
@@ -334,6 +374,8 @@ The area's priority. Higher priority areas are processed first. Default value: 0
The degree to which this area applies reverb to its associated audio. Ranges from ``0`` to ``1`` with ``0.1`` precision. The degree to which this area applies reverb to its associated audio. Ranges from ``0`` to ``1`` with ``0.1`` precision.
----
.. _class_Area_property_reverb_bus_enable: .. _class_Area_property_reverb_bus_enable:
- :ref:`bool<class_bool>` **reverb_bus_enable** - :ref:`bool<class_bool>` **reverb_bus_enable**
@@ -346,6 +388,8 @@ The degree to which this area applies reverb to its associated audio. Ranges fro
If ``true``, the area applies reverb to its associated audio. If ``true``, the area applies reverb to its associated audio.
----
.. _class_Area_property_reverb_bus_name: .. _class_Area_property_reverb_bus_name:
- :ref:`String<class_String>` **reverb_bus_name** - :ref:`String<class_String>` **reverb_bus_name**
@@ -358,6 +402,8 @@ If ``true``, the area applies reverb to its associated audio.
The reverb bus name to use for this area's associated audio. The reverb bus name to use for this area's associated audio.
----
.. _class_Area_property_reverb_bus_uniformity: .. _class_Area_property_reverb_bus_uniformity:
- :ref:`float<class_float>` **reverb_bus_uniformity** - :ref:`float<class_float>` **reverb_bus_uniformity**
@@ -370,6 +416,8 @@ The reverb bus name to use for this area's associated audio.
The degree to which this area's reverb is a uniform effect. Ranges from ``0`` to ``1`` with ``0.1`` precision. The degree to which this area's reverb is a uniform effect. Ranges from ``0`` to ``1`` with ``0.1`` precision.
----
.. _class_Area_property_space_override: .. _class_Area_property_space_override:
- :ref:`SpaceOverride<enum_Area_SpaceOverride>` **space_override** - :ref:`SpaceOverride<enum_Area_SpaceOverride>` **space_override**
@@ -391,42 +439,56 @@ Method Descriptions
Returns an individual bit on the layer mask. Returns an individual bit on the layer mask.
----
.. _class_Area_method_get_collision_mask_bit: .. _class_Area_method_get_collision_mask_bit:
- :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const - :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const
Returns an individual bit on the collision mask. Returns an individual bit on the collision mask.
----
.. _class_Area_method_get_overlapping_areas: .. _class_Area_method_get_overlapping_areas:
- :ref:`Array<class_Array>` **get_overlapping_areas** **(** **)** const - :ref:`Array<class_Array>` **get_overlapping_areas** **(** **)** const
Returns a list of intersecting ``Area``\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. Returns a list of intersecting ``Area``\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
----
.. _class_Area_method_get_overlapping_bodies: .. _class_Area_method_get_overlapping_bodies:
- :ref:`Array<class_Array>` **get_overlapping_bodies** **(** **)** const - :ref:`Array<class_Array>` **get_overlapping_bodies** **(** **)** const
Returns a list of intersecting :ref:`PhysicsBody<class_PhysicsBody>`\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. Returns a list of intersecting :ref:`PhysicsBody<class_PhysicsBody>`\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
----
.. _class_Area_method_overlaps_area: .. _class_Area_method_overlaps_area:
- :ref:`bool<class_bool>` **overlaps_area** **(** :ref:`Node<class_Node>` area **)** const - :ref:`bool<class_bool>` **overlaps_area** **(** :ref:`Node<class_Node>` area **)** const
If ``true``, the given area overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. If ``true``, the given area overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
----
.. _class_Area_method_overlaps_body: .. _class_Area_method_overlaps_body:
- :ref:`bool<class_bool>` **overlaps_body** **(** :ref:`Node<class_Node>` body **)** const - :ref:`bool<class_bool>` **overlaps_body** **(** :ref:`Node<class_Node>` body **)** const
If ``true``, the given body overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. If ``true``, the given body overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
----
.. _class_Area_method_set_collision_layer_bit: .. _class_Area_method_set_collision_layer_bit:
- void **set_collision_layer_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** - void **set_collision_layer_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
Set/clear individual bits on the layer mask. This simplifies editing this ``Area``'s layers. Set/clear individual bits on the layer mask. This simplifies editing this ``Area``'s layers.
----
.. _class_Area_method_set_collision_mask_bit: .. _class_Area_method_set_collision_mask_bit:
- void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** - void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**

54
classes/class_area2d.rst
View File

@@ -81,42 +81,56 @@ Signals
Emitted when another area enters. Emitted when another area enters.
----
.. _class_Area2D_signal_area_exited: .. _class_Area2D_signal_area_exited:
- **area_exited** **(** :ref:`Area2D<class_Area2D>` area **)** - **area_exited** **(** :ref:`Area2D<class_Area2D>` area **)**
Emitted when another area exits. Emitted when another area exits.
----
.. _class_Area2D_signal_area_shape_entered: .. _class_Area2D_signal_area_shape_entered:
- **area_shape_entered** **(** :ref:`int<class_int>` area_id, :ref:`Area2D<class_Area2D>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)** - **area_shape_entered** **(** :ref:`int<class_int>` area_id, :ref:`Area2D<class_Area2D>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
Emitted when another area enters, reporting which shapes overlapped. Emitted when another area enters, reporting which shapes overlapped.
----
.. _class_Area2D_signal_area_shape_exited: .. _class_Area2D_signal_area_shape_exited:
- **area_shape_exited** **(** :ref:`int<class_int>` area_id, :ref:`Area2D<class_Area2D>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)** - **area_shape_exited** **(** :ref:`int<class_int>` area_id, :ref:`Area2D<class_Area2D>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
Emitted when another area exits, reporting which shapes were overlapping. Emitted when another area exits, reporting which shapes were overlapping.
----
.. _class_Area2D_signal_body_entered: .. _class_Area2D_signal_body_entered:
- **body_entered** **(** :ref:`PhysicsBody2D<class_PhysicsBody2D>` body **)** - **body_entered** **(** :ref:`PhysicsBody2D<class_PhysicsBody2D>` body **)**
Emitted when a :ref:`PhysicsBody2D<class_PhysicsBody2D>` object enters. Emitted when a :ref:`PhysicsBody2D<class_PhysicsBody2D>` object enters.
----
.. _class_Area2D_signal_body_exited: .. _class_Area2D_signal_body_exited:
- **body_exited** **(** :ref:`PhysicsBody2D<class_PhysicsBody2D>` body **)** - **body_exited** **(** :ref:`PhysicsBody2D<class_PhysicsBody2D>` body **)**
Emitted when a :ref:`PhysicsBody2D<class_PhysicsBody2D>` object exits. Emitted when a :ref:`PhysicsBody2D<class_PhysicsBody2D>` object exits.
----
.. _class_Area2D_signal_body_shape_entered: .. _class_Area2D_signal_body_shape_entered:
- **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`PhysicsBody2D<class_PhysicsBody2D>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)** - **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`PhysicsBody2D<class_PhysicsBody2D>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
Emitted when a :ref:`PhysicsBody2D<class_PhysicsBody2D>` object enters, reporting which shapes overlapped. Emitted when a :ref:`PhysicsBody2D<class_PhysicsBody2D>` object enters, reporting which shapes overlapped.
----
.. _class_Area2D_signal_body_shape_exited: .. _class_Area2D_signal_body_shape_exited:
- **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`PhysicsBody2D<class_PhysicsBody2D>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)** - **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`PhysicsBody2D<class_PhysicsBody2D>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
@@ -170,6 +184,8 @@ Property Descriptions
The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping).
----
.. _class_Area2D_property_audio_bus_name: .. _class_Area2D_property_audio_bus_name:
- :ref:`String<class_String>` **audio_bus_name** - :ref:`String<class_String>` **audio_bus_name**
@@ -182,6 +198,8 @@ The rate at which objects stop spinning in this area. Represents the angular vel
The name of the area's audio bus. The name of the area's audio bus.
----
.. _class_Area2D_property_audio_bus_override: .. _class_Area2D_property_audio_bus_override:
- :ref:`bool<class_bool>` **audio_bus_override** - :ref:`bool<class_bool>` **audio_bus_override**
@@ -194,6 +212,8 @@ The name of the area's audio bus.
If ``true``, the area's audio bus overrides the default audio bus. Default value: ``false``. If ``true``, the area's audio bus overrides the default audio bus. Default value: ``false``.
----
.. _class_Area2D_property_collision_layer: .. _class_Area2D_property_collision_layer:
- :ref:`int<class_int>` **collision_layer** - :ref:`int<class_int>` **collision_layer**
@@ -206,6 +226,8 @@ If ``true``, the area's audio bus overrides the default audio bus. Default value
The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also :ref:`collision_mask<class_Area2D_property_collision_mask>`. The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also :ref:`collision_mask<class_Area2D_property_collision_mask>`.
----
.. _class_Area2D_property_collision_mask: .. _class_Area2D_property_collision_mask:
- :ref:`int<class_int>` **collision_mask** - :ref:`int<class_int>` **collision_mask**
@@ -218,6 +240,8 @@ The area's physics layer(s). Collidable objects can exist in any of 32 different
The physics layers this area scans to determine collision detection. The physics layers this area scans to determine collision detection.
----
.. _class_Area2D_property_gravity: .. _class_Area2D_property_gravity:
- :ref:`float<class_float>` **gravity** - :ref:`float<class_float>` **gravity**
@@ -230,6 +254,8 @@ The physics layers this area scans to determine collision detection.
The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction.
----
.. _class_Area2D_property_gravity_distance_scale: .. _class_Area2D_property_gravity_distance_scale:
- :ref:`float<class_float>` **gravity_distance_scale** - :ref:`float<class_float>` **gravity_distance_scale**
@@ -242,6 +268,8 @@ The area's gravity intensity (ranges from -1024 to 1024). This value multiplies
The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance.
----
.. _class_Area2D_property_gravity_point: .. _class_Area2D_property_gravity_point:
- :ref:`bool<class_bool>` **gravity_point** - :ref:`bool<class_bool>` **gravity_point**
@@ -254,6 +282,8 @@ The falloff factor for point gravity. The greater the value, the faster gravity
If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class_Area2D_property_gravity_vec>`). Also see :ref:`space_override<class_Area2D_property_space_override>`. Default value: ``false``. If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class_Area2D_property_gravity_vec>`). Also see :ref:`space_override<class_Area2D_property_space_override>`. Default value: ``false``.
----
.. _class_Area2D_property_gravity_vec: .. _class_Area2D_property_gravity_vec:
- :ref:`Vector2<class_Vector2>` **gravity_vec** - :ref:`Vector2<class_Vector2>` **gravity_vec**
@@ -266,6 +296,8 @@ If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class
The area's gravity vector (not normalized). If gravity is a point (see :ref:`gravity_point<class_Area2D_property_gravity_point>`), this will be the point of attraction. The area's gravity vector (not normalized). If gravity is a point (see :ref:`gravity_point<class_Area2D_property_gravity_point>`), this will be the point of attraction.
----
.. _class_Area2D_property_linear_damp: .. _class_Area2D_property_linear_damp:
- :ref:`float<class_float>` **linear_damp** - :ref:`float<class_float>` **linear_damp**
@@ -278,6 +310,8 @@ The area's gravity vector (not normalized). If gravity is a point (see :ref:`gra
The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping).
----
.. _class_Area2D_property_monitorable: .. _class_Area2D_property_monitorable:
- :ref:`bool<class_bool>` **monitorable** - :ref:`bool<class_bool>` **monitorable**
@@ -290,6 +324,8 @@ The rate at which objects stop moving in this area. Represents the linear veloci
If ``true``, other monitoring areas can detect this area. Default value: ``true``. If ``true``, other monitoring areas can detect this area. Default value: ``true``.
----
.. _class_Area2D_property_monitoring: .. _class_Area2D_property_monitoring:
- :ref:`bool<class_bool>` **monitoring** - :ref:`bool<class_bool>` **monitoring**
@@ -302,6 +338,8 @@ If ``true``, other monitoring areas can detect this area. Default value: ``true`
If ``true``, the area detects bodies or areas entering and exiting it. Default value: ``true``. If ``true``, the area detects bodies or areas entering and exiting it. Default value: ``true``.
----
.. _class_Area2D_property_priority: .. _class_Area2D_property_priority:
- :ref:`float<class_float>` **priority** - :ref:`float<class_float>` **priority**
@@ -314,6 +352,8 @@ If ``true``, the area detects bodies or areas entering and exiting it. Default v
The area's priority. Higher priority areas are processed first. Default value: 0. The area's priority. Higher priority areas are processed first. Default value: 0.
----
.. _class_Area2D_property_space_override: .. _class_Area2D_property_space_override:
- :ref:`SpaceOverride<enum_Area2D_SpaceOverride>` **space_override** - :ref:`SpaceOverride<enum_Area2D_SpaceOverride>` **space_override**
@@ -335,42 +375,56 @@ Method Descriptions
Returns an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer. Returns an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer.
----
.. _class_Area2D_method_get_collision_mask_bit: .. _class_Area2D_method_get_collision_mask_bit:
- :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const - :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const
Returns an individual bit on the collision mask. Describes whether this area will collide with others on the given layer. Returns an individual bit on the collision mask. Describes whether this area will collide with others on the given layer.
----
.. _class_Area2D_method_get_overlapping_areas: .. _class_Area2D_method_get_overlapping_areas:
- :ref:`Array<class_Array>` **get_overlapping_areas** **(** **)** const - :ref:`Array<class_Array>` **get_overlapping_areas** **(** **)** const
Returns a list of intersecting ``Area2D``\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. Returns a list of intersecting ``Area2D``\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
----
.. _class_Area2D_method_get_overlapping_bodies: .. _class_Area2D_method_get_overlapping_bodies:
- :ref:`Array<class_Array>` **get_overlapping_bodies** **(** **)** const - :ref:`Array<class_Array>` **get_overlapping_bodies** **(** **)** const
Returns a list of intersecting :ref:`PhysicsBody2D<class_PhysicsBody2D>`\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. Returns a list of intersecting :ref:`PhysicsBody2D<class_PhysicsBody2D>`\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
----
.. _class_Area2D_method_overlaps_area: .. _class_Area2D_method_overlaps_area:
- :ref:`bool<class_bool>` **overlaps_area** **(** :ref:`Node<class_Node>` area **)** const - :ref:`bool<class_bool>` **overlaps_area** **(** :ref:`Node<class_Node>` area **)** const
If ``true``, the given area overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. If ``true``, the given area overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
----
.. _class_Area2D_method_overlaps_body: .. _class_Area2D_method_overlaps_body:
- :ref:`bool<class_bool>` **overlaps_body** **(** :ref:`Node<class_Node>` body **)** const - :ref:`bool<class_bool>` **overlaps_body** **(** :ref:`Node<class_Node>` body **)** const
If ``true``, the given body overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. If ``true``, the given body overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
----
.. _class_Area2D_method_set_collision_layer_bit: .. _class_Area2D_method_set_collision_layer_bit:
- void **set_collision_layer_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** - void **set_collision_layer_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
----
.. _class_Area2D_method_set_collision_mask_bit: .. _class_Area2D_method_set_collision_mask_bit:
- void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** - void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**

70
classes/class_array.rst
View File

@@ -118,66 +118,92 @@ Method Descriptions
Constructs an array from a :ref:`PoolColorArray<class_PoolColorArray>`. Constructs an array from a :ref:`PoolColorArray<class_PoolColorArray>`.
----
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolVector3Array<class_PoolVector3Array>` from **)** - :ref:`Array<class_Array>` **Array** **(** :ref:`PoolVector3Array<class_PoolVector3Array>` from **)**
Constructs an array from a :ref:`PoolVector3Array<class_PoolVector3Array>`. Constructs an array from a :ref:`PoolVector3Array<class_PoolVector3Array>`.
----
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` from **)** - :ref:`Array<class_Array>` **Array** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` from **)**
Constructs an array from a :ref:`PoolVector2Array<class_PoolVector2Array>`. Constructs an array from a :ref:`PoolVector2Array<class_PoolVector2Array>`.
----
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolStringArray<class_PoolStringArray>` from **)** - :ref:`Array<class_Array>` **Array** **(** :ref:`PoolStringArray<class_PoolStringArray>` from **)**
Constructs an array from a :ref:`PoolStringArray<class_PoolStringArray>`. Constructs an array from a :ref:`PoolStringArray<class_PoolStringArray>`.
----
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolRealArray<class_PoolRealArray>` from **)** - :ref:`Array<class_Array>` **Array** **(** :ref:`PoolRealArray<class_PoolRealArray>` from **)**
Constructs an array from a :ref:`PoolRealArray<class_PoolRealArray>`. Constructs an array from a :ref:`PoolRealArray<class_PoolRealArray>`.
----
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolIntArray<class_PoolIntArray>` from **)** - :ref:`Array<class_Array>` **Array** **(** :ref:`PoolIntArray<class_PoolIntArray>` from **)**
Constructs an array from a :ref:`PoolIntArray<class_PoolIntArray>`. Constructs an array from a :ref:`PoolIntArray<class_PoolIntArray>`.
----
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolByteArray<class_PoolByteArray>` from **)** - :ref:`Array<class_Array>` **Array** **(** :ref:`PoolByteArray<class_PoolByteArray>` from **)**
Constructs an array from a :ref:`PoolByteArray<class_PoolByteArray>`. Constructs an array from a :ref:`PoolByteArray<class_PoolByteArray>`.
----
.. _class_Array_method_append: .. _class_Array_method_append:
- void **append** **(** :ref:`Variant<class_Variant>` value **)** - void **append** **(** :ref:`Variant<class_Variant>` value **)**
Appends an element at the end of the array (alias of :ref:`push_back<class_Array_method_push_back>`). Appends an element at the end of the array (alias of :ref:`push_back<class_Array_method_push_back>`).
----
.. _class_Array_method_back: .. _class_Array_method_back:
- :ref:`Variant<class_Variant>` **back** **(** **)** - :ref:`Variant<class_Variant>` **back** **(** **)**
Returns the last element of the array if the array is not empty. Returns the last element of the array if the array is not empty.
----
.. _class_Array_method_bsearch: .. _class_Array_method_bsearch:
- :ref:`int<class_int>` **bsearch** **(** :ref:`Variant<class_Variant>` value, :ref:`bool<class_bool>` before=True **)** - :ref:`int<class_int>` **bsearch** **(** :ref:`Variant<class_Variant>` value, :ref:`bool<class_bool>` before=True **)**
Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. Note that calling bsearch on an unsorted array results in unexpected behavior. Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. Note that calling bsearch on an unsorted array results in unexpected behavior.
----
.. _class_Array_method_bsearch_custom: .. _class_Array_method_bsearch_custom:
- :ref:`int<class_int>` **bsearch_custom** **(** :ref:`Variant<class_Variant>` value, :ref:`Object<class_Object>` obj, :ref:`String<class_String>` func, :ref:`bool<class_bool>` before=True **)** - :ref:`int<class_int>` **bsearch_custom** **(** :ref:`Variant<class_Variant>` value, :ref:`Object<class_Object>` obj, :ref:`String<class_String>` func, :ref:`bool<class_bool>` before=True **)**
Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a before specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return ``true`` if the first argument is less than the second, and return ``false`` otherwise. Note that calling bsearch on an unsorted array results in unexpected behavior. Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a before specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return ``true`` if the first argument is less than the second, and return ``false`` otherwise. Note that calling bsearch on an unsorted array results in unexpected behavior.
----
.. _class_Array_method_clear: .. _class_Array_method_clear:
- void **clear** **(** **)** - void **clear** **(** **)**
Clears the array (resizes to 0). Clears the array (resizes to 0).
----
.. _class_Array_method_count: .. _class_Array_method_count:
- :ref:`int<class_int>` **count** **(** :ref:`Variant<class_Variant>` value **)** - :ref:`int<class_int>` **count** **(** :ref:`Variant<class_Variant>` value **)**
Returns the number of times an element is in the array. Returns the number of times an element is in the array.
----
.. _class_Array_method_duplicate: .. _class_Array_method_duplicate:
- :ref:`Array<class_Array>` **duplicate** **(** :ref:`bool<class_bool>` deep=False **)** - :ref:`Array<class_Array>` **duplicate** **(** :ref:`bool<class_bool>` deep=False **)**
@@ -186,36 +212,48 @@ Returns a copy of the array.
If ``deep`` is ``true``, a deep copy is performed: all nested arrays and dictionaries are duplicated and will not be shared with the original array. If ``false``, a shallow copy is made and references to the original nested arrays and dictionaries are kept, so that modifying a sub-array or dictionary in the copy will also impact those referenced in the source array. If ``deep`` is ``true``, a deep copy is performed: all nested arrays and dictionaries are duplicated and will not be shared with the original array. If ``false``, a shallow copy is made and references to the original nested arrays and dictionaries are kept, so that modifying a sub-array or dictionary in the copy will also impact those referenced in the source array.
----
.. _class_Array_method_empty: .. _class_Array_method_empty:
- :ref:`bool<class_bool>` **empty** **(** **)** - :ref:`bool<class_bool>` **empty** **(** **)**
Returns ``true`` if the array is empty. Returns ``true`` if the array is empty.
----
.. _class_Array_method_erase: .. _class_Array_method_erase:
- void **erase** **(** :ref:`Variant<class_Variant>` value **)** - void **erase** **(** :ref:`Variant<class_Variant>` value **)**
Removes the first occurrence of a value from the array. Removes the first occurrence of a value from the array.
----
.. _class_Array_method_find: .. _class_Array_method_find:
- :ref:`int<class_int>` **find** **(** :ref:`Variant<class_Variant>` what, :ref:`int<class_int>` from=0 **)** - :ref:`int<class_int>` **find** **(** :ref:`Variant<class_Variant>` what, :ref:`int<class_int>` from=0 **)**
Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed. Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed.
----
.. _class_Array_method_find_last: .. _class_Array_method_find_last:
- :ref:`int<class_int>` **find_last** **(** :ref:`Variant<class_Variant>` value **)** - :ref:`int<class_int>` **find_last** **(** :ref:`Variant<class_Variant>` value **)**
Searches the array in reverse order for a value and returns its index or -1 if not found. Searches the array in reverse order for a value and returns its index or -1 if not found.
----
.. _class_Array_method_front: .. _class_Array_method_front:
- :ref:`Variant<class_Variant>` **front** **(** **)** - :ref:`Variant<class_Variant>` **front** **(** **)**
Returns the first element of the array if the array is not empty. Returns the first element of the array if the array is not empty.
----
.. _class_Array_method_has: .. _class_Array_method_has:
- :ref:`bool<class_bool>` **has** **(** :ref:`Variant<class_Variant>` value **)** - :ref:`bool<class_bool>` **has** **(** :ref:`Variant<class_Variant>` value **)**
@@ -229,96 +267,128 @@ Returns ``true`` if the array contains the given value.
["inside", 7].has(7) == true ["inside", 7].has(7) == true
["inside", 7].has("7") == false ["inside", 7].has("7") == false
----
.. _class_Array_method_hash: .. _class_Array_method_hash:
- :ref:`int<class_int>` **hash** **(** **)** - :ref:`int<class_int>` **hash** **(** **)**
Returns a hashed integer value representing the array contents. Returns a hashed integer value representing the array contents.
----
.. _class_Array_method_insert: .. _class_Array_method_insert:
- void **insert** **(** :ref:`int<class_int>` position, :ref:`Variant<class_Variant>` value **)** - void **insert** **(** :ref:`int<class_int>` position, :ref:`Variant<class_Variant>` value **)**
Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``pos == size()``). Inserts 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_Array_method_invert: .. _class_Array_method_invert:
- void **invert** **(** **)** - void **invert** **(** **)**
Reverses the order of the elements in the array. Reverses the order of the elements in the array.
----
.. _class_Array_method_max: .. _class_Array_method_max:
- :ref:`Variant<class_Variant>` **max** **(** **)** - :ref:`Variant<class_Variant>` **max** **(** **)**
Returns the maximum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned. Returns the maximum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned.
----
.. _class_Array_method_min: .. _class_Array_method_min:
- :ref:`Variant<class_Variant>` **min** **(** **)** - :ref:`Variant<class_Variant>` **min** **(** **)**
Returns the minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned. Returns the minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned.
----
.. _class_Array_method_pop_back: .. _class_Array_method_pop_back:
- :ref:`Variant<class_Variant>` **pop_back** **(** **)** - :ref:`Variant<class_Variant>` **pop_back** **(** **)**
Removes the last element of the array. Removes the last element of the array.
----
.. _class_Array_method_pop_front: .. _class_Array_method_pop_front:
- :ref:`Variant<class_Variant>` **pop_front** **(** **)** - :ref:`Variant<class_Variant>` **pop_front** **(** **)**
Removes the first element of the array. Removes the first element of the array.
----
.. _class_Array_method_push_back: .. _class_Array_method_push_back:
- void **push_back** **(** :ref:`Variant<class_Variant>` value **)** - void **push_back** **(** :ref:`Variant<class_Variant>` value **)**
Appends an element at the end of the array. Appends an element at the end of the array.
----
.. _class_Array_method_push_front: .. _class_Array_method_push_front:
- void **push_front** **(** :ref:`Variant<class_Variant>` value **)** - void **push_front** **(** :ref:`Variant<class_Variant>` value **)**
Adds an element at the beginning of the array. Adds an element at the beginning of the array.
----
.. _class_Array_method_remove: .. _class_Array_method_remove:
- void **remove** **(** :ref:`int<class_int>` position **)** - void **remove** **(** :ref:`int<class_int>` position **)**
Removes an element from the array by index. Removes an element from the array by index.
----
.. _class_Array_method_resize: .. _class_Array_method_resize:
- void **resize** **(** :ref:`int<class_int>` size **)** - void **resize** **(** :ref:`int<class_int>` size **)**
Resizes the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are Null. Resizes the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are Null.
----
.. _class_Array_method_rfind: .. _class_Array_method_rfind:
- :ref:`int<class_int>` **rfind** **(** :ref:`Variant<class_Variant>` what, :ref:`int<class_int>` from=-1 **)** - :ref:`int<class_int>` **rfind** **(** :ref:`Variant<class_Variant>` what, :ref:`int<class_int>` from=-1 **)**
Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.
----
.. _class_Array_method_shuffle: .. _class_Array_method_shuffle:
- void **shuffle** **(** **)** - void **shuffle** **(** **)**
Shuffles the array such that the items will have a random order. This method uses the global random number generator common to methods such as :ref:`@GDScript.randi<class_@GDScript_method_randi>`. Call :ref:`@GDScript.randomize<class_@GDScript_method_randomize>` to ensure that a new seed will be used each time if you want non-reproducible shuffling. Shuffles the array such that the items will have a random order. This method uses the global random number generator common to methods such as :ref:`@GDScript.randi<class_@GDScript_method_randi>`. Call :ref:`@GDScript.randomize<class_@GDScript_method_randomize>` to ensure that a new seed will be used each time if you want non-reproducible shuffling.
----
.. _class_Array_method_size: .. _class_Array_method_size:
- :ref:`int<class_int>` **size** **(** **)** - :ref:`int<class_int>` **size** **(** **)**
Returns the number of elements in the array. Returns the number of elements in the array.
----
.. _class_Array_method_sort: .. _class_Array_method_sort:
- void **sort** **(** **)** - void **sort** **(** **)**
Sorts the array. Note: strings are sorted in alphabetical, not natural order. Sorts the array. Note: strings are sorted in alphabetical, not natural order.
----
.. _class_Array_method_sort_custom: .. _class_Array_method_sort_custom:
- void **sort_custom** **(** :ref:`Object<class_Object>` obj, :ref:`String<class_String>` func **)** - void **sort_custom** **(** :ref:`Object<class_Object>` obj, :ref:`String<class_String>` func **)**

36
classes/class_arraymesh.rst
View File

@@ -115,6 +115,8 @@ For triangles, the index array is interpreted as triples, referring to the verti
- **ARRAY_MAX** = **9** --- Represents the size of the :ref:`ArrayType<enum_ArrayMesh_ArrayType>` enum. - **ARRAY_MAX** = **9** --- Represents the size of the :ref:`ArrayType<enum_ArrayMesh_ArrayType>` enum.
----
.. _enum_ArrayMesh_ArrayFormat: .. _enum_ArrayMesh_ArrayFormat:
.. _class_ArrayMesh_constant_ARRAY_FORMAT_VERTEX: .. _class_ArrayMesh_constant_ARRAY_FORMAT_VERTEX:
@@ -202,6 +204,8 @@ Property Descriptions
| *Getter* | get_blend_shape_mode() | | *Getter* | get_blend_shape_mode() |
+----------+-----------------------------+ +----------+-----------------------------+
----
.. _class_ArrayMesh_property_custom_aabb: .. _class_ArrayMesh_property_custom_aabb:
- :ref:`AABB<class_AABB>` **custom_aabb** - :ref:`AABB<class_AABB>` **custom_aabb**
@@ -223,6 +227,8 @@ Method Descriptions
Add name for a blend shape that will be added with :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`. Must be called before surface is added. Add name for a blend shape that will be added with :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`. Must be called before surface is added.
----
.. _class_ArrayMesh_method_add_surface_from_arrays: .. _class_ArrayMesh_method_add_surface_from_arrays:
- void **add_surface_from_arrays** **(** :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[ ], :ref:`int<class_int>` compress_flags=97280 **)** - void **add_surface_from_arrays** **(** :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[ ], :ref:`int<class_int>` compress_flags=97280 **)**
@@ -237,90 +243,120 @@ Adding an index array puts this function into "index mode" where the vertex and
Godot uses clockwise winding order for front faces of triangle primitive modes. Godot uses clockwise winding order for front faces of triangle primitive modes.
----
.. _class_ArrayMesh_method_clear_blend_shapes: .. _class_ArrayMesh_method_clear_blend_shapes:
- void **clear_blend_shapes** **(** **)** - void **clear_blend_shapes** **(** **)**
Remove all blend shapes from this ``ArrayMesh``. Remove all blend shapes from this ``ArrayMesh``.
----
.. _class_ArrayMesh_method_get_blend_shape_count: .. _class_ArrayMesh_method_get_blend_shape_count:
- :ref:`int<class_int>` **get_blend_shape_count** **(** **)** const - :ref:`int<class_int>` **get_blend_shape_count** **(** **)** const
Returns the number of blend shapes that the ``ArrayMesh`` holds. Returns the number of blend shapes that the ``ArrayMesh`` holds.
----
.. _class_ArrayMesh_method_get_blend_shape_name: .. _class_ArrayMesh_method_get_blend_shape_name:
- :ref:`String<class_String>` **get_blend_shape_name** **(** :ref:`int<class_int>` index **)** const - :ref:`String<class_String>` **get_blend_shape_name** **(** :ref:`int<class_int>` index **)** const
Returns the name of the blend shape at this index. Returns the name of the blend shape at this index.
----
.. _class_ArrayMesh_method_lightmap_unwrap: .. _class_ArrayMesh_method_lightmap_unwrap:
- :ref:`Error<enum_@GlobalScope_Error>` **lightmap_unwrap** **(** :ref:`Transform<class_Transform>` transform, :ref:`float<class_float>` texel_size **)** - :ref:`Error<enum_@GlobalScope_Error>` **lightmap_unwrap** **(** :ref:`Transform<class_Transform>` transform, :ref:`float<class_float>` texel_size **)**
Will perform a UV unwrap on the ``ArrayMesh`` to prepare the mesh for lightmapping. Will perform a UV unwrap on the ``ArrayMesh`` to prepare the mesh for lightmapping.
----
.. _class_ArrayMesh_method_regen_normalmaps: .. _class_ArrayMesh_method_regen_normalmaps:
- void **regen_normalmaps** **(** **)** - void **regen_normalmaps** **(** **)**
Will regenerate normal maps for the ``ArrayMesh``. Will regenerate normal maps for the ``ArrayMesh``.
----
.. _class_ArrayMesh_method_surface_find_by_name: .. _class_ArrayMesh_method_surface_find_by_name:
- :ref:`int<class_int>` **surface_find_by_name** **(** :ref:`String<class_String>` name **)** const - :ref:`int<class_int>` **surface_find_by_name** **(** :ref:`String<class_String>` name **)** const
Returns the index of the first surface with this name held within this ``ArrayMesh``. If none are found -1 is returned. Returns the index of the first surface with this name held within this ``ArrayMesh``. If none are found -1 is returned.
----
.. _class_ArrayMesh_method_surface_get_array_index_len: .. _class_ArrayMesh_method_surface_get_array_index_len:
- :ref:`int<class_int>` **surface_get_array_index_len** **(** :ref:`int<class_int>` surf_idx **)** const - :ref:`int<class_int>` **surface_get_array_index_len** **(** :ref:`int<class_int>` surf_idx **)** const
Returns the length in indices of the index array in the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`). Returns the length in indices of the index array in the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`).
----
.. _class_ArrayMesh_method_surface_get_array_len: .. _class_ArrayMesh_method_surface_get_array_len:
- :ref:`int<class_int>` **surface_get_array_len** **(** :ref:`int<class_int>` surf_idx **)** const - :ref:`int<class_int>` **surface_get_array_len** **(** :ref:`int<class_int>` surf_idx **)** const
Returns the length in vertices of the vertex array in the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`). Returns the length in vertices of the vertex array in the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`).
----
.. _class_ArrayMesh_method_surface_get_format: .. _class_ArrayMesh_method_surface_get_format:
- :ref:`int<class_int>` **surface_get_format** **(** :ref:`int<class_int>` surf_idx **)** const - :ref:`int<class_int>` **surface_get_format** **(** :ref:`int<class_int>` surf_idx **)** const
Returns the format mask of the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`). Returns the format mask of the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`).
----
.. _class_ArrayMesh_method_surface_get_name: .. _class_ArrayMesh_method_surface_get_name:
- :ref:`String<class_String>` **surface_get_name** **(** :ref:`int<class_int>` surf_idx **)** const - :ref:`String<class_String>` **surface_get_name** **(** :ref:`int<class_int>` surf_idx **)** const
Get the name assigned to this surface. Get the name assigned to this surface.
----
.. _class_ArrayMesh_method_surface_get_primitive_type: .. _class_ArrayMesh_method_surface_get_primitive_type:
- :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` **surface_get_primitive_type** **(** :ref:`int<class_int>` surf_idx **)** const - :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` **surface_get_primitive_type** **(** :ref:`int<class_int>` surf_idx **)** const
Returns the primitive type of the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`). Returns the primitive type of the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`).
----
.. _class_ArrayMesh_method_surface_remove: .. _class_ArrayMesh_method_surface_remove:
- void **surface_remove** **(** :ref:`int<class_int>` surf_idx **)** - void **surface_remove** **(** :ref:`int<class_int>` surf_idx **)**
Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down. Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down.
----
.. _class_ArrayMesh_method_surface_set_material: .. _class_ArrayMesh_method_surface_set_material:
- void **surface_set_material** **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_Material>` material **)** - void **surface_set_material** **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_Material>` material **)**
Set a :ref:`Material<class_Material>` for a given surface. Surface will be rendered using this material. Set a :ref:`Material<class_Material>` for a given surface. Surface will be rendered using this material.
----
.. _class_ArrayMesh_method_surface_set_name: .. _class_ArrayMesh_method_surface_set_name:
- void **surface_set_name** **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_String>` name **)** - void **surface_set_name** **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_String>` name **)**
Set a name for a given surface. Set a name for a given surface.
----
.. _class_ArrayMesh_method_surface_update_region: .. _class_ArrayMesh_method_surface_update_region:
- void **surface_update_region** **(** :ref:`int<class_int>` surf_idx, :ref:`int<class_int>` offset, :ref:`PoolByteArray<class_PoolByteArray>` data **)** - void **surface_update_region** **(** :ref:`int<class_int>` surf_idx, :ref:`int<class_int>` offset, :ref:`PoolByteArray<class_PoolByteArray>` data **)**

6
classes/class_arvranchor.rst
View File

@@ -71,18 +71,24 @@ Method Descriptions
Returns the name given to this anchor. Returns the name given to this anchor.
----
.. _class_ARVRAnchor_method_get_is_active: .. _class_ARVRAnchor_method_get_is_active:
- :ref:`bool<class_bool>` **get_is_active** **(** **)** const - :ref:`bool<class_bool>` **get_is_active** **(** **)** const
Returns ``true`` if the anchor is being tracked and ``false`` if no anchor with this id is currently known. Returns ``true`` if the anchor is being tracked and ``false`` if no anchor with this id is currently known.
----
.. _class_ARVRAnchor_method_get_plane: .. _class_ARVRAnchor_method_get_plane:
- :ref:`Plane<class_Plane>` **get_plane** **(** **)** const - :ref:`Plane<class_Plane>` **get_plane** **(** **)** const
Returns a plane aligned with our anchor; handy for intersection testing. Returns a plane aligned with our anchor; handy for intersection testing.
----
.. _class_ARVRAnchor_method_get_size: .. _class_ARVRAnchor_method_get_size:
- :ref:`Vector3<class_Vector3>` **get_size** **(** **)** const - :ref:`Vector3<class_Vector3>` **get_size** **(** **)** const

14
classes/class_arvrcontroller.rst
View File

@@ -53,6 +53,8 @@ Signals
Emitted when a button on this controller is pressed. Emitted when a button on this controller is pressed.
----
.. _class_ARVRController_signal_button_release: .. _class_ARVRController_signal_button_release:
- **button_release** **(** :ref:`int<class_int>` button **)** - **button_release** **(** :ref:`int<class_int>` button **)**
@@ -89,6 +91,8 @@ For any other controller that the :ref:`ARVRServer<class_ARVRServer>` detects, w
When a controller is turned off, its slot is freed. This ensures controllers will keep the same id even when controllers with lower ids are turned off. When a controller is turned off, its slot is freed. This ensures controllers will keep the same id even when controllers with lower ids are turned off.
----
.. _class_ARVRController_property_rumble: .. _class_ARVRController_property_rumble:
- :ref:`float<class_float>` **rumble** - :ref:`float<class_float>` **rumble**
@@ -110,30 +114,40 @@ Method Descriptions
If active, returns the name of the associated controller if provided by the AR/VR SDK used. If active, returns the name of the associated controller if provided by the AR/VR SDK used.
----
.. _class_ARVRController_method_get_hand: .. _class_ARVRController_method_get_hand:
- :ref:`TrackerHand<enum_ARVRPositionalTracker_TrackerHand>` **get_hand** **(** **)** const - :ref:`TrackerHand<enum_ARVRPositionalTracker_TrackerHand>` **get_hand** **(** **)** const
Returns the hand holding this controller, if known. See TRACKER\_\* constants in :ref:`ARVRPositionalTracker<class_ARVRPositionalTracker>`. Returns the hand holding this controller, if known. See TRACKER\_\* constants in :ref:`ARVRPositionalTracker<class_ARVRPositionalTracker>`.
----
.. _class_ARVRController_method_get_is_active: .. _class_ARVRController_method_get_is_active:
- :ref:`bool<class_bool>` **get_is_active** **(** **)** const - :ref:`bool<class_bool>` **get_is_active** **(** **)** const
Returns ``true`` if the bound controller is active. ARVR systems attempt to track active controllers. Returns ``true`` if the bound controller is active. ARVR systems attempt to track active controllers.
----
.. _class_ARVRController_method_get_joystick_axis: .. _class_ARVRController_method_get_joystick_axis:
- :ref:`float<class_float>` **get_joystick_axis** **(** :ref:`int<class_int>` axis **)** const - :ref:`float<class_float>` **get_joystick_axis** **(** :ref:`int<class_int>` axis **)** const
Returns the value of the given axis for things like triggers, touchpads, etc. that are embedded into the controller. Returns the value of the given axis for things like triggers, touchpads, etc. that are embedded into the controller.
----
.. _class_ARVRController_method_get_joystick_id: .. _class_ARVRController_method_get_joystick_id:
- :ref:`int<class_int>` **get_joystick_id** **(** **)** const - :ref:`int<class_int>` **get_joystick_id** **(** **)** const
Returns the ID of the joystick object bound to this. Every controller tracked by the ARVR Server that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry. Returns the ID of the joystick object bound to this. Every controller tracked by the ARVR Server that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry.
----
.. _class_ARVRController_method_is_button_pressed: .. _class_ARVRController_method_is_button_pressed:
- :ref:`int<class_int>` **is_button_pressed** **(** :ref:`int<class_int>` button **)** const - :ref:`int<class_int>` **is_button_pressed** **(** :ref:`int<class_int>` button **)** const

20
classes/class_arvrinterface.rst
View File

@@ -77,6 +77,8 @@ enum **Capabilities**:
- **ARVR_EXTERNAL** = **8** --- This interface outputs to an external device, if the main viewport is used the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of get_render_targetsize. Using a separate viewport node frees up the main viewport for other purposes. - **ARVR_EXTERNAL** = **8** --- This interface outputs to an external device, if the main viewport is used the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of get_render_targetsize. Using a separate viewport node frees up the main viewport for other purposes.
----
.. _enum_ARVRInterface_Eyes: .. _enum_ARVRInterface_Eyes:
.. _class_ARVRInterface_constant_EYE_MONO: .. _class_ARVRInterface_constant_EYE_MONO:
@@ -93,6 +95,8 @@ enum **Eyes**:
- **EYE_RIGHT** = **2** --- Right eye output, this is mostly used internally when rendering the image for the right eye and obtaining positioning and projection information. - **EYE_RIGHT** = **2** --- Right eye output, this is mostly used internally when rendering the image for the right eye and obtaining positioning and projection information.
----
.. _enum_ARVRInterface_Tracking_status: .. _enum_ARVRInterface_Tracking_status:
.. _class_ARVRInterface_constant_ARVR_NORMAL_TRACKING: .. _class_ARVRInterface_constant_ARVR_NORMAL_TRACKING:
@@ -139,6 +143,8 @@ Property Descriptions
On an AR interface, is our anchor detection enabled? On an AR interface, is our anchor detection enabled?
----
.. _class_ARVRInterface_property_interface_is_initialized: .. _class_ARVRInterface_property_interface_is_initialized:
- :ref:`bool<class_bool>` **interface_is_initialized** - :ref:`bool<class_bool>` **interface_is_initialized**
@@ -151,6 +157,8 @@ On an AR interface, is our anchor detection enabled?
Has this interface been initialized? Has this interface been initialized?
----
.. _class_ARVRInterface_property_interface_is_primary: .. _class_ARVRInterface_property_interface_is_primary:
- :ref:`bool<class_bool>` **interface_is_primary** - :ref:`bool<class_bool>` **interface_is_primary**
@@ -172,24 +180,32 @@ Method Descriptions
Returns a combination of flags providing information about the capabilities of this interface. Returns a combination of flags providing information about the capabilities of this interface.
----
.. _class_ARVRInterface_method_get_name: .. _class_ARVRInterface_method_get_name:
- :ref:`String<class_String>` **get_name** **(** **)** const - :ref:`String<class_String>` **get_name** **(** **)** const
Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc). Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc).
----
.. _class_ARVRInterface_method_get_render_targetsize: .. _class_ARVRInterface_method_get_render_targetsize:
- :ref:`Vector2<class_Vector2>` **get_render_targetsize** **(** **)** - :ref:`Vector2<class_Vector2>` **get_render_targetsize** **(** **)**
Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform. Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform.
----
.. _class_ARVRInterface_method_get_tracking_status: .. _class_ARVRInterface_method_get_tracking_status:
- :ref:`Tracking_status<enum_ARVRInterface_Tracking_status>` **get_tracking_status** **(** **)** const - :ref:`Tracking_status<enum_ARVRInterface_Tracking_status>` **get_tracking_status** **(** **)** const
If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking. If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking.
----
.. _class_ARVRInterface_method_initialize: .. _class_ARVRInterface_method_initialize:
- :ref:`bool<class_bool>` **initialize** **(** **)** - :ref:`bool<class_bool>` **initialize** **(** **)**
@@ -204,12 +220,16 @@ If you do this for a platform that handles its own output (such as OpenVR) Godot
While currently not used you can activate additional interfaces, you may wish to do this if you want to track controllers from other platforms. However at this point in time only one interface can render to an HMD. While currently not used you can activate additional interfaces, you may wish to do this if you want to track controllers from other platforms. However at this point in time only one interface can render to an HMD.
----
.. _class_ARVRInterface_method_is_stereo: .. _class_ARVRInterface_method_is_stereo:
- :ref:`bool<class_bool>` **is_stereo** **(** **)** - :ref:`bool<class_bool>` **is_stereo** **(** **)**
Returns ``true`` if the current output of this interface is in stereo. Returns ``true`` if the current output of this interface is in stereo.
----
.. _class_ARVRInterface_method_uninitialize: .. _class_ARVRInterface_method_uninitialize:
- void **uninitialize** **(** **)** - void **uninitialize** **(** **)**

16
classes/class_arvrpositionaltracker.rst
View File

@@ -100,48 +100,64 @@ Method Descriptions
Returns the hand holding this tracker, if known. See TRACKER\_\* constants. Returns the hand holding this tracker, if known. See TRACKER\_\* constants.
----
.. _class_ARVRPositionalTracker_method_get_joy_id: .. _class_ARVRPositionalTracker_method_get_joy_id:
- :ref:`int<class_int>` **get_joy_id** **(** **)** const - :ref:`int<class_int>` **get_joy_id** **(** **)** const
If this is a controller that is being tracked the controller will also be represented by a joystick entry with this id. If this is a controller that is being tracked the controller will also be represented by a joystick entry with this id.
----
.. _class_ARVRPositionalTracker_method_get_name: .. _class_ARVRPositionalTracker_method_get_name:
- :ref:`String<class_String>` **get_name** **(** **)** const - :ref:`String<class_String>` **get_name** **(** **)** const
Returns the controller or anchor point's name if available. Returns the controller or anchor point's name if available.
----
.. _class_ARVRPositionalTracker_method_get_orientation: .. _class_ARVRPositionalTracker_method_get_orientation:
- :ref:`Basis<class_Basis>` **get_orientation** **(** **)** const - :ref:`Basis<class_Basis>` **get_orientation** **(** **)** const
Returns the controller's orientation matrix. Returns the controller's orientation matrix.
----
.. _class_ARVRPositionalTracker_method_get_position: .. _class_ARVRPositionalTracker_method_get_position:
- :ref:`Vector3<class_Vector3>` **get_position** **(** **)** const - :ref:`Vector3<class_Vector3>` **get_position** **(** **)** const
Returns the world-space controller position. Returns the world-space controller position.
----
.. _class_ARVRPositionalTracker_method_get_tracks_orientation: .. _class_ARVRPositionalTracker_method_get_tracks_orientation:
- :ref:`bool<class_bool>` **get_tracks_orientation** **(** **)** const - :ref:`bool<class_bool>` **get_tracks_orientation** **(** **)** const
Returns ``true`` if this device tracks orientation. Returns ``true`` if this device tracks orientation.
----
.. _class_ARVRPositionalTracker_method_get_tracks_position: .. _class_ARVRPositionalTracker_method_get_tracks_position:
- :ref:`bool<class_bool>` **get_tracks_position** **(** **)** const - :ref:`bool<class_bool>` **get_tracks_position** **(** **)** const
Returns ``true`` if this device tracks position. Returns ``true`` if this device tracks position.
----
.. _class_ARVRPositionalTracker_method_get_transform: .. _class_ARVRPositionalTracker_method_get_transform:
- :ref:`Transform<class_Transform>` **get_transform** **(** :ref:`bool<class_bool>` adjust_by_reference_frame **)** const - :ref:`Transform<class_Transform>` **get_transform** **(** :ref:`bool<class_bool>` adjust_by_reference_frame **)** const
Returns the transform combining this device's orientation and position. Returns the transform combining this device's orientation and position.
----
.. _class_ARVRPositionalTracker_method_get_type: .. _class_ARVRPositionalTracker_method_get_type:
- :ref:`TrackerType<enum_ARVRServer_TrackerType>` **get_type** **(** **)** const - :ref:`TrackerType<enum_ARVRServer_TrackerType>` **get_type** **(** **)** const

32
classes/class_arvrserver.rst
View File

@@ -65,18 +65,24 @@ Signals
Signal send when a new interface has been added. Signal send when a new interface has been added.
----
.. _class_ARVRServer_signal_interface_removed: .. _class_ARVRServer_signal_interface_removed:
- **interface_removed** **(** :ref:`String<class_String>` interface_name **)** - **interface_removed** **(** :ref:`String<class_String>` interface_name **)**
Signal send when an interface is removed. Signal send when an interface is removed.
----
.. _class_ARVRServer_signal_tracker_added: .. _class_ARVRServer_signal_tracker_added:
- **tracker_added** **(** :ref:`String<class_String>` tracker_name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)** - **tracker_added** **(** :ref:`String<class_String>` tracker_name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
Signal send when a new tracker has been added. If you don't use a fixed number of controllers or if you're using ARVRAnchors for an AR solution it is important to react to this signal and add the appropriate ARVRController or ARVRAnchor node related to this new tracker. Signal send when a new tracker has been added. If you don't use a fixed number of controllers or if you're using ARVRAnchors for an AR solution it is important to react to this signal and add the appropriate ARVRController or ARVRAnchor node related to this new tracker.
----
.. _class_ARVRServer_signal_tracker_removed: .. _class_ARVRServer_signal_tracker_removed:
- **tracker_removed** **(** :ref:`String<class_String>` tracker_name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)** - **tracker_removed** **(** :ref:`String<class_String>` tracker_name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
@@ -114,6 +120,8 @@ enum **TrackerType**:
- **TRACKER_ANY** = **255** --- Used internally to select all trackers. - **TRACKER_ANY** = **255** --- Used internally to select all trackers.
----
.. _enum_ARVRServer_RotationMode: .. _enum_ARVRServer_RotationMode:
.. _class_ARVRServer_constant_RESET_FULL_ROTATION: .. _class_ARVRServer_constant_RESET_FULL_ROTATION:
@@ -148,6 +156,8 @@ Property Descriptions
| *Getter* | get_primary_interface() | | *Getter* | get_primary_interface() |
+----------+------------------------------+ +----------+------------------------------+
----
.. _class_ARVRServer_property_world_scale: .. _class_ARVRServer_property_world_scale:
- :ref:`float<class_float>` **world_scale** - :ref:`float<class_float>` **world_scale**
@@ -179,60 +189,82 @@ For this method to produce usable results tracking information should be availab
You should call this method after a few seconds have passed, when the user requests a realignment of the display holding a designated button on a controller for a short period of time, and when implementing a teleport mechanism. You should call this method after a few seconds have passed, when the user requests a realignment of the display holding a designated button on a controller for a short period of time, and when implementing a teleport mechanism.
----
.. _class_ARVRServer_method_find_interface: .. _class_ARVRServer_method_find_interface:
- :ref:`ARVRInterface<class_ARVRInterface>` **find_interface** **(** :ref:`String<class_String>` name **)** const - :ref:`ARVRInterface<class_ARVRInterface>` **find_interface** **(** :ref:`String<class_String>` name **)** const
Find an interface by its name. Say that you're making a game that uses specific capabilities of an AR/VR platform you can find the interface for that platform by name and initialize it. Find an interface by its name. Say that you're making a game that uses specific capabilities of an AR/VR platform you can find the interface for that platform by name and initialize it.
----
.. _class_ARVRServer_method_get_hmd_transform: .. _class_ARVRServer_method_get_hmd_transform:
- :ref:`Transform<class_Transform>` **get_hmd_transform** **(** **)** - :ref:`Transform<class_Transform>` **get_hmd_transform** **(** **)**
Returns the primary interface's transformation. Returns the primary interface's transformation.
----
.. _class_ARVRServer_method_get_interface: .. _class_ARVRServer_method_get_interface:
- :ref:`ARVRInterface<class_ARVRInterface>` **get_interface** **(** :ref:`int<class_int>` idx **)** const - :ref:`ARVRInterface<class_ARVRInterface>` **get_interface** **(** :ref:`int<class_int>` idx **)** const
Get the interface registered at a given index in our list of interfaces. Get the interface registered at a given index in our list of interfaces.
----
.. _class_ARVRServer_method_get_interface_count: .. _class_ARVRServer_method_get_interface_count:
- :ref:`int<class_int>` **get_interface_count** **(** **)** const - :ref:`int<class_int>` **get_interface_count** **(** **)** const
Get the number of interfaces currently registered with the AR/VR server. If your game supports multiple AR/VR platforms, you can look through the available interface, and either present the user with a selection or simply try an initialize each interface and use the first one that returns ``true``. Get the number of interfaces currently registered with the AR/VR server. If your game supports multiple AR/VR platforms, you can look through the available interface, and either present the user with a selection or simply try an initialize each interface and use the first one that returns ``true``.
----
.. _class_ARVRServer_method_get_interfaces: .. _class_ARVRServer_method_get_interfaces:
- :ref:`Array<class_Array>` **get_interfaces** **(** **)** const - :ref:`Array<class_Array>` **get_interfaces** **(** **)** const
Returns a list of available interfaces with both id and name of the interface. Returns a list of available interfaces with both id and name of the interface.
----
.. _class_ARVRServer_method_get_last_commit_usec: .. _class_ARVRServer_method_get_last_commit_usec:
- :ref:`int<class_int>` **get_last_commit_usec** **(** **)** - :ref:`int<class_int>` **get_last_commit_usec** **(** **)**
----
.. _class_ARVRServer_method_get_last_frame_usec: .. _class_ARVRServer_method_get_last_frame_usec:
- :ref:`int<class_int>` **get_last_frame_usec** **(** **)** - :ref:`int<class_int>` **get_last_frame_usec** **(** **)**
----
.. _class_ARVRServer_method_get_last_process_usec: .. _class_ARVRServer_method_get_last_process_usec:
- :ref:`int<class_int>` **get_last_process_usec** **(** **)** - :ref:`int<class_int>` **get_last_process_usec** **(** **)**
----
.. _class_ARVRServer_method_get_reference_frame: .. _class_ARVRServer_method_get_reference_frame:
- :ref:`Transform<class_Transform>` **get_reference_frame** **(** **)** const - :ref:`Transform<class_Transform>` **get_reference_frame** **(** **)** const
Gets our reference frame transform, mostly used internally and exposed for GDNative build interfaces. Gets our reference frame transform, mostly used internally and exposed for GDNative build interfaces.
----
.. _class_ARVRServer_method_get_tracker: .. _class_ARVRServer_method_get_tracker:
- :ref:`ARVRPositionalTracker<class_ARVRPositionalTracker>` **get_tracker** **(** :ref:`int<class_int>` idx **)** const - :ref:`ARVRPositionalTracker<class_ARVRPositionalTracker>` **get_tracker** **(** :ref:`int<class_int>` idx **)** const
Get the positional tracker at the given ID. Get the positional tracker at the given ID.
----
.. _class_ARVRServer_method_get_tracker_count: .. _class_ARVRServer_method_get_tracker_count:
- :ref:`int<class_int>` **get_tracker_count** **(** **)** const - :ref:`int<class_int>` **get_tracker_count** **(** **)** const

42
classes/class_astar.rst
View File

@@ -83,12 +83,16 @@ Method Descriptions
Called when computing the cost between two connected points. Called when computing the cost between two connected points.
----
.. _class_AStar_method__estimate_cost: .. _class_AStar_method__estimate_cost:
- :ref:`float<class_float>` **_estimate_cost** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual - :ref:`float<class_float>` **_estimate_cost** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual
Called when estimating the cost between a point and the path's ending point. Called when estimating the cost between a point and the path's ending point.
----
.. _class_AStar_method_add_point: .. _class_AStar_method_add_point:
- void **add_point** **(** :ref:`int<class_int>` id, :ref:`Vector3<class_Vector3>` position, :ref:`float<class_float>` weight_scale=1.0 **)** - void **add_point** **(** :ref:`int<class_int>` id, :ref:`Vector3<class_Vector3>` position, :ref:`float<class_float>` weight_scale=1.0 **)**
@@ -102,18 +106,24 @@ Adds a new point at the given position with the given identifier. The algorithm
If there already exists a point for the given id, its position and weight scale are updated to the given values. If there already exists a point for the given id, its position and weight scale are updated to the given values.
----
.. _class_AStar_method_are_points_connected: .. _class_AStar_method_are_points_connected:
- :ref:`bool<class_bool>` **are_points_connected** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const - :ref:`bool<class_bool>` **are_points_connected** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const
Returns whether there is a connection/segment between the given points. Returns whether there is a connection/segment between the given points.
----
.. _class_AStar_method_clear: .. _class_AStar_method_clear:
- void **clear** **(** **)** - void **clear** **(** **)**
Clears all the points and segments. Clears all the points and segments.
----
.. _class_AStar_method_connect_points: .. _class_AStar_method_connect_points:
- void **connect_points** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)** - void **connect_points** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)**
@@ -127,24 +137,32 @@ Creates a segment between the given points. If ``bidirectional`` is ``false``, o
astar.add_point(2, Vector3(0, 5, 0)) astar.add_point(2, Vector3(0, 5, 0))
astar.connect_points(1, 2, false) astar.connect_points(1, 2, false)
----
.. _class_AStar_method_disconnect_points: .. _class_AStar_method_disconnect_points:
- void **disconnect_points** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** - void **disconnect_points** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)**
Deletes the segment between the given points. Deletes the segment between the given points.
----
.. _class_AStar_method_get_available_point_id: .. _class_AStar_method_get_available_point_id:
- :ref:`int<class_int>` **get_available_point_id** **(** **)** const - :ref:`int<class_int>` **get_available_point_id** **(** **)** const
Returns the next available point id with no point associated to it. Returns the next available point id with no point associated to it.
----
.. _class_AStar_method_get_closest_point: .. _class_AStar_method_get_closest_point:
- :ref:`int<class_int>` **get_closest_point** **(** :ref:`Vector3<class_Vector3>` to_position **)** const - :ref:`int<class_int>` **get_closest_point** **(** :ref:`Vector3<class_Vector3>` to_position **)** const
Returns the id of the closest point to ``to_position``. Returns -1 if there are no points in the points pool. Returns the id of the closest point to ``to_position``. Returns -1 if there are no points in the points pool.
----
.. _class_AStar_method_get_closest_position_in_segment: .. _class_AStar_method_get_closest_position_in_segment:
- :ref:`Vector3<class_Vector3>` **get_closest_position_in_segment** **(** :ref:`Vector3<class_Vector3>` to_position **)** const - :ref:`Vector3<class_Vector3>` **get_closest_position_in_segment** **(** :ref:`Vector3<class_Vector3>` to_position **)** const
@@ -161,6 +179,8 @@ Returns the closest position to ``to_position`` that resides inside a segment be
The result is in the segment that goes from ``y = 0`` to ``y = 5``. It's the closest position in the segment to the given point. The result is in the segment that goes from ``y = 0`` to ``y = 5``. It's the closest position in the segment to the given point.
----
.. _class_AStar_method_get_id_path: .. _class_AStar_method_get_id_path:
- :ref:`PoolIntArray<class_PoolIntArray>` **get_id_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** - :ref:`PoolIntArray<class_PoolIntArray>` **get_id_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
@@ -184,6 +204,8 @@ Returns an array with the ids of the points that form the path found by AStar be
If you change the 2nd point's weight to 3, then the result will be ``[1, 4, 3]`` instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2. If you change the 2nd point's weight to 3, then the result will be ``[1, 4, 3]`` instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2.
----
.. _class_AStar_method_get_point_connections: .. _class_AStar_method_get_point_connections:
- :ref:`PoolIntArray<class_PoolIntArray>` **get_point_connections** **(** :ref:`int<class_int>` id **)** - :ref:`PoolIntArray<class_PoolIntArray>` **get_point_connections** **(** :ref:`int<class_int>` id **)**
@@ -203,60 +225,80 @@ Returns an array with the ids of the points that form the connect with the given
var neighbors = astar.get_point_connections(1) # Returns [2, 3] var neighbors = astar.get_point_connections(1) # Returns [2, 3]
----
.. _class_AStar_method_get_point_path: .. _class_AStar_method_get_point_path:
- :ref:`PoolVector3Array<class_PoolVector3Array>` **get_point_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** - :ref:`PoolVector3Array<class_PoolVector3Array>` **get_point_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
Returns an array with the points that are in the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. Returns an array with the points that are in the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path.
----
.. _class_AStar_method_get_point_position: .. _class_AStar_method_get_point_position:
- :ref:`Vector3<class_Vector3>` **get_point_position** **(** :ref:`int<class_int>` id **)** const - :ref:`Vector3<class_Vector3>` **get_point_position** **(** :ref:`int<class_int>` id **)** const
Returns the position of the point associated with the given id. Returns the position of the point associated with the given id.
----
.. _class_AStar_method_get_point_weight_scale: .. _class_AStar_method_get_point_weight_scale:
- :ref:`float<class_float>` **get_point_weight_scale** **(** :ref:`int<class_int>` id **)** const - :ref:`float<class_float>` **get_point_weight_scale** **(** :ref:`int<class_int>` id **)** const
Returns the weight scale of the point associated with the given id. Returns the weight scale of the point associated with the given id.
----
.. _class_AStar_method_get_points: .. _class_AStar_method_get_points:
- :ref:`Array<class_Array>` **get_points** **(** **)** - :ref:`Array<class_Array>` **get_points** **(** **)**
Returns an array of all points. Returns an array of all points.
----
.. _class_AStar_method_has_point: .. _class_AStar_method_has_point:
- :ref:`bool<class_bool>` **has_point** **(** :ref:`int<class_int>` id **)** const - :ref:`bool<class_bool>` **has_point** **(** :ref:`int<class_int>` id **)** const
Returns whether a point associated with the given id exists. Returns whether a point associated with the given id exists.
----
.. _class_AStar_method_is_point_disabled: .. _class_AStar_method_is_point_disabled:
- :ref:`bool<class_bool>` **is_point_disabled** **(** :ref:`int<class_int>` id **)** const - :ref:`bool<class_bool>` **is_point_disabled** **(** :ref:`int<class_int>` id **)** const
Returns whether a point is disabled or not for pathfinding. By default, all points are enabled. Returns whether a point is disabled or not for pathfinding. By default, all points are enabled.
----
.. _class_AStar_method_remove_point: .. _class_AStar_method_remove_point:
- void **remove_point** **(** :ref:`int<class_int>` id **)** - void **remove_point** **(** :ref:`int<class_int>` id **)**
Removes the point associated with the given id from the points pool. Removes the point associated with the given id from the points pool.
----
.. _class_AStar_method_set_point_disabled: .. _class_AStar_method_set_point_disabled:
- void **set_point_disabled** **(** :ref:`int<class_int>` id, :ref:`bool<class_bool>` disabled=true **)** - void **set_point_disabled** **(** :ref:`int<class_int>` id, :ref:`bool<class_bool>` disabled=true **)**
Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle. Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle.
----
.. _class_AStar_method_set_point_position: .. _class_AStar_method_set_point_position:
- void **set_point_position** **(** :ref:`int<class_int>` id, :ref:`Vector3<class_Vector3>` position **)** - void **set_point_position** **(** :ref:`int<class_int>` id, :ref:`Vector3<class_Vector3>` position **)**
Sets the position for the point with the given id. Sets the position for the point with the given id.
----
.. _class_AStar_method_set_point_weight_scale: .. _class_AStar_method_set_point_weight_scale:
- void **set_point_weight_scale** **(** :ref:`int<class_int>` id, :ref:`float<class_float>` weight_scale **)** - void **set_point_weight_scale** **(** :ref:`int<class_int>` id, :ref:`float<class_float>` weight_scale **)**

6
classes/class_atlastexture.rst
View File

@@ -53,6 +53,8 @@ Property Descriptions
The texture that contains the atlas. Can be any :ref:`Texture<class_Texture>` subtype. The texture that contains the atlas. Can be any :ref:`Texture<class_Texture>` subtype.
----
.. _class_AtlasTexture_property_filter_clip: .. _class_AtlasTexture_property_filter_clip:
- :ref:`bool<class_bool>` **filter_clip** - :ref:`bool<class_bool>` **filter_clip**
@@ -65,6 +67,8 @@ The texture that contains the atlas. Can be any :ref:`Texture<class_Texture>` su
If ``true``, clips the area outside of the region to avoid bleeding of the surrounding texture pixels. If ``true``, clips the area outside of the region to avoid bleeding of the surrounding texture pixels.
----
.. _class_AtlasTexture_property_margin: .. _class_AtlasTexture_property_margin:
- :ref:`Rect2<class_Rect2>` **margin** - :ref:`Rect2<class_Rect2>` **margin**
@@ -77,6 +81,8 @@ If ``true``, clips the area outside of the region to avoid bleeding of the surro
The margin around the region. The :ref:`Rect2<class_Rect2>`'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin. The margin around the region. The :ref:`Rect2<class_Rect2>`'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin.
----
.. _class_AtlasTexture_property_region: .. _class_AtlasTexture_property_region:
- :ref:`Rect2<class_Rect2>` **region** - :ref:`Rect2<class_Rect2>` **region**

52
classes/class_audioeffectchorus.rst
View File

@@ -97,6 +97,8 @@ Property Descriptions
The effect's raw signal. The effect's raw signal.
----
.. _class_AudioEffectChorus_property_voice/1/cutoff_hz: .. _class_AudioEffectChorus_property_voice/1/cutoff_hz:
- :ref:`float<class_float>` **voice/1/cutoff_hz** - :ref:`float<class_float>` **voice/1/cutoff_hz**
@@ -109,6 +111,8 @@ The effect's raw signal.
The voice's cutoff frequency. The voice's cutoff frequency.
----
.. _class_AudioEffectChorus_property_voice/1/delay_ms: .. _class_AudioEffectChorus_property_voice/1/delay_ms:
- :ref:`float<class_float>` **voice/1/delay_ms** - :ref:`float<class_float>` **voice/1/delay_ms**
@@ -121,6 +125,8 @@ The voice's cutoff frequency.
The voice's signal delay. The voice's signal delay.
----
.. _class_AudioEffectChorus_property_voice/1/depth_ms: .. _class_AudioEffectChorus_property_voice/1/depth_ms:
- :ref:`float<class_float>` **voice/1/depth_ms** - :ref:`float<class_float>` **voice/1/depth_ms**
@@ -133,6 +139,8 @@ The voice's signal delay.
The voice filter's depth. The voice filter's depth.
----
.. _class_AudioEffectChorus_property_voice/1/level_db: .. _class_AudioEffectChorus_property_voice/1/level_db:
- :ref:`float<class_float>` **voice/1/level_db** - :ref:`float<class_float>` **voice/1/level_db**
@@ -145,6 +153,8 @@ The voice filter's depth.
The voice's volume. The voice's volume.
----
.. _class_AudioEffectChorus_property_voice/1/pan: .. _class_AudioEffectChorus_property_voice/1/pan:
- :ref:`float<class_float>` **voice/1/pan** - :ref:`float<class_float>` **voice/1/pan**
@@ -157,6 +167,8 @@ The voice's volume.
The voice's pan level. The voice's pan level.
----
.. _class_AudioEffectChorus_property_voice/1/rate_hz: .. _class_AudioEffectChorus_property_voice/1/rate_hz:
- :ref:`float<class_float>` **voice/1/rate_hz** - :ref:`float<class_float>` **voice/1/rate_hz**
@@ -169,6 +181,8 @@ The voice's pan level.
The voice's filter rate. The voice's filter rate.
----
.. _class_AudioEffectChorus_property_voice/2/cutoff_hz: .. _class_AudioEffectChorus_property_voice/2/cutoff_hz:
- :ref:`float<class_float>` **voice/2/cutoff_hz** - :ref:`float<class_float>` **voice/2/cutoff_hz**
@@ -181,6 +195,8 @@ The voice's filter rate.
The voice's cutoff frequency. The voice's cutoff frequency.
----
.. _class_AudioEffectChorus_property_voice/2/delay_ms: .. _class_AudioEffectChorus_property_voice/2/delay_ms:
- :ref:`float<class_float>` **voice/2/delay_ms** - :ref:`float<class_float>` **voice/2/delay_ms**
@@ -193,6 +209,8 @@ The voice's cutoff frequency.
The voice's signal delay. The voice's signal delay.
----
.. _class_AudioEffectChorus_property_voice/2/depth_ms: .. _class_AudioEffectChorus_property_voice/2/depth_ms:
- :ref:`float<class_float>` **voice/2/depth_ms** - :ref:`float<class_float>` **voice/2/depth_ms**
@@ -205,6 +223,8 @@ The voice's signal delay.
The voice filter's depth. The voice filter's depth.
----
.. _class_AudioEffectChorus_property_voice/2/level_db: .. _class_AudioEffectChorus_property_voice/2/level_db:
- :ref:`float<class_float>` **voice/2/level_db** - :ref:`float<class_float>` **voice/2/level_db**
@@ -217,6 +237,8 @@ The voice filter's depth.
The voice's volume. The voice's volume.
----
.. _class_AudioEffectChorus_property_voice/2/pan: .. _class_AudioEffectChorus_property_voice/2/pan:
- :ref:`float<class_float>` **voice/2/pan** - :ref:`float<class_float>` **voice/2/pan**
@@ -229,6 +251,8 @@ The voice's volume.
The voice's pan level. The voice's pan level.
----
.. _class_AudioEffectChorus_property_voice/2/rate_hz: .. _class_AudioEffectChorus_property_voice/2/rate_hz:
- :ref:`float<class_float>` **voice/2/rate_hz** - :ref:`float<class_float>` **voice/2/rate_hz**
@@ -241,6 +265,8 @@ The voice's pan level.
The voice's filter rate. The voice's filter rate.
----
.. _class_AudioEffectChorus_property_voice/3/cutoff_hz: .. _class_AudioEffectChorus_property_voice/3/cutoff_hz:
- :ref:`float<class_float>` **voice/3/cutoff_hz** - :ref:`float<class_float>` **voice/3/cutoff_hz**
@@ -253,6 +279,8 @@ The voice's filter rate.
The voice's cutoff frequency. The voice's cutoff frequency.
----
.. _class_AudioEffectChorus_property_voice/3/delay_ms: .. _class_AudioEffectChorus_property_voice/3/delay_ms:
- :ref:`float<class_float>` **voice/3/delay_ms** - :ref:`float<class_float>` **voice/3/delay_ms**
@@ -265,6 +293,8 @@ The voice's cutoff frequency.
The voice's signal delay. The voice's signal delay.
----
.. _class_AudioEffectChorus_property_voice/3/depth_ms: .. _class_AudioEffectChorus_property_voice/3/depth_ms:
- :ref:`float<class_float>` **voice/3/depth_ms** - :ref:`float<class_float>` **voice/3/depth_ms**
@@ -277,6 +307,8 @@ The voice's signal delay.
The voice filter's depth. The voice filter's depth.
----
.. _class_AudioEffectChorus_property_voice/3/level_db: .. _class_AudioEffectChorus_property_voice/3/level_db:
- :ref:`float<class_float>` **voice/3/level_db** - :ref:`float<class_float>` **voice/3/level_db**
@@ -289,6 +321,8 @@ The voice filter's depth.
The voice's volume. The voice's volume.
----
.. _class_AudioEffectChorus_property_voice/3/pan: .. _class_AudioEffectChorus_property_voice/3/pan:
- :ref:`float<class_float>` **voice/3/pan** - :ref:`float<class_float>` **voice/3/pan**
@@ -301,6 +335,8 @@ The voice's volume.
The voice's pan level. The voice's pan level.
----
.. _class_AudioEffectChorus_property_voice/3/rate_hz: .. _class_AudioEffectChorus_property_voice/3/rate_hz:
- :ref:`float<class_float>` **voice/3/rate_hz** - :ref:`float<class_float>` **voice/3/rate_hz**
@@ -313,6 +349,8 @@ The voice's pan level.
The voice's filter rate. The voice's filter rate.
----
.. _class_AudioEffectChorus_property_voice/4/cutoff_hz: .. _class_AudioEffectChorus_property_voice/4/cutoff_hz:
- :ref:`float<class_float>` **voice/4/cutoff_hz** - :ref:`float<class_float>` **voice/4/cutoff_hz**
@@ -325,6 +363,8 @@ The voice's filter rate.
The voice's cutoff frequency. The voice's cutoff frequency.
----
.. _class_AudioEffectChorus_property_voice/4/delay_ms: .. _class_AudioEffectChorus_property_voice/4/delay_ms:
- :ref:`float<class_float>` **voice/4/delay_ms** - :ref:`float<class_float>` **voice/4/delay_ms**
@@ -337,6 +377,8 @@ The voice's cutoff frequency.
The voice's signal delay. The voice's signal delay.
----
.. _class_AudioEffectChorus_property_voice/4/depth_ms: .. _class_AudioEffectChorus_property_voice/4/depth_ms:
- :ref:`float<class_float>` **voice/4/depth_ms** - :ref:`float<class_float>` **voice/4/depth_ms**
@@ -349,6 +391,8 @@ The voice's signal delay.
The voice filter's depth. The voice filter's depth.
----
.. _class_AudioEffectChorus_property_voice/4/level_db: .. _class_AudioEffectChorus_property_voice/4/level_db:
- :ref:`float<class_float>` **voice/4/level_db** - :ref:`float<class_float>` **voice/4/level_db**
@@ -361,6 +405,8 @@ The voice filter's depth.
The voice's volume. The voice's volume.
----
.. _class_AudioEffectChorus_property_voice/4/pan: .. _class_AudioEffectChorus_property_voice/4/pan:
- :ref:`float<class_float>` **voice/4/pan** - :ref:`float<class_float>` **voice/4/pan**
@@ -373,6 +419,8 @@ The voice's volume.
The voice's pan level. The voice's pan level.
----
.. _class_AudioEffectChorus_property_voice/4/rate_hz: .. _class_AudioEffectChorus_property_voice/4/rate_hz:
- :ref:`float<class_float>` **voice/4/rate_hz** - :ref:`float<class_float>` **voice/4/rate_hz**
@@ -385,6 +433,8 @@ The voice's pan level.
The voice's filter rate. The voice's filter rate.
----
.. _class_AudioEffectChorus_property_voice_count: .. _class_AudioEffectChorus_property_voice_count:
- :ref:`int<class_int>` **voice_count** - :ref:`int<class_int>` **voice_count**
@@ -397,6 +447,8 @@ The voice's filter rate.
The amount of voices in the effect. The amount of voices in the effect.
----
.. _class_AudioEffectChorus_property_wet: .. _class_AudioEffectChorus_property_wet:
- :ref:`float<class_float>` **wet** - :ref:`float<class_float>` **wet**

12
classes/class_audioeffectcompressor.rst
View File

@@ -69,6 +69,8 @@ Property Descriptions
Compressor's reaction time when the signal exceeds the threshold. Value can range from 20 to 2000. Default value: ``20ms``. Compressor's reaction time when the signal exceeds the threshold. Value can range from 20 to 2000. Default value: ``20ms``.
----
.. _class_AudioEffectCompressor_property_gain: .. _class_AudioEffectCompressor_property_gain:
- :ref:`float<class_float>` **gain** - :ref:`float<class_float>` **gain**
@@ -81,6 +83,8 @@ Compressor's reaction time when the signal exceeds the threshold. Value can rang
Gain applied to the output signal. Gain applied to the output signal.
----
.. _class_AudioEffectCompressor_property_mix: .. _class_AudioEffectCompressor_property_mix:
- :ref:`float<class_float>` **mix** - :ref:`float<class_float>` **mix**
@@ -93,6 +97,8 @@ Gain applied to the output signal.
Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). Default value: ``1``. Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). Default value: ``1``.
----
.. _class_AudioEffectCompressor_property_ratio: .. _class_AudioEffectCompressor_property_ratio:
- :ref:`float<class_float>` **ratio** - :ref:`float<class_float>` **ratio**
@@ -105,6 +111,8 @@ Balance between original signal and effect signal. Value can range from 0 (total
Amount of compression applied to the audio once it passes the threshold level. The higher the ratio the more the loud parts of the audio will be compressed. Value can range from 1 to 48. Default value: ``4``. Amount of compression applied to the audio once it passes the threshold level. The higher the ratio the more the loud parts of the audio will be compressed. Value can range from 1 to 48. Default value: ``4``.
----
.. _class_AudioEffectCompressor_property_release_ms: .. _class_AudioEffectCompressor_property_release_ms:
- :ref:`float<class_float>` **release_ms** - :ref:`float<class_float>` **release_ms**
@@ -117,6 +125,8 @@ Amount of compression applied to the audio once it passes the threshold level. T
Compressor's delay time to stop reducing the signal after the signal level falls below the threshold. Value can range from 20 to 2000. Default value: ``250ms``. Compressor's delay time to stop reducing the signal after the signal level falls below the threshold. Value can range from 20 to 2000. Default value: ``250ms``.
----
.. _class_AudioEffectCompressor_property_sidechain: .. _class_AudioEffectCompressor_property_sidechain:
- :ref:`String<class_String>` **sidechain** - :ref:`String<class_String>` **sidechain**
@@ -129,6 +139,8 @@ Compressor's delay time to stop reducing the signal after the signal level falls
Reduce the sound level using another audio bus for threshold detection. Reduce the sound level using another audio bus for threshold detection.
----
.. _class_AudioEffectCompressor_property_threshold: .. _class_AudioEffectCompressor_property_threshold:
- :ref:`float<class_float>` **threshold** - :ref:`float<class_float>` **threshold**

24
classes/class_audioeffectdelay.rst
View File

@@ -71,6 +71,8 @@ Property Descriptions
Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1. Default value: ``1``. Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1. Default value: ``1``.
----
.. _class_AudioEffectDelay_property_feedback/active: .. _class_AudioEffectDelay_property_feedback/active:
- :ref:`bool<class_bool>` **feedback/active** - :ref:`bool<class_bool>` **feedback/active**
@@ -83,6 +85,8 @@ Output percent of original sound. At 0, only delayed sounds are output. Value ca
If ``true``, feedback is enabled. Default value: ``false``. If ``true``, feedback is enabled. Default value: ``false``.
----
.. _class_AudioEffectDelay_property_feedback/delay_ms: .. _class_AudioEffectDelay_property_feedback/delay_ms:
- :ref:`float<class_float>` **feedback/delay_ms** - :ref:`float<class_float>` **feedback/delay_ms**
@@ -95,6 +99,8 @@ If ``true``, feedback is enabled. Default value: ``false``.
Feedback delay time in milliseconds. Default value: ``340``. Feedback delay time in milliseconds. Default value: ``340``.
----
.. _class_AudioEffectDelay_property_feedback/level_db: .. _class_AudioEffectDelay_property_feedback/level_db:
- :ref:`float<class_float>` **feedback/level_db** - :ref:`float<class_float>` **feedback/level_db**
@@ -107,6 +113,8 @@ Feedback delay time in milliseconds. Default value: ``340``.
Sound level for ``tap1``. Default value: ``-6 dB``. Sound level for ``tap1``. Default value: ``-6 dB``.
----
.. _class_AudioEffectDelay_property_feedback/lowpass: .. _class_AudioEffectDelay_property_feedback/lowpass:
- :ref:`float<class_float>` **feedback/lowpass** - :ref:`float<class_float>` **feedback/lowpass**
@@ -119,6 +127,8 @@ Sound level for ``tap1``. Default value: ``-6 dB``.
Low-pass filter for feedback. Frequencies below the Low Cut value are filtered out of the source signal. Default value: ``16000``. Low-pass filter for feedback. Frequencies below the Low Cut value are filtered out of the source signal. Default value: ``16000``.
----
.. _class_AudioEffectDelay_property_tap1/active: .. _class_AudioEffectDelay_property_tap1/active:
- :ref:`bool<class_bool>` **tap1/active** - :ref:`bool<class_bool>` **tap1/active**
@@ -131,6 +141,8 @@ Low-pass filter for feedback. Frequencies below the Low Cut value are filtered o
If ``true``, ``tap1`` will be enabled. Default value: ``true``. If ``true``, ``tap1`` will be enabled. Default value: ``true``.
----
.. _class_AudioEffectDelay_property_tap1/delay_ms: .. _class_AudioEffectDelay_property_tap1/delay_ms:
- :ref:`float<class_float>` **tap1/delay_ms** - :ref:`float<class_float>` **tap1/delay_ms**
@@ -143,6 +155,8 @@ If ``true``, ``tap1`` will be enabled. Default value: ``true``.
**Tap1** delay time in milliseconds. Default value: ``250ms``. **Tap1** delay time in milliseconds. Default value: ``250ms``.
----
.. _class_AudioEffectDelay_property_tap1/level_db: .. _class_AudioEffectDelay_property_tap1/level_db:
- :ref:`float<class_float>` **tap1/level_db** - :ref:`float<class_float>` **tap1/level_db**
@@ -155,6 +169,8 @@ If ``true``, ``tap1`` will be enabled. Default value: ``true``.
Sound level for ``tap1``. Default value: ``-6 dB``. Sound level for ``tap1``. Default value: ``-6 dB``.
----
.. _class_AudioEffectDelay_property_tap1/pan: .. _class_AudioEffectDelay_property_tap1/pan:
- :ref:`float<class_float>` **tap1/pan** - :ref:`float<class_float>` **tap1/pan**
@@ -167,6 +183,8 @@ Sound level for ``tap1``. Default value: ``-6 dB``.
Pan position for ``tap1``. Value can range from -1 (fully left) to 1 (fully right). Default value: ``0.2``. Pan position for ``tap1``. Value can range from -1 (fully left) to 1 (fully right). Default value: ``0.2``.
----
.. _class_AudioEffectDelay_property_tap2/active: .. _class_AudioEffectDelay_property_tap2/active:
- :ref:`bool<class_bool>` **tap2/active** - :ref:`bool<class_bool>` **tap2/active**
@@ -179,6 +197,8 @@ Pan position for ``tap1``. Value can range from -1 (fully left) to 1 (fully righ
If ``true``, ``tap2`` will be enabled. Default value: ``true``. If ``true``, ``tap2`` will be enabled. Default value: ``true``.
----
.. _class_AudioEffectDelay_property_tap2/delay_ms: .. _class_AudioEffectDelay_property_tap2/delay_ms:
- :ref:`float<class_float>` **tap2/delay_ms** - :ref:`float<class_float>` **tap2/delay_ms**
@@ -191,6 +211,8 @@ If ``true``, ``tap2`` will be enabled. Default value: ``true``.
**Tap2** delay time in milliseconds. Default value: ``500ms``. **Tap2** delay time in milliseconds. Default value: ``500ms``.
----
.. _class_AudioEffectDelay_property_tap2/level_db: .. _class_AudioEffectDelay_property_tap2/level_db:
- :ref:`float<class_float>` **tap2/level_db** - :ref:`float<class_float>` **tap2/level_db**
@@ -203,6 +225,8 @@ If ``true``, ``tap2`` will be enabled. Default value: ``true``.
Sound level for ``tap2``. Default value: ``-12 dB``. Sound level for ``tap2``. Default value: ``-12 dB``.
----
.. _class_AudioEffectDelay_property_tap2/pan: .. _class_AudioEffectDelay_property_tap2/pan:
- :ref:`float<class_float>` **tap2/pan** - :ref:`float<class_float>` **tap2/pan**

8
classes/class_audioeffectdistortion.rst
View File

@@ -84,6 +84,8 @@ Property Descriptions
Distortion power. Value can range from 0 to 1. Default value: ``0``. Distortion power. Value can range from 0 to 1. Default value: ``0``.
----
.. _class_AudioEffectDistortion_property_keep_hf_hz: .. _class_AudioEffectDistortion_property_keep_hf_hz:
- :ref:`float<class_float>` **keep_hf_hz** - :ref:`float<class_float>` **keep_hf_hz**
@@ -96,6 +98,8 @@ Distortion power. Value can range from 0 to 1. Default value: ``0``.
High-pass filter. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000. Default value: ``16000``. High-pass filter. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000. Default value: ``16000``.
----
.. _class_AudioEffectDistortion_property_mode: .. _class_AudioEffectDistortion_property_mode:
- :ref:`Mode<enum_AudioEffectDistortion_Mode>` **mode** - :ref:`Mode<enum_AudioEffectDistortion_Mode>` **mode**
@@ -108,6 +112,8 @@ High-pass filter. Frequencies higher than this value will not be affected by the
Distortion type. Default value: :ref:`MODE_CLIP<class_AudioEffectDistortion_constant_MODE_CLIP>`. Distortion type. Default value: :ref:`MODE_CLIP<class_AudioEffectDistortion_constant_MODE_CLIP>`.
----
.. _class_AudioEffectDistortion_property_post_gain: .. _class_AudioEffectDistortion_property_post_gain:
- :ref:`float<class_float>` **post_gain** - :ref:`float<class_float>` **post_gain**
@@ -120,6 +126,8 @@ Distortion type. Default value: :ref:`MODE_CLIP<class_AudioEffectDistortion_cons
Increases or decreases the volume after the effect. Value can range from -80 to 24. Default value: ``0``. Increases or decreases the volume after the effect. Value can range from -80 to 24. Default value: ``0``.
----
.. _class_AudioEffectDistortion_property_pre_gain: .. _class_AudioEffectDistortion_property_pre_gain:
- :ref:`float<class_float>` **pre_gain** - :ref:`float<class_float>` **pre_gain**

4
classes/class_audioeffecteq.rst
View File

@@ -47,12 +47,16 @@ Method Descriptions
Returns the number of bands of the equalizer. Returns the number of bands of the equalizer.
----
.. _class_AudioEffectEQ_method_get_band_gain_db: .. _class_AudioEffectEQ_method_get_band_gain_db:
- :ref:`float<class_float>` **get_band_gain_db** **(** :ref:`int<class_int>` band_idx **)** const - :ref:`float<class_float>` **get_band_gain_db** **(** :ref:`int<class_int>` band_idx **)** const
Returns the band's gain at the specified index, in dB. Returns the band's gain at the specified index, in dB.
----
.. _class_AudioEffectEQ_method_set_band_gain_db: .. _class_AudioEffectEQ_method_set_band_gain_db:
- void **set_band_gain_db** **(** :ref:`int<class_int>` band_idx, :ref:`float<class_float>` volume_db **)** - void **set_band_gain_db** **(** :ref:`int<class_int>` band_idx, :ref:`float<class_float>` volume_db **)**

6
classes/class_audioeffectfilter.rst
View File

@@ -76,6 +76,8 @@ Property Descriptions
Threshold frequency for the filter. Threshold frequency for the filter.
----
.. _class_AudioEffectFilter_property_db: .. _class_AudioEffectFilter_property_db:
- :ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **db** - :ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **db**
@@ -86,6 +88,8 @@ Threshold frequency for the filter.
| *Getter* | get_db() | | *Getter* | get_db() |
+----------+---------------+ +----------+---------------+
----
.. _class_AudioEffectFilter_property_gain: .. _class_AudioEffectFilter_property_gain:
- :ref:`float<class_float>` **gain** - :ref:`float<class_float>` **gain**
@@ -98,6 +102,8 @@ Threshold frequency for the filter.
Gain amount of the frequencies after the filter. Gain amount of the frequencies after the filter.
----
.. _class_AudioEffectFilter_property_resonance: .. _class_AudioEffectFilter_property_resonance:
- :ref:`float<class_float>` **resonance** - :ref:`float<class_float>` **resonance**

6
classes/class_audioeffectlimiter.rst
View File

@@ -53,6 +53,8 @@ Property Descriptions
The waveform's maximum allowed value. Value can range from -20 to -0.1. Default value: ``-0.1dB``. The waveform's maximum allowed value. Value can range from -20 to -0.1. Default value: ``-0.1dB``.
----
.. _class_AudioEffectLimiter_property_soft_clip_db: .. _class_AudioEffectLimiter_property_soft_clip_db:
- :ref:`float<class_float>` **soft_clip_db** - :ref:`float<class_float>` **soft_clip_db**
@@ -65,6 +67,8 @@ The waveform's maximum allowed value. Value can range from -20 to -0.1. Default
Applies a gain to the limited waves. Value can range from 0 to 6. Default value: ``2dB``. Applies a gain to the limited waves. Value can range from 0 to 6. Default value: ``2dB``.
----
.. _class_AudioEffectLimiter_property_soft_clip_ratio: .. _class_AudioEffectLimiter_property_soft_clip_ratio:
- :ref:`float<class_float>` **soft_clip_ratio** - :ref:`float<class_float>` **soft_clip_ratio**
@@ -75,6 +79,8 @@ Applies a gain to the limited waves. Value can range from 0 to 6. Default value:
| *Getter* | get_soft_clip_ratio() | | *Getter* | get_soft_clip_ratio() |
+----------+----------------------------+ +----------+----------------------------+
----
.. _class_AudioEffectLimiter_property_threshold_db: .. _class_AudioEffectLimiter_property_threshold_db:
- :ref:`float<class_float>` **threshold_db** - :ref:`float<class_float>` **threshold_db**

8
classes/class_audioeffectphaser.rst
View File

@@ -55,6 +55,8 @@ Property Descriptions
Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4. Default value: ``1``. Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4. Default value: ``1``.
----
.. _class_AudioEffectPhaser_property_feedback: .. _class_AudioEffectPhaser_property_feedback:
- :ref:`float<class_float>` **feedback** - :ref:`float<class_float>` **feedback**
@@ -67,6 +69,8 @@ Governs how high the filter frequencies sweep. Low value will primarily affect b
Output percent of modified sound. Value can range from 0.1 to 0.9. Default value: ``0.7``. Output percent of modified sound. Value can range from 0.1 to 0.9. Default value: ``0.7``.
----
.. _class_AudioEffectPhaser_property_range_max_hz: .. _class_AudioEffectPhaser_property_range_max_hz:
- :ref:`float<class_float>` **range_max_hz** - :ref:`float<class_float>` **range_max_hz**
@@ -79,6 +83,8 @@ Output percent of modified sound. Value can range from 0.1 to 0.9. Default value
Determines the maximum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: ``1600hz``. Determines the maximum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: ``1600hz``.
----
.. _class_AudioEffectPhaser_property_range_min_hz: .. _class_AudioEffectPhaser_property_range_min_hz:
- :ref:`float<class_float>` **range_min_hz** - :ref:`float<class_float>` **range_min_hz**
@@ -91,6 +97,8 @@ Determines the maximum frequency affected by the LFO modulations. Value can rang
Determines the minimum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: ``440hz``. Determines the minimum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: ``440hz``.
----
.. _class_AudioEffectPhaser_property_rate_hz: .. _class_AudioEffectPhaser_property_rate_hz:
- :ref:`float<class_float>` **rate_hz** - :ref:`float<class_float>` **rate_hz**

4
classes/class_audioeffectrecord.rst
View File

@@ -56,10 +56,14 @@ Method Descriptions
- :ref:`AudioStreamSample<class_AudioStreamSample>` **get_recording** **(** **)** const - :ref:`AudioStreamSample<class_AudioStreamSample>` **get_recording** **(** **)** const
----
.. _class_AudioEffectRecord_method_is_recording_active: .. _class_AudioEffectRecord_method_is_recording_active:
- :ref:`bool<class_bool>` **is_recording_active** **(** **)** const - :ref:`bool<class_bool>` **is_recording_active** **(** **)** const
----
.. _class_AudioEffectRecord_method_set_recording_active: .. _class_AudioEffectRecord_method_set_recording_active:
- void **set_recording_active** **(** :ref:`bool<class_bool>` record **)** - void **set_recording_active** **(** :ref:`bool<class_bool>` record **)**

14
classes/class_audioeffectreverb.rst
View File

@@ -61,6 +61,8 @@ Property Descriptions
Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. Default value: ``1``. Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. Default value: ``1``.
----
.. _class_AudioEffectReverb_property_dry: .. _class_AudioEffectReverb_property_dry:
- :ref:`float<class_float>` **dry** - :ref:`float<class_float>` **dry**
@@ -73,6 +75,8 @@ Defines how reflective the imaginary room's walls are. Value can range from 0 to
Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. Default value: ``1``. Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. Default value: ``1``.
----
.. _class_AudioEffectReverb_property_hipass: .. _class_AudioEffectReverb_property_hipass:
- :ref:`float<class_float>` **hipass** - :ref:`float<class_float>` **hipass**
@@ -85,6 +89,8 @@ Output percent of original sound. At 0, only modified sound is outputted. Value
High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1. Default value: ``0``. High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1. Default value: ``0``.
----
.. _class_AudioEffectReverb_property_predelay_feedback: .. _class_AudioEffectReverb_property_predelay_feedback:
- :ref:`float<class_float>` **predelay_feedback** - :ref:`float<class_float>` **predelay_feedback**
@@ -97,6 +103,8 @@ High-pass filter passes signals with a frequency higher than a certain cutoff fr
Output percent of predelay. Value can range from 0 to 1. Default value: ``1``. Output percent of predelay. Value can range from 0 to 1. Default value: ``1``.
----
.. _class_AudioEffectReverb_property_predelay_msec: .. _class_AudioEffectReverb_property_predelay_msec:
- :ref:`float<class_float>` **predelay_msec** - :ref:`float<class_float>` **predelay_msec**
@@ -109,6 +117,8 @@ Output percent of predelay. Value can range from 0 to 1. Default value: ``1``.
Time between the original signal and the early reflections of the reverb signal. Default value: ``150ms``. Time between the original signal and the early reflections of the reverb signal. Default value: ``150ms``.
----
.. _class_AudioEffectReverb_property_room_size: .. _class_AudioEffectReverb_property_room_size:
- :ref:`float<class_float>` **room_size** - :ref:`float<class_float>` **room_size**
@@ -121,6 +131,8 @@ Time between the original signal and the early reflections of the reverb signal.
Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. Default value: ``0.8``. Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. Default value: ``0.8``.
----
.. _class_AudioEffectReverb_property_spread: .. _class_AudioEffectReverb_property_spread:
- :ref:`float<class_float>` **spread** - :ref:`float<class_float>` **spread**
@@ -133,6 +145,8 @@ Dimensions of simulated room. Bigger means more echoes. Value can range from 0 t
Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1. Default value: ``1``. Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1. Default value: ``1``.
----
.. _class_AudioEffectReverb_property_wet: .. _class_AudioEffectReverb_property_wet:
- :ref:`float<class_float>` **wet** - :ref:`float<class_float>` **wet**

4
classes/class_audioeffectspectrumanalyzer.rst
View File

@@ -73,6 +73,8 @@ Property Descriptions
| *Getter* | get_buffer_length() | | *Getter* | get_buffer_length() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AudioEffectSpectrumAnalyzer_property_fft_size: .. _class_AudioEffectSpectrumAnalyzer_property_fft_size:
- :ref:`FFT_Size<enum_AudioEffectSpectrumAnalyzer_FFT_Size>` **fft_size** - :ref:`FFT_Size<enum_AudioEffectSpectrumAnalyzer_FFT_Size>` **fft_size**
@@ -83,6 +85,8 @@ Property Descriptions
| *Getter* | get_fft_size() | | *Getter* | get_fft_size() |
+----------+---------------------+ +----------+---------------------+
----
.. _class_AudioEffectSpectrumAnalyzer_property_tap_back_pos: .. _class_AudioEffectSpectrumAnalyzer_property_tap_back_pos:
- :ref:`float<class_float>` **tap_back_pos** - :ref:`float<class_float>` **tap_back_pos**

4
classes/class_audioeffectstereoenhance.rst
View File

@@ -42,6 +42,8 @@ Property Descriptions
| *Getter* | get_pan_pullout() | | *Getter* | get_pan_pullout() |
+----------+------------------------+ +----------+------------------------+
----
.. _class_AudioEffectStereoEnhance_property_surround: .. _class_AudioEffectStereoEnhance_property_surround:
- :ref:`float<class_float>` **surround** - :ref:`float<class_float>` **surround**
@@ -52,6 +54,8 @@ Property Descriptions
| *Getter* | get_surround() | | *Getter* | get_surround() |
+----------+---------------------+ +----------+---------------------+
----
.. _class_AudioEffectStereoEnhance_property_time_pullout_ms: .. _class_AudioEffectStereoEnhance_property_time_pullout_ms:
- :ref:`float<class_float>` **time_pullout_ms** - :ref:`float<class_float>` **time_pullout_ms**

80
classes/class_audioserver.rst
View File

@@ -156,226 +156,306 @@ Method Descriptions
Adds a bus at ``at_position``. Adds a bus at ``at_position``.
----
.. _class_AudioServer_method_add_bus_effect: .. _class_AudioServer_method_add_bus_effect:
- void **add_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`AudioEffect<class_AudioEffect>` effect, :ref:`int<class_int>` at_position=-1 **)** - void **add_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`AudioEffect<class_AudioEffect>` effect, :ref:`int<class_int>` at_position=-1 **)**
Adds an :ref:`AudioEffect<class_AudioEffect>` effect to the bus ``bus_idx`` at ``at_position``. Adds an :ref:`AudioEffect<class_AudioEffect>` effect to the bus ``bus_idx`` at ``at_position``.
----
.. _class_AudioServer_method_capture_get_device: .. _class_AudioServer_method_capture_get_device:
- :ref:`String<class_String>` **capture_get_device** **(** **)** - :ref:`String<class_String>` **capture_get_device** **(** **)**
----
.. _class_AudioServer_method_capture_get_device_list: .. _class_AudioServer_method_capture_get_device_list:
- :ref:`Array<class_Array>` **capture_get_device_list** **(** **)** - :ref:`Array<class_Array>` **capture_get_device_list** **(** **)**
----
.. _class_AudioServer_method_capture_set_device: .. _class_AudioServer_method_capture_set_device:
- void **capture_set_device** **(** :ref:`String<class_String>` name **)** - void **capture_set_device** **(** :ref:`String<class_String>` name **)**
----
.. _class_AudioServer_method_generate_bus_layout: .. _class_AudioServer_method_generate_bus_layout:
- :ref:`AudioBusLayout<class_AudioBusLayout>` **generate_bus_layout** **(** **)** const - :ref:`AudioBusLayout<class_AudioBusLayout>` **generate_bus_layout** **(** **)** const
Generates an :ref:`AudioBusLayout<class_AudioBusLayout>` using the available buses and effects. Generates an :ref:`AudioBusLayout<class_AudioBusLayout>` using the available buses and effects.
----
.. _class_AudioServer_method_get_bus_channels: .. _class_AudioServer_method_get_bus_channels:
- :ref:`int<class_int>` **get_bus_channels** **(** :ref:`int<class_int>` bus_idx **)** const - :ref:`int<class_int>` **get_bus_channels** **(** :ref:`int<class_int>` bus_idx **)** const
Returns the amount of channels of the bus at index ``bus_idx``. Returns the amount of channels of the bus at index ``bus_idx``.
----
.. _class_AudioServer_method_get_bus_count: .. _class_AudioServer_method_get_bus_count:
- :ref:`int<class_int>` **get_bus_count** **(** **)** const - :ref:`int<class_int>` **get_bus_count** **(** **)** const
Returns the number of available buses. Returns the number of available buses.
----
.. _class_AudioServer_method_get_bus_effect: .. _class_AudioServer_method_get_bus_effect:
- :ref:`AudioEffect<class_AudioEffect>` **get_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** - :ref:`AudioEffect<class_AudioEffect>` **get_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)**
Returns the :ref:`AudioEffect<class_AudioEffect>` at position ``effect_idx`` in bus ``bus_idx``. Returns the :ref:`AudioEffect<class_AudioEffect>` at position ``effect_idx`` in bus ``bus_idx``.
----
.. _class_AudioServer_method_get_bus_effect_count: .. _class_AudioServer_method_get_bus_effect_count:
- :ref:`int<class_int>` **get_bus_effect_count** **(** :ref:`int<class_int>` bus_idx **)** - :ref:`int<class_int>` **get_bus_effect_count** **(** :ref:`int<class_int>` bus_idx **)**
Returns the number of effects on the bus at ``bus_idx``. Returns the number of effects on the bus at ``bus_idx``.
----
.. _class_AudioServer_method_get_bus_effect_instance: .. _class_AudioServer_method_get_bus_effect_instance:
- :ref:`AudioEffectInstance<class_AudioEffectInstance>` **get_bus_effect_instance** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` channel=0 **)** - :ref:`AudioEffectInstance<class_AudioEffectInstance>` **get_bus_effect_instance** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` channel=0 **)**
----
.. _class_AudioServer_method_get_bus_index: .. _class_AudioServer_method_get_bus_index:
- :ref:`int<class_int>` **get_bus_index** **(** :ref:`String<class_String>` bus_name **)** const - :ref:`int<class_int>` **get_bus_index** **(** :ref:`String<class_String>` bus_name **)** const
Returns the index of the bus with the name ``bus_name``. Returns the index of the bus with the name ``bus_name``.
----
.. _class_AudioServer_method_get_bus_name: .. _class_AudioServer_method_get_bus_name:
- :ref:`String<class_String>` **get_bus_name** **(** :ref:`int<class_int>` bus_idx **)** const - :ref:`String<class_String>` **get_bus_name** **(** :ref:`int<class_int>` bus_idx **)** const
Returns the name of the bus with the index ``bus_idx``. Returns the name of the bus with the index ``bus_idx``.
----
.. _class_AudioServer_method_get_bus_peak_volume_left_db: .. _class_AudioServer_method_get_bus_peak_volume_left_db:
- :ref:`float<class_float>` **get_bus_peak_volume_left_db** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const - :ref:`float<class_float>` **get_bus_peak_volume_left_db** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const
Returns the peak volume of the left speaker at bus index ``bus_idx`` and channel index ``channel``. Returns the peak volume of the left speaker at bus index ``bus_idx`` and channel index ``channel``.
----
.. _class_AudioServer_method_get_bus_peak_volume_right_db: .. _class_AudioServer_method_get_bus_peak_volume_right_db:
- :ref:`float<class_float>` **get_bus_peak_volume_right_db** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const - :ref:`float<class_float>` **get_bus_peak_volume_right_db** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const
Returns the peak volume of the right speaker at bus index ``bus_idx`` and channel index ``channel``. Returns the peak volume of the right speaker at bus index ``bus_idx`` and channel index ``channel``.
----
.. _class_AudioServer_method_get_bus_send: .. _class_AudioServer_method_get_bus_send:
- :ref:`String<class_String>` **get_bus_send** **(** :ref:`int<class_int>` bus_idx **)** const - :ref:`String<class_String>` **get_bus_send** **(** :ref:`int<class_int>` bus_idx **)** const
Returns the name of the bus that the bus at index ``bus_idx`` sends to. Returns the name of the bus that the bus at index ``bus_idx`` sends to.
----
.. _class_AudioServer_method_get_bus_volume_db: .. _class_AudioServer_method_get_bus_volume_db:
- :ref:`float<class_float>` **get_bus_volume_db** **(** :ref:`int<class_int>` bus_idx **)** const - :ref:`float<class_float>` **get_bus_volume_db** **(** :ref:`int<class_int>` bus_idx **)** const
Returns the volume of the bus at index ``bus_idx`` in dB. Returns the volume of the bus at index ``bus_idx`` in dB.
----
.. _class_AudioServer_method_get_device: .. _class_AudioServer_method_get_device:
- :ref:`String<class_String>` **get_device** **(** **)** - :ref:`String<class_String>` **get_device** **(** **)**
----
.. _class_AudioServer_method_get_device_list: .. _class_AudioServer_method_get_device_list:
- :ref:`Array<class_Array>` **get_device_list** **(** **)** - :ref:`Array<class_Array>` **get_device_list** **(** **)**
----
.. _class_AudioServer_method_get_mix_rate: .. _class_AudioServer_method_get_mix_rate:
- :ref:`float<class_float>` **get_mix_rate** **(** **)** const - :ref:`float<class_float>` **get_mix_rate** **(** **)** const
Returns the sample rate at the output of the audioserver. Returns the sample rate at the output of the audioserver.
----
.. _class_AudioServer_method_get_speaker_mode: .. _class_AudioServer_method_get_speaker_mode:
- :ref:`SpeakerMode<enum_AudioServer_SpeakerMode>` **get_speaker_mode** **(** **)** const - :ref:`SpeakerMode<enum_AudioServer_SpeakerMode>` **get_speaker_mode** **(** **)** const
Returns the speaker configuration. Returns the speaker configuration.
----
.. _class_AudioServer_method_is_bus_bypassing_effects: .. _class_AudioServer_method_is_bus_bypassing_effects:
- :ref:`bool<class_bool>` **is_bus_bypassing_effects** **(** :ref:`int<class_int>` bus_idx **)** const - :ref:`bool<class_bool>` **is_bus_bypassing_effects** **(** :ref:`int<class_int>` bus_idx **)** const
If ``true``, the bus at index ``bus_idx`` is bypassing effects. If ``true``, the bus at index ``bus_idx`` is bypassing effects.
----
.. _class_AudioServer_method_is_bus_effect_enabled: .. _class_AudioServer_method_is_bus_effect_enabled:
- :ref:`bool<class_bool>` **is_bus_effect_enabled** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** const - :ref:`bool<class_bool>` **is_bus_effect_enabled** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** const
If ``true``, the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled. If ``true``, the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled.
----
.. _class_AudioServer_method_is_bus_mute: .. _class_AudioServer_method_is_bus_mute:
- :ref:`bool<class_bool>` **is_bus_mute** **(** :ref:`int<class_int>` bus_idx **)** const - :ref:`bool<class_bool>` **is_bus_mute** **(** :ref:`int<class_int>` bus_idx **)** const
If ``true``, the bus at index ``bus_idx`` is muted. If ``true``, the bus at index ``bus_idx`` is muted.
----
.. _class_AudioServer_method_is_bus_solo: .. _class_AudioServer_method_is_bus_solo:
- :ref:`bool<class_bool>` **is_bus_solo** **(** :ref:`int<class_int>` bus_idx **)** const - :ref:`bool<class_bool>` **is_bus_solo** **(** :ref:`int<class_int>` bus_idx **)** const
If ``true``, the bus at index ``bus_idx`` is in solo mode. If ``true``, the bus at index ``bus_idx`` is in solo mode.
----
.. _class_AudioServer_method_lock: .. _class_AudioServer_method_lock:
- void **lock** **(** **)** - void **lock** **(** **)**
Locks the audio drivers mainloop. Remember to unlock it afterwards. Locks the audio drivers mainloop. Remember to unlock it afterwards.
----
.. _class_AudioServer_method_move_bus: .. _class_AudioServer_method_move_bus:
- void **move_bus** **(** :ref:`int<class_int>` index, :ref:`int<class_int>` to_index **)** - void **move_bus** **(** :ref:`int<class_int>` index, :ref:`int<class_int>` to_index **)**
Moves the bus from index ``index`` to index ``to_index``. Moves the bus from index ``index`` to index ``to_index``.
----
.. _class_AudioServer_method_remove_bus: .. _class_AudioServer_method_remove_bus:
- void **remove_bus** **(** :ref:`int<class_int>` index **)** - void **remove_bus** **(** :ref:`int<class_int>` index **)**
Removes the bus at index ``index``. Removes the bus at index ``index``.
----
.. _class_AudioServer_method_remove_bus_effect: .. _class_AudioServer_method_remove_bus_effect:
- void **remove_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** - void **remove_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)**
Removes the effect at index ``effect_idx`` from the bus at index ``bus_idx``. Removes the effect at index ``effect_idx`` from the bus at index ``bus_idx``.
----
.. _class_AudioServer_method_set_bus_bypass_effects: .. _class_AudioServer_method_set_bus_bypass_effects:
- void **set_bus_bypass_effects** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** - void **set_bus_bypass_effects** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)**
If ``true``, the bus at index ``bus_idx`` is bypassing effects. If ``true``, the bus at index ``bus_idx`` is bypassing effects.
----
.. _class_AudioServer_method_set_bus_count: .. _class_AudioServer_method_set_bus_count:
- void **set_bus_count** **(** :ref:`int<class_int>` amount **)** - void **set_bus_count** **(** :ref:`int<class_int>` amount **)**
Adds and removes buses to make the number of buses match ``amount``. Adds and removes buses to make the number of buses match ``amount``.
----
.. _class_AudioServer_method_set_bus_effect_enabled: .. _class_AudioServer_method_set_bus_effect_enabled:
- void **set_bus_effect_enabled** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`bool<class_bool>` enabled **)** - void **set_bus_effect_enabled** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`bool<class_bool>` enabled **)**
If ``true``, the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled. If ``true``, the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled.
----
.. _class_AudioServer_method_set_bus_layout: .. _class_AudioServer_method_set_bus_layout:
- void **set_bus_layout** **(** :ref:`AudioBusLayout<class_AudioBusLayout>` bus_layout **)** - void **set_bus_layout** **(** :ref:`AudioBusLayout<class_AudioBusLayout>` bus_layout **)**
Overwrites the currently used :ref:`AudioBusLayout<class_AudioBusLayout>`. Overwrites the currently used :ref:`AudioBusLayout<class_AudioBusLayout>`.
----
.. _class_AudioServer_method_set_bus_mute: .. _class_AudioServer_method_set_bus_mute:
- void **set_bus_mute** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** - void **set_bus_mute** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)**
If ``true``, the bus at index ``bus_idx`` is muted. If ``true``, the bus at index ``bus_idx`` is muted.
----
.. _class_AudioServer_method_set_bus_name: .. _class_AudioServer_method_set_bus_name:
- void **set_bus_name** **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_String>` name **)** - void **set_bus_name** **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_String>` name **)**
Sets the name of the bus at index ``bus_idx`` to ``name``. Sets the name of the bus at index ``bus_idx`` to ``name``.
----
.. _class_AudioServer_method_set_bus_send: .. _class_AudioServer_method_set_bus_send:
- void **set_bus_send** **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_String>` send **)** - void **set_bus_send** **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_String>` send **)**
Connects the output of the bus at ``bus_idx`` to the bus named ``send``. Connects the output of the bus at ``bus_idx`` to the bus named ``send``.
----
.. _class_AudioServer_method_set_bus_solo: .. _class_AudioServer_method_set_bus_solo:
- void **set_bus_solo** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** - void **set_bus_solo** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)**
If ``true``, the bus at index ``bus_idx`` is in solo mode. If ``true``, the bus at index ``bus_idx`` is in solo mode.
----
.. _class_AudioServer_method_set_bus_volume_db: .. _class_AudioServer_method_set_bus_volume_db:
- void **set_bus_volume_db** **(** :ref:`int<class_int>` bus_idx, :ref:`float<class_float>` volume_db **)** - void **set_bus_volume_db** **(** :ref:`int<class_int>` bus_idx, :ref:`float<class_float>` volume_db **)**
Sets the volume of the bus at index ``bus_idx`` to ``volume_db``. Sets the volume of the bus at index ``bus_idx`` to ``volume_db``.
----
.. _class_AudioServer_method_set_device: .. _class_AudioServer_method_set_device:
- void **set_device** **(** :ref:`String<class_String>` device **)** - void **set_device** **(** :ref:`String<class_String>` device **)**
----
.. _class_AudioServer_method_swap_bus_effects: .. _class_AudioServer_method_swap_bus_effects:
- void **swap_bus_effects** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` by_effect_idx **)** - void **swap_bus_effects** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` by_effect_idx **)**
Swaps the position of two effects in bus ``bus_idx``. Swaps the position of two effects in bus ``bus_idx``.
----
.. _class_AudioServer_method_unlock: .. _class_AudioServer_method_unlock:
- void **unlock** **(** **)** - void **unlock** **(** **)**

2
classes/class_audiostreamgenerator.rst
View File

@@ -40,6 +40,8 @@ Property Descriptions
| *Getter* | get_buffer_length() | | *Getter* | get_buffer_length() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AudioStreamGenerator_property_mix_rate: .. _class_AudioStreamGenerator_property_mix_rate:
- :ref:`float<class_float>` **mix_rate** - :ref:`float<class_float>` **mix_rate**

10
classes/class_audiostreamgeneratorplayback.rst
View File

@@ -42,22 +42,32 @@ Method Descriptions
- :ref:`bool<class_bool>` **can_push_buffer** **(** :ref:`int<class_int>` amount **)** const - :ref:`bool<class_bool>` **can_push_buffer** **(** :ref:`int<class_int>` amount **)** const
----
.. _class_AudioStreamGeneratorPlayback_method_clear_buffer: .. _class_AudioStreamGeneratorPlayback_method_clear_buffer:
- void **clear_buffer** **(** **)** - void **clear_buffer** **(** **)**
----
.. _class_AudioStreamGeneratorPlayback_method_get_frames_available: .. _class_AudioStreamGeneratorPlayback_method_get_frames_available:
- :ref:`int<class_int>` **get_frames_available** **(** **)** const - :ref:`int<class_int>` **get_frames_available** **(** **)** const
----
.. _class_AudioStreamGeneratorPlayback_method_get_skips: .. _class_AudioStreamGeneratorPlayback_method_get_skips:
- :ref:`int<class_int>` **get_skips** **(** **)** const - :ref:`int<class_int>` **get_skips** **(** **)** const
----
.. _class_AudioStreamGeneratorPlayback_method_push_buffer: .. _class_AudioStreamGeneratorPlayback_method_push_buffer:
- :ref:`bool<class_bool>` **push_buffer** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` frames **)** - :ref:`bool<class_bool>` **push_buffer** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` frames **)**
----
.. _class_AudioStreamGeneratorPlayback_method_push_frame: .. _class_AudioStreamGeneratorPlayback_method_push_frame:
- :ref:`bool<class_bool>` **push_frame** **(** :ref:`Vector2<class_Vector2>` frame **)** - :ref:`bool<class_bool>` **push_frame** **(** :ref:`Vector2<class_Vector2>` frame **)**

4
classes/class_audiostreamoggvorbis.rst
View File

@@ -49,6 +49,8 @@ Property Descriptions
Contains the audio data in bytes. Contains the audio data in bytes.
----
.. _class_AudioStreamOGGVorbis_property_loop: .. _class_AudioStreamOGGVorbis_property_loop:
- :ref:`bool<class_bool>` **loop** - :ref:`bool<class_bool>` **loop**
@@ -59,6 +61,8 @@ Contains the audio data in bytes.
| *Getter* | has_loop() | | *Getter* | has_loop() |
+----------+-----------------+ +----------+-----------------+
----
.. _class_AudioStreamOGGVorbis_property_loop_offset: .. _class_AudioStreamOGGVorbis_property_loop_offset:
- :ref:`float<class_float>` **loop_offset** - :ref:`float<class_float>` **loop_offset**

22
classes/class_audiostreamplayer.rst
View File

@@ -107,6 +107,8 @@ Property Descriptions
If ``true``, audio plays when added to scene tree. Default value: ``false``. If ``true``, audio plays when added to scene tree. Default value: ``false``.
----
.. _class_AudioStreamPlayer_property_bus: .. _class_AudioStreamPlayer_property_bus:
- :ref:`String<class_String>` **bus** - :ref:`String<class_String>` **bus**
@@ -119,6 +121,8 @@ If ``true``, audio plays when added to scene tree. Default value: ``false``.
Bus on which this audio is playing. Bus on which this audio is playing.
----
.. _class_AudioStreamPlayer_property_mix_target: .. _class_AudioStreamPlayer_property_mix_target:
- :ref:`MixTarget<enum_AudioStreamPlayer_MixTarget>` **mix_target** - :ref:`MixTarget<enum_AudioStreamPlayer_MixTarget>` **mix_target**
@@ -131,6 +135,8 @@ Bus on which this audio is playing.
If the audio configuration has more than two speakers, this sets the target channels. See ``MIX_TARGET_*`` constants. If the audio configuration has more than two speakers, this sets the target channels. See ``MIX_TARGET_*`` constants.
----
.. _class_AudioStreamPlayer_property_pitch_scale: .. _class_AudioStreamPlayer_property_pitch_scale:
- :ref:`float<class_float>` **pitch_scale** - :ref:`float<class_float>` **pitch_scale**
@@ -143,6 +149,8 @@ If the audio configuration has more than two speakers, this sets the target chan
Changes the pitch and the tempo of the audio. Changes the pitch and the tempo of the audio.
----
.. _class_AudioStreamPlayer_property_playing: .. _class_AudioStreamPlayer_property_playing:
- :ref:`bool<class_bool>` **playing** - :ref:`bool<class_bool>` **playing**
@@ -153,6 +161,8 @@ Changes the pitch and the tempo of the audio.
If ``true``, audio is playing. If ``true``, audio is playing.
----
.. _class_AudioStreamPlayer_property_stream: .. _class_AudioStreamPlayer_property_stream:
- :ref:`AudioStream<class_AudioStream>` **stream** - :ref:`AudioStream<class_AudioStream>` **stream**
@@ -165,6 +175,8 @@ If ``true``, audio is playing.
The :ref:`AudioStream<class_AudioStream>` object to be played. The :ref:`AudioStream<class_AudioStream>` object to be played.
----
.. _class_AudioStreamPlayer_property_stream_paused: .. _class_AudioStreamPlayer_property_stream_paused:
- :ref:`bool<class_bool>` **stream_paused** - :ref:`bool<class_bool>` **stream_paused**
@@ -175,6 +187,8 @@ The :ref:`AudioStream<class_AudioStream>` object to be played.
| *Getter* | get_stream_paused() | | *Getter* | get_stream_paused() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AudioStreamPlayer_property_volume_db: .. _class_AudioStreamPlayer_property_volume_db:
- :ref:`float<class_float>` **volume_db** - :ref:`float<class_float>` **volume_db**
@@ -196,22 +210,30 @@ Method Descriptions
Returns the position in the :ref:`AudioStream<class_AudioStream>` in seconds. Returns the position in the :ref:`AudioStream<class_AudioStream>` in seconds.
----
.. _class_AudioStreamPlayer_method_get_stream_playback: .. _class_AudioStreamPlayer_method_get_stream_playback:
- :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` **get_stream_playback** **(** **)** - :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` **get_stream_playback** **(** **)**
----
.. _class_AudioStreamPlayer_method_play: .. _class_AudioStreamPlayer_method_play:
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)** - void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
Plays the audio from the given position 'from_position', in seconds. Plays the audio from the given position 'from_position', in seconds.
----
.. _class_AudioStreamPlayer_method_seek: .. _class_AudioStreamPlayer_method_seek:
- void **seek** **(** :ref:`float<class_float>` to_position **)** - void **seek** **(** :ref:`float<class_float>` to_position **)**
Sets the position from which audio will be played, in seconds. Sets the position from which audio will be played, in seconds.
----
.. _class_AudioStreamPlayer_method_stop: .. _class_AudioStreamPlayer_method_stop:
- void **stop** **(** **)** - void **stop** **(** **)**

26
classes/class_audiostreamplayer2d.rst
View File

@@ -92,6 +92,8 @@ Property Descriptions
Areas in which this sound plays. Areas in which this sound plays.
----
.. _class_AudioStreamPlayer2D_property_attenuation: .. _class_AudioStreamPlayer2D_property_attenuation:
- :ref:`float<class_float>` **attenuation** - :ref:`float<class_float>` **attenuation**
@@ -104,6 +106,8 @@ Areas in which this sound plays.
Dampens audio over distance with this as an exponent. Dampens audio over distance with this as an exponent.
----
.. _class_AudioStreamPlayer2D_property_autoplay: .. _class_AudioStreamPlayer2D_property_autoplay:
- :ref:`bool<class_bool>` **autoplay** - :ref:`bool<class_bool>` **autoplay**
@@ -116,6 +120,8 @@ Dampens audio over distance with this as an exponent.
If ``true``, audio plays when added to scene tree. Default value: ``false``. If ``true``, audio plays when added to scene tree. Default value: ``false``.
----
.. _class_AudioStreamPlayer2D_property_bus: .. _class_AudioStreamPlayer2D_property_bus:
- :ref:`String<class_String>` **bus** - :ref:`String<class_String>` **bus**
@@ -128,6 +134,8 @@ If ``true``, audio plays when added to scene tree. Default value: ``false``.
Bus on which this audio is playing. Bus on which this audio is playing.
----
.. _class_AudioStreamPlayer2D_property_max_distance: .. _class_AudioStreamPlayer2D_property_max_distance:
- :ref:`float<class_float>` **max_distance** - :ref:`float<class_float>` **max_distance**
@@ -140,6 +148,8 @@ Bus on which this audio is playing.
Maximum distance from which audio is still hearable. Maximum distance from which audio is still hearable.
----
.. _class_AudioStreamPlayer2D_property_pitch_scale: .. _class_AudioStreamPlayer2D_property_pitch_scale:
- :ref:`float<class_float>` **pitch_scale** - :ref:`float<class_float>` **pitch_scale**
@@ -152,6 +162,8 @@ Maximum distance from which audio is still hearable.
Changes the pitch and the tempo of the audio. Changes the pitch and the tempo of the audio.
----
.. _class_AudioStreamPlayer2D_property_playing: .. _class_AudioStreamPlayer2D_property_playing:
- :ref:`bool<class_bool>` **playing** - :ref:`bool<class_bool>` **playing**
@@ -162,6 +174,8 @@ Changes the pitch and the tempo of the audio.
If ``true``, audio is playing. If ``true``, audio is playing.
----
.. _class_AudioStreamPlayer2D_property_stream: .. _class_AudioStreamPlayer2D_property_stream:
- :ref:`AudioStream<class_AudioStream>` **stream** - :ref:`AudioStream<class_AudioStream>` **stream**
@@ -174,6 +188,8 @@ If ``true``, audio is playing.
The :ref:`AudioStream<class_AudioStream>` object to be played. The :ref:`AudioStream<class_AudioStream>` object to be played.
----
.. _class_AudioStreamPlayer2D_property_stream_paused: .. _class_AudioStreamPlayer2D_property_stream_paused:
- :ref:`bool<class_bool>` **stream_paused** - :ref:`bool<class_bool>` **stream_paused**
@@ -184,6 +200,8 @@ The :ref:`AudioStream<class_AudioStream>` object to be played.
| *Getter* | get_stream_paused() | | *Getter* | get_stream_paused() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AudioStreamPlayer2D_property_volume_db: .. _class_AudioStreamPlayer2D_property_volume_db:
- :ref:`float<class_float>` **volume_db** - :ref:`float<class_float>` **volume_db**
@@ -205,22 +223,30 @@ Method Descriptions
Returns the position in the :ref:`AudioStream<class_AudioStream>`. Returns the position in the :ref:`AudioStream<class_AudioStream>`.
----
.. _class_AudioStreamPlayer2D_method_get_stream_playback: .. _class_AudioStreamPlayer2D_method_get_stream_playback:
- :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` **get_stream_playback** **(** **)** - :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` **get_stream_playback** **(** **)**
----
.. _class_AudioStreamPlayer2D_method_play: .. _class_AudioStreamPlayer2D_method_play:
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)** - void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
Plays the audio from the given position 'from_position', in seconds. Plays the audio from the given position 'from_position', in seconds.
----
.. _class_AudioStreamPlayer2D_method_seek: .. _class_AudioStreamPlayer2D_method_seek:
- void **seek** **(** :ref:`float<class_float>` to_position **)** - void **seek** **(** :ref:`float<class_float>` to_position **)**
Sets the position from which audio will be played, in seconds. Sets the position from which audio will be played, in seconds.
----
.. _class_AudioStreamPlayer2D_method_stop: .. _class_AudioStreamPlayer2D_method_stop:
- void **stop** **(** **)** - void **stop** **(** **)**

48
classes/class_audiostreamplayer3d.rst
View File

@@ -104,6 +104,8 @@ enum **AttenuationModel**:
- **ATTENUATION_LOGARITHMIC** = **2** --- Logarithmic dampening of loudness according to distance. - **ATTENUATION_LOGARITHMIC** = **2** --- Logarithmic dampening of loudness according to distance.
----
.. _enum_AudioStreamPlayer3D_OutOfRangeMode: .. _enum_AudioStreamPlayer3D_OutOfRangeMode:
.. _class_AudioStreamPlayer3D_constant_OUT_OF_RANGE_MIX: .. _class_AudioStreamPlayer3D_constant_OUT_OF_RANGE_MIX:
@@ -116,6 +118,8 @@ enum **OutOfRangeMode**:
- **OUT_OF_RANGE_PAUSE** = **1** --- Pause this audio when it gets out of range. - **OUT_OF_RANGE_PAUSE** = **1** --- Pause this audio when it gets out of range.
----
.. _enum_AudioStreamPlayer3D_DopplerTracking: .. _enum_AudioStreamPlayer3D_DopplerTracking:
.. _class_AudioStreamPlayer3D_constant_DOPPLER_TRACKING_DISABLED: .. _class_AudioStreamPlayer3D_constant_DOPPLER_TRACKING_DISABLED:
@@ -157,6 +161,8 @@ Property Descriptions
Areas in which this sound plays. Areas in which this sound plays.
----
.. _class_AudioStreamPlayer3D_property_attenuation_filter_cutoff_hz: .. _class_AudioStreamPlayer3D_property_attenuation_filter_cutoff_hz:
- :ref:`float<class_float>` **attenuation_filter_cutoff_hz** - :ref:`float<class_float>` **attenuation_filter_cutoff_hz**
@@ -169,6 +175,8 @@ Areas in which this sound plays.
Dampens audio above this frequency, in Hz. Dampens audio above this frequency, in Hz.
----
.. _class_AudioStreamPlayer3D_property_attenuation_filter_db: .. _class_AudioStreamPlayer3D_property_attenuation_filter_db:
- :ref:`float<class_float>` **attenuation_filter_db** - :ref:`float<class_float>` **attenuation_filter_db**
@@ -181,6 +189,8 @@ Dampens audio above this frequency, in Hz.
Amount how much the filter affects the loudness, in dB. Amount how much the filter affects the loudness, in dB.
----
.. _class_AudioStreamPlayer3D_property_attenuation_model: .. _class_AudioStreamPlayer3D_property_attenuation_model:
- :ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` **attenuation_model** - :ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` **attenuation_model**
@@ -193,6 +203,8 @@ Amount how much the filter affects the loudness, in dB.
Decides if audio should get quieter with distance linearly, quadratically or logarithmically. Decides if audio should get quieter with distance linearly, quadratically or logarithmically.
----
.. _class_AudioStreamPlayer3D_property_autoplay: .. _class_AudioStreamPlayer3D_property_autoplay:
- :ref:`bool<class_bool>` **autoplay** - :ref:`bool<class_bool>` **autoplay**
@@ -205,6 +217,8 @@ Decides if audio should get quieter with distance linearly, quadratically or log
If ``true``, audio plays when added to scene tree. Default value: ``false``. If ``true``, audio plays when added to scene tree. Default value: ``false``.
----
.. _class_AudioStreamPlayer3D_property_bus: .. _class_AudioStreamPlayer3D_property_bus:
- :ref:`String<class_String>` **bus** - :ref:`String<class_String>` **bus**
@@ -217,6 +231,8 @@ If ``true``, audio plays when added to scene tree. Default value: ``false``.
Bus on which this audio is playing. Bus on which this audio is playing.
----
.. _class_AudioStreamPlayer3D_property_doppler_tracking: .. _class_AudioStreamPlayer3D_property_doppler_tracking:
- :ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` **doppler_tracking** - :ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` **doppler_tracking**
@@ -229,6 +245,8 @@ Bus on which this audio is playing.
Decides in which step the Doppler effect should be calculated. Decides in which step the Doppler effect should be calculated.
----
.. _class_AudioStreamPlayer3D_property_emission_angle_degrees: .. _class_AudioStreamPlayer3D_property_emission_angle_degrees:
- :ref:`float<class_float>` **emission_angle_degrees** - :ref:`float<class_float>` **emission_angle_degrees**
@@ -241,6 +259,8 @@ Decides in which step the Doppler effect should be calculated.
The angle in which the audio reaches cameras undampened. The angle in which the audio reaches cameras undampened.
----
.. _class_AudioStreamPlayer3D_property_emission_angle_enabled: .. _class_AudioStreamPlayer3D_property_emission_angle_enabled:
- :ref:`bool<class_bool>` **emission_angle_enabled** - :ref:`bool<class_bool>` **emission_angle_enabled**
@@ -253,6 +273,8 @@ The angle in which the audio reaches cameras undampened.
If ``true``, the audio should be dampened according to the direction of the sound. If ``true``, the audio should be dampened according to the direction of the sound.
----
.. _class_AudioStreamPlayer3D_property_emission_angle_filter_attenuation_db: .. _class_AudioStreamPlayer3D_property_emission_angle_filter_attenuation_db:
- :ref:`float<class_float>` **emission_angle_filter_attenuation_db** - :ref:`float<class_float>` **emission_angle_filter_attenuation_db**
@@ -265,6 +287,8 @@ If ``true``, the audio should be dampened according to the direction of the soun
dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_angle_enabled' is set by this factor, in dB. dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_angle_enabled' is set by this factor, in dB.
----
.. _class_AudioStreamPlayer3D_property_max_db: .. _class_AudioStreamPlayer3D_property_max_db:
- :ref:`float<class_float>` **max_db** - :ref:`float<class_float>` **max_db**
@@ -277,6 +301,8 @@ dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_ang
Sets the absolute maximum of the soundlevel, in dB. Sets the absolute maximum of the soundlevel, in dB.
----
.. _class_AudioStreamPlayer3D_property_max_distance: .. _class_AudioStreamPlayer3D_property_max_distance:
- :ref:`float<class_float>` **max_distance** - :ref:`float<class_float>` **max_distance**
@@ -289,6 +315,8 @@ Sets the absolute maximum of the soundlevel, in dB.
Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect if set to 0. Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect if set to 0.
----
.. _class_AudioStreamPlayer3D_property_out_of_range_mode: .. _class_AudioStreamPlayer3D_property_out_of_range_mode:
- :ref:`OutOfRangeMode<enum_AudioStreamPlayer3D_OutOfRangeMode>` **out_of_range_mode** - :ref:`OutOfRangeMode<enum_AudioStreamPlayer3D_OutOfRangeMode>` **out_of_range_mode**
@@ -301,6 +329,8 @@ Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect
Decides if audio should pause when source is outside of 'max_distance' range. Decides if audio should pause when source is outside of 'max_distance' range.
----
.. _class_AudioStreamPlayer3D_property_pitch_scale: .. _class_AudioStreamPlayer3D_property_pitch_scale:
- :ref:`float<class_float>` **pitch_scale** - :ref:`float<class_float>` **pitch_scale**
@@ -313,6 +343,8 @@ Decides if audio should pause when source is outside of 'max_distance' range.
Changes the pitch and the tempo of the audio. Changes the pitch and the tempo of the audio.
----
.. _class_AudioStreamPlayer3D_property_playing: .. _class_AudioStreamPlayer3D_property_playing:
- :ref:`bool<class_bool>` **playing** - :ref:`bool<class_bool>` **playing**
@@ -323,6 +355,8 @@ Changes the pitch and the tempo of the audio.
If ``true``, audio is playing. If ``true``, audio is playing.
----
.. _class_AudioStreamPlayer3D_property_stream: .. _class_AudioStreamPlayer3D_property_stream:
- :ref:`AudioStream<class_AudioStream>` **stream** - :ref:`AudioStream<class_AudioStream>` **stream**
@@ -335,6 +369,8 @@ If ``true``, audio is playing.
The :ref:`AudioStream<class_AudioStream>` object to be played. The :ref:`AudioStream<class_AudioStream>` object to be played.
----
.. _class_AudioStreamPlayer3D_property_stream_paused: .. _class_AudioStreamPlayer3D_property_stream_paused:
- :ref:`bool<class_bool>` **stream_paused** - :ref:`bool<class_bool>` **stream_paused**
@@ -345,6 +381,8 @@ The :ref:`AudioStream<class_AudioStream>` object to be played.
| *Getter* | get_stream_paused() | | *Getter* | get_stream_paused() |
+----------+--------------------------+ +----------+--------------------------+
----
.. _class_AudioStreamPlayer3D_property_unit_db: .. _class_AudioStreamPlayer3D_property_unit_db:
- :ref:`float<class_float>` **unit_db** - :ref:`float<class_float>` **unit_db**
@@ -357,6 +395,8 @@ The :ref:`AudioStream<class_AudioStream>` object to be played.
Base sound level unaffected by dampening, in dB. Base sound level unaffected by dampening, in dB.
----
.. _class_AudioStreamPlayer3D_property_unit_size: .. _class_AudioStreamPlayer3D_property_unit_size:
- :ref:`float<class_float>` **unit_size** - :ref:`float<class_float>` **unit_size**
@@ -378,22 +418,30 @@ Method Descriptions
Returns the position in the :ref:`AudioStream<class_AudioStream>`. Returns the position in the :ref:`AudioStream<class_AudioStream>`.
----
.. _class_AudioStreamPlayer3D_method_get_stream_playback: .. _class_AudioStreamPlayer3D_method_get_stream_playback:
- :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` **get_stream_playback** **(** **)** - :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` **get_stream_playback** **(** **)**
----
.. _class_AudioStreamPlayer3D_method_play: .. _class_AudioStreamPlayer3D_method_play:
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)** - void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
Plays the audio from the given position 'from_position', in seconds. Plays the audio from the given position 'from_position', in seconds.
----
.. _class_AudioStreamPlayer3D_method_seek: .. _class_AudioStreamPlayer3D_method_seek:
- void **seek** **(** :ref:`float<class_float>` to_position **)** - void **seek** **(** :ref:`float<class_float>` to_position **)**
Sets the position from which audio will be played, in seconds. Sets the position from which audio will be played, in seconds.
----
.. _class_AudioStreamPlayer3D_method_stop: .. _class_AudioStreamPlayer3D_method_stop:
- void **stop** **(** **)** - void **stop** **(** **)**

2
classes/class_audiostreamrandompitch.rst
View File

@@ -47,6 +47,8 @@ Property Descriptions
The current :ref:`AudioStream<class_AudioStream>`. The current :ref:`AudioStream<class_AudioStream>`.
----
.. _class_AudioStreamRandomPitch_property_random_pitch: .. _class_AudioStreamRandomPitch_property_random_pitch:
- :ref:`float<class_float>` **random_pitch** - :ref:`float<class_float>` **random_pitch**

14
classes/class_audiostreamsample.rst
View File

@@ -63,6 +63,8 @@ enum **Format**:
- **FORMAT_IMA_ADPCM** = **2** --- Audio codec IMA ADPCM. - **FORMAT_IMA_ADPCM** = **2** --- Audio codec IMA ADPCM.
----
.. _enum_AudioStreamSample_LoopMode: .. _enum_AudioStreamSample_LoopMode:
.. _class_AudioStreamSample_constant_LOOP_DISABLED: .. _class_AudioStreamSample_constant_LOOP_DISABLED:
@@ -105,6 +107,8 @@ Property Descriptions
Contains the audio data in bytes. Contains the audio data in bytes.
----
.. _class_AudioStreamSample_property_format: .. _class_AudioStreamSample_property_format:
- :ref:`Format<enum_AudioStreamSample_Format>` **format** - :ref:`Format<enum_AudioStreamSample_Format>` **format**
@@ -117,6 +121,8 @@ Contains the audio data in bytes.
Audio format. See FORMAT\_\* constants for values. Audio format. See FORMAT\_\* constants for values.
----
.. _class_AudioStreamSample_property_loop_begin: .. _class_AudioStreamSample_property_loop_begin:
- :ref:`int<class_int>` **loop_begin** - :ref:`int<class_int>` **loop_begin**
@@ -129,6 +135,8 @@ Audio format. See FORMAT\_\* constants for values.
Loop start in bytes. Loop start in bytes.
----
.. _class_AudioStreamSample_property_loop_end: .. _class_AudioStreamSample_property_loop_end:
- :ref:`int<class_int>` **loop_end** - :ref:`int<class_int>` **loop_end**
@@ -141,6 +149,8 @@ Loop start in bytes.
Loop end in bytes. Loop end in bytes.
----
.. _class_AudioStreamSample_property_loop_mode: .. _class_AudioStreamSample_property_loop_mode:
- :ref:`LoopMode<enum_AudioStreamSample_LoopMode>` **loop_mode** - :ref:`LoopMode<enum_AudioStreamSample_LoopMode>` **loop_mode**
@@ -153,6 +163,8 @@ Loop end in bytes.
Loop mode. See LOOP\_\* constants for values. Loop mode. See LOOP\_\* constants for values.
----
.. _class_AudioStreamSample_property_mix_rate: .. _class_AudioStreamSample_property_mix_rate:
- :ref:`int<class_int>` **mix_rate** - :ref:`int<class_int>` **mix_rate**
@@ -165,6 +177,8 @@ Loop mode. See LOOP\_\* constants for values.
The sample rate for mixing this audio. The sample rate for mixing this audio.
----
.. _class_AudioStreamSample_property_stereo: .. _class_AudioStreamSample_property_stereo:
- :ref:`bool<class_bool>` **stereo** - :ref:`bool<class_bool>` **stereo**

2
classes/class_backbuffercopy.rst
View File

@@ -66,6 +66,8 @@ Property Descriptions
Buffer mode. See :ref:`CopyMode<enum_BackBufferCopy_CopyMode>` constants. Buffer mode. See :ref:`CopyMode<enum_BackBufferCopy_CopyMode>` constants.
----
.. _class_BackBufferCopy_property_rect: .. _class_BackBufferCopy_property_rect:
- :ref:`Rect2<class_Rect2>` **rect** - :ref:`Rect2<class_Rect2>` **rect**

24
classes/class_bakedlightmap.rst
View File

@@ -71,6 +71,8 @@ enum **BakeQuality**:
- **BAKE_QUALITY_HIGH** = **2** --- Highest bake quality mode. Takes longer to calculate. - **BAKE_QUALITY_HIGH** = **2** --- Highest bake quality mode. Takes longer to calculate.
----
.. _enum_BakedLightmap_BakeMode: .. _enum_BakedLightmap_BakeMode:
.. _class_BakedLightmap_constant_BAKE_MODE_CONE_TRACE: .. _class_BakedLightmap_constant_BAKE_MODE_CONE_TRACE:
@@ -83,6 +85,8 @@ enum **BakeMode**:
- **BAKE_MODE_RAY_TRACE** = **1** --- More precise bake mode but can take considerably longer to bake. - **BAKE_MODE_RAY_TRACE** = **1** --- More precise bake mode but can take considerably longer to bake.
----
.. _enum_BakedLightmap_BakeError: .. _enum_BakedLightmap_BakeError:
.. _class_BakedLightmap_constant_BAKE_ERROR_OK: .. _class_BakedLightmap_constant_BAKE_ERROR_OK:
@@ -132,6 +136,8 @@ Property Descriptions
Grid subdivision size for lightmapper calculation. Default value of ``0.25`` will work for most cases. Increase for better lighting on small details or if your scene is very large. Grid subdivision size for lightmapper calculation. Default value of ``0.25`` will work for most cases. Increase for better lighting on small details or if your scene is very large.
----
.. _class_BakedLightmap_property_bake_energy: .. _class_BakedLightmap_property_bake_energy:
- :ref:`float<class_float>` **bake_energy** - :ref:`float<class_float>` **bake_energy**
@@ -144,6 +150,8 @@ Grid subdivision size for lightmapper calculation. Default value of ``0.25`` wil
Multiplies the light sources' intensity by this value. For instance, if the value is set to 2, lights will be twice as bright. If the value is set to 0.5, lights will be half as bright. Multiplies the light sources' intensity by this value. For instance, if the value is set to 2, lights will be twice as bright. If the value is set to 0.5, lights will be half as bright.
----
.. _class_BakedLightmap_property_bake_extents: .. _class_BakedLightmap_property_bake_extents:
- :ref:`Vector3<class_Vector3>` **bake_extents** - :ref:`Vector3<class_Vector3>` **bake_extents**
@@ -154,6 +162,8 @@ Multiplies the light sources' intensity by this value. For instance, if the valu
| *Getter* | get_extents() | | *Getter* | get_extents() |
+----------+--------------------+ +----------+--------------------+
----
.. _class_BakedLightmap_property_bake_hdr: .. _class_BakedLightmap_property_bake_hdr:
- :ref:`bool<class_bool>` **bake_hdr** - :ref:`bool<class_bool>` **bake_hdr**
@@ -166,6 +176,8 @@ Multiplies the light sources' intensity by this value. For instance, if the valu
If ``true``, lightmap can capture light values greater than ``1.0``. Turning this off will result in a smaller lightmap. Default value:``false``. If ``true``, lightmap can capture light values greater than ``1.0``. Turning this off will result in a smaller lightmap. Default value:``false``.
----
.. _class_BakedLightmap_property_bake_mode: .. _class_BakedLightmap_property_bake_mode:
- :ref:`BakeMode<enum_BakedLightmap_BakeMode>` **bake_mode** - :ref:`BakeMode<enum_BakedLightmap_BakeMode>` **bake_mode**
@@ -178,6 +190,8 @@ If ``true``, lightmap can capture light values greater than ``1.0``. Turning thi
Lightmapping mode. See :ref:`BakeMode<enum_BakedLightmap_BakeMode>`. Lightmapping mode. See :ref:`BakeMode<enum_BakedLightmap_BakeMode>`.
----
.. _class_BakedLightmap_property_bake_propagation: .. _class_BakedLightmap_property_bake_propagation:
- :ref:`float<class_float>` **bake_propagation** - :ref:`float<class_float>` **bake_propagation**
@@ -190,6 +204,8 @@ Lightmapping mode. See :ref:`BakeMode<enum_BakedLightmap_BakeMode>`.
Defines how far the light will travel before it is no longer effective. The higher the number, the farther the light will travel. For instance, if the value is set to 2, the light will go twice as far. If the value is set to 0.5, the light will only go half as far. Defines how far the light will travel before it is no longer effective. The higher the number, the farther the light will travel. For instance, if the value is set to 2, the light will go twice as far. If the value is set to 0.5, the light will only go half as far.
----
.. _class_BakedLightmap_property_bake_quality: .. _class_BakedLightmap_property_bake_quality:
- :ref:`BakeQuality<enum_BakedLightmap_BakeQuality>` **bake_quality** - :ref:`BakeQuality<enum_BakedLightmap_BakeQuality>` **bake_quality**
@@ -202,6 +218,8 @@ Defines how far the light will travel before it is no longer effective. The high
Three quality modes are available. Higher quality requires more rendering time. See :ref:`BakeQuality<enum_BakedLightmap_BakeQuality>`. Three quality modes are available. Higher quality requires more rendering time. See :ref:`BakeQuality<enum_BakedLightmap_BakeQuality>`.
----
.. _class_BakedLightmap_property_capture_cell_size: .. _class_BakedLightmap_property_capture_cell_size:
- :ref:`float<class_float>` **capture_cell_size** - :ref:`float<class_float>` **capture_cell_size**
@@ -214,6 +232,8 @@ Three quality modes are available. Higher quality requires more rendering time.
Grid size used for real-time capture information on dynamic objects. Cannot be larger than :ref:`bake_cell_size<class_BakedLightmap_property_bake_cell_size>`. Grid size used for real-time capture information on dynamic objects. Cannot be larger than :ref:`bake_cell_size<class_BakedLightmap_property_bake_cell_size>`.
----
.. _class_BakedLightmap_property_image_path: .. _class_BakedLightmap_property_image_path:
- :ref:`String<class_String>` **image_path** - :ref:`String<class_String>` **image_path**
@@ -226,6 +246,8 @@ Grid size used for real-time capture information on dynamic objects. Cannot be l
Location where lightmaps will be saved. Location where lightmaps will be saved.
----
.. _class_BakedLightmap_property_light_data: .. _class_BakedLightmap_property_light_data:
- :ref:`BakedLightmapData<class_BakedLightmapData>` **light_data** - :ref:`BakedLightmapData<class_BakedLightmapData>` **light_data**
@@ -247,6 +269,8 @@ Method Descriptions
Bakes the lightmaps within the currently edited scene. Bakes the lightmaps within the currently edited scene.
----
.. _class_BakedLightmap_method_debug_bake: .. _class_BakedLightmap_method_debug_bake:
- void **debug_bake** **(** **)** - void **debug_bake** **(** **)**

16
classes/class_bakedlightmapdata.rst
View File

@@ -61,6 +61,8 @@ Property Descriptions
| *Getter* | get_bounds() | | *Getter* | get_bounds() |
+----------+-------------------+ +----------+-------------------+
----
.. _class_BakedLightmapData_property_cell_space_transform: .. _class_BakedLightmapData_property_cell_space_transform:
- :ref:`Transform<class_Transform>` **cell_space_transform** - :ref:`Transform<class_Transform>` **cell_space_transform**
@@ -71,6 +73,8 @@ Property Descriptions
| *Getter* | get_cell_space_transform() | | *Getter* | get_cell_space_transform() |
+----------+---------------------------------+ +----------+---------------------------------+
----
.. _class_BakedLightmapData_property_cell_subdiv: .. _class_BakedLightmapData_property_cell_subdiv:
- :ref:`int<class_int>` **cell_subdiv** - :ref:`int<class_int>` **cell_subdiv**
@@ -81,6 +85,8 @@ Property Descriptions
| *Getter* | get_cell_subdiv() | | *Getter* | get_cell_subdiv() |
+----------+------------------------+ +----------+------------------------+
----
.. _class_BakedLightmapData_property_energy: .. _class_BakedLightmapData_property_energy:
- :ref:`float<class_float>` **energy** - :ref:`float<class_float>` **energy**
@@ -91,6 +97,8 @@ Property Descriptions
| *Getter* | get_energy() | | *Getter* | get_energy() |
+----------+-------------------+ +----------+-------------------+
----
.. _class_BakedLightmapData_property_octree: .. _class_BakedLightmapData_property_octree:
- :ref:`PoolByteArray<class_PoolByteArray>` **octree** - :ref:`PoolByteArray<class_PoolByteArray>` **octree**
@@ -108,18 +116,26 @@ Method Descriptions
- void **add_user** **(** :ref:`NodePath<class_NodePath>` path, :ref:`Texture<class_Texture>` lightmap, :ref:`int<class_int>` instance **)** - void **add_user** **(** :ref:`NodePath<class_NodePath>` path, :ref:`Texture<class_Texture>` lightmap, :ref:`int<class_int>` instance **)**
----
.. _class_BakedLightmapData_method_clear_users: .. _class_BakedLightmapData_method_clear_users:
- void **clear_users** **(** **)** - void **clear_users** **(** **)**
----
.. _class_BakedLightmapData_method_get_user_count: .. _class_BakedLightmapData_method_get_user_count:
- :ref:`int<class_int>` **get_user_count** **(** **)** const - :ref:`int<class_int>` **get_user_count** **(** **)** const
----
.. _class_BakedLightmapData_method_get_user_lightmap: .. _class_BakedLightmapData_method_get_user_lightmap:
- :ref:`Texture<class_Texture>` **get_user_lightmap** **(** :ref:`int<class_int>` user_idx **)** const - :ref:`Texture<class_Texture>` **get_user_lightmap** **(** :ref:`int<class_int>` user_idx **)** const
----
.. _class_BakedLightmapData_method_get_user_path: .. _class_BakedLightmapData_method_get_user_path:
- :ref:`NodePath<class_NodePath>` **get_user_path** **(** :ref:`int<class_int>` user_idx **)** const - :ref:`NodePath<class_NodePath>` **get_user_path** **(** :ref:`int<class_int>` user_idx **)** const

30
classes/class_basebutton.rst
View File

@@ -65,18 +65,24 @@ Signals
Emitted when the button starts being held down. Emitted when the button starts being held down.
----
.. _class_BaseButton_signal_button_up: .. _class_BaseButton_signal_button_up:
- **button_up** **(** **)** - **button_up** **(** **)**
Emitted when the button stops being held down. Emitted when the button stops being held down.
----
.. _class_BaseButton_signal_pressed: .. _class_BaseButton_signal_pressed:
- **pressed** **(** **)** - **pressed** **(** **)**
This signal is emitted every time the button is toggled or pressed (i.e. activated, so on ``button_down`` if "Click on press" is active and on ``button_up`` otherwise). This signal is emitted every time the button is toggled or pressed (i.e. activated, so on ``button_down`` if "Click on press" is active and on ``button_up`` otherwise).
----
.. _class_BaseButton_signal_toggled: .. _class_BaseButton_signal_toggled:
- **toggled** **(** :ref:`bool<class_bool>` button_pressed **)** - **toggled** **(** :ref:`bool<class_bool>` button_pressed **)**
@@ -110,6 +116,8 @@ enum **DrawMode**:
- **DRAW_HOVER_PRESSED** = **4** - **DRAW_HOVER_PRESSED** = **4**
----
.. _enum_BaseButton_ActionMode: .. _enum_BaseButton_ActionMode:
.. _class_BaseButton_constant_ACTION_MODE_BUTTON_PRESS: .. _class_BaseButton_constant_ACTION_MODE_BUTTON_PRESS:
@@ -142,6 +150,8 @@ Property Descriptions
Determines when the button is considered clicked, one of the ACTION_MODE\_\* constants. Determines when the button is considered clicked, one of the ACTION_MODE\_\* constants.
----
.. _class_BaseButton_property_button_mask: .. _class_BaseButton_property_button_mask:
- :ref:`int<class_int>` **button_mask** - :ref:`int<class_int>` **button_mask**
@@ -156,6 +166,8 @@ Binary mask to choose which mouse buttons this button will respond to.
To allow both left-click and right-click, set this to 3, because it's BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT. To allow both left-click and right-click, set this to 3, because it's BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT.
----
.. _class_BaseButton_property_disabled: .. _class_BaseButton_property_disabled:
- :ref:`bool<class_bool>` **disabled** - :ref:`bool<class_bool>` **disabled**
@@ -168,6 +180,8 @@ To allow both left-click and right-click, set this to 3, because it's BUTTON_MAS
If ``true``, the button is in disabled state and can't be clicked or toggled. If ``true``, the button is in disabled state and can't be clicked or toggled.
----
.. _class_BaseButton_property_enabled_focus_mode: .. _class_BaseButton_property_enabled_focus_mode:
- :ref:`FocusMode<enum_Control_FocusMode>` **enabled_focus_mode** - :ref:`FocusMode<enum_Control_FocusMode>` **enabled_focus_mode**
@@ -180,6 +194,8 @@ If ``true``, the button is in disabled state and can't be clicked or toggled.
Focus access mode to use when switching between enabled/disabled (see :ref:`Control.focus_mode<class_Control_property_focus_mode>` and :ref:`disabled<class_BaseButton_property_disabled>`). Focus access mode to use when switching between enabled/disabled (see :ref:`Control.focus_mode<class_Control_property_focus_mode>` and :ref:`disabled<class_BaseButton_property_disabled>`).
----
.. _class_BaseButton_property_group: .. _class_BaseButton_property_group:
- :ref:`ButtonGroup<class_ButtonGroup>` **group** - :ref:`ButtonGroup<class_ButtonGroup>` **group**
@@ -192,6 +208,8 @@ Focus access mode to use when switching between enabled/disabled (see :ref:`Cont
:ref:`ButtonGroup<class_ButtonGroup>` associated to the button. :ref:`ButtonGroup<class_ButtonGroup>` associated to the button.
----
.. _class_BaseButton_property_pressed: .. _class_BaseButton_property_pressed:
- :ref:`bool<class_bool>` **pressed** - :ref:`bool<class_bool>` **pressed**
@@ -204,6 +222,8 @@ Focus access mode to use when switching between enabled/disabled (see :ref:`Cont
If ``true``, the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active). If ``true``, the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active).
----
.. _class_BaseButton_property_shortcut: .. _class_BaseButton_property_shortcut:
- :ref:`ShortCut<class_ShortCut>` **shortcut** - :ref:`ShortCut<class_ShortCut>` **shortcut**
@@ -216,6 +236,8 @@ If ``true``, the button's state is pressed. Means the button is pressed down or
:ref:`ShortCut<class_ShortCut>` associated to the button. :ref:`ShortCut<class_ShortCut>` associated to the button.
----
.. _class_BaseButton_property_shortcut_in_tooltip: .. _class_BaseButton_property_shortcut_in_tooltip:
- :ref:`bool<class_bool>` **shortcut_in_tooltip** - :ref:`bool<class_bool>` **shortcut_in_tooltip**
@@ -228,6 +250,8 @@ If ``true``, the button's state is pressed. Means the button is pressed down or
If ``true``, the button will add information about its shortcut in the tooltip. If ``true``, the button will add information about its shortcut in the tooltip.
----
.. _class_BaseButton_property_toggle_mode: .. _class_BaseButton_property_toggle_mode:
- :ref:`bool<class_bool>` **toggle_mode** - :ref:`bool<class_bool>` **toggle_mode**
@@ -249,18 +273,24 @@ Method Descriptions
Called when the button is pressed. Called when the button is pressed.
----
.. _class_BaseButton_method__toggled: .. _class_BaseButton_method__toggled:
- void **_toggled** **(** :ref:`bool<class_bool>` button_pressed **)** virtual - void **_toggled** **(** :ref:`bool<class_bool>` button_pressed **)** virtual
Called when the button is toggled (only if toggle_mode is active). Called when the button is toggled (only if toggle_mode is active).
----
.. _class_BaseButton_method_get_draw_mode: .. _class_BaseButton_method_get_draw_mode:
- :ref:`DrawMode<enum_BaseButton_DrawMode>` **get_draw_mode** **(** **)** const - :ref:`DrawMode<enum_BaseButton_DrawMode>` **get_draw_mode** **(** **)** const
Returns the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW\_\* enum. Returns the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW\_\* enum.
----
.. _class_BaseButton_method_is_hovered: .. _class_BaseButton_method_is_hovered:
- :ref:`bool<class_bool>` **is_hovered** **(** **)** const - :ref:`bool<class_bool>` **is_hovered** **(** **)** const

44
classes/class_basis.rst
View File

@@ -95,12 +95,16 @@ Property Descriptions
The basis matrix's x vector. The basis matrix's x vector.
----
.. _class_Basis_property_y: .. _class_Basis_property_y:
- :ref:`Vector3<class_Vector3>` **y** - :ref:`Vector3<class_Vector3>` **y**
The basis matrix's y vector. The basis matrix's y vector.
----
.. _class_Basis_property_z: .. _class_Basis_property_z:
- :ref:`Vector3<class_Vector3>` **z** - :ref:`Vector3<class_Vector3>` **z**
@@ -116,110 +120,150 @@ Method Descriptions
Create a rotation matrix from the given quaternion. Create a rotation matrix from the given quaternion.
----
- :ref:`Basis<class_Basis>` **Basis** **(** :ref:`Vector3<class_Vector3>` from **)** - :ref:`Basis<class_Basis>` **Basis** **(** :ref:`Vector3<class_Vector3>` from **)**
Create a rotation matrix (in the YXZ convention: first Z, then X, and Y last) from the specified Euler angles, given in the vector format as (X-angle, Y-angle, Z-angle). Create a rotation matrix (in the YXZ convention: first Z, then X, and Y last) from the specified Euler angles, given in the vector format as (X-angle, Y-angle, Z-angle).
----
- :ref:`Basis<class_Basis>` **Basis** **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` phi **)** - :ref:`Basis<class_Basis>` **Basis** **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` phi **)**
Create a rotation matrix which rotates around the given axis by the specified angle, in radians. The axis must be a normalized vector. Create a rotation matrix which rotates around the given axis by the specified angle, in radians. The axis must be a normalized vector.
----
- :ref:`Basis<class_Basis>` **Basis** **(** :ref:`Vector3<class_Vector3>` x_axis, :ref:`Vector3<class_Vector3>` y_axis, :ref:`Vector3<class_Vector3>` z_axis **)** - :ref:`Basis<class_Basis>` **Basis** **(** :ref:`Vector3<class_Vector3>` x_axis, :ref:`Vector3<class_Vector3>` y_axis, :ref:`Vector3<class_Vector3>` z_axis **)**
Create a matrix from 3 axis vectors. Create a matrix from 3 axis vectors.
----
.. _class_Basis_method_determinant: .. _class_Basis_method_determinant:
- :ref:`float<class_float>` **determinant** **(** **)** - :ref:`float<class_float>` **determinant** **(** **)**
Returns the determinant of the matrix. Returns the determinant of the matrix.
----
.. _class_Basis_method_get_euler: .. _class_Basis_method_get_euler:
- :ref:`Vector3<class_Vector3>` **get_euler** **(** **)** - :ref:`Vector3<class_Vector3>` **get_euler** **(** **)**
Assuming that the matrix is a proper rotation matrix (orthonormal matrix with determinant +1), return Euler angles (in the YXZ convention: first Z, then X, and Y last). Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle). Assuming that the matrix is a proper rotation matrix (orthonormal matrix with determinant +1), return Euler angles (in the YXZ convention: first Z, then X, and Y last). Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle).
----
.. _class_Basis_method_get_orthogonal_index: .. _class_Basis_method_get_orthogonal_index:
- :ref:`int<class_int>` **get_orthogonal_index** **(** **)** - :ref:`int<class_int>` **get_orthogonal_index** **(** **)**
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. 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_method_get_rotation_quat: .. _class_Basis_method_get_rotation_quat:
- :ref:`Quat<class_Quat>` **get_rotation_quat** **(** **)** - :ref:`Quat<class_Quat>` **get_rotation_quat** **(** **)**
----
.. _class_Basis_method_get_scale: .. _class_Basis_method_get_scale:
- :ref:`Vector3<class_Vector3>` **get_scale** **(** **)** - :ref:`Vector3<class_Vector3>` **get_scale** **(** **)**
Assuming that the matrix is the combination of a rotation and scaling, return the absolute value of scaling factors along each axis. Assuming that the matrix is the combination of a rotation and scaling, return the absolute value of scaling factors along each axis.
----
.. _class_Basis_method_inverse: .. _class_Basis_method_inverse:
- :ref:`Basis<class_Basis>` **inverse** **(** **)** - :ref:`Basis<class_Basis>` **inverse** **(** **)**
Returns the inverse of the matrix. Returns the inverse of the matrix.
----
.. _class_Basis_method_is_equal_approx: .. _class_Basis_method_is_equal_approx:
- :ref:`bool<class_bool>` **is_equal_approx** **(** :ref:`Basis<class_Basis>` b, :ref:`float<class_float>` epsilon=0.00001 **)** - :ref:`bool<class_bool>` **is_equal_approx** **(** :ref:`Basis<class_Basis>` b, :ref:`float<class_float>` epsilon=0.00001 **)**
----
.. _class_Basis_method_orthonormalized: .. _class_Basis_method_orthonormalized:
- :ref:`Basis<class_Basis>` **orthonormalized** **(** **)** - :ref:`Basis<class_Basis>` **orthonormalized** **(** **)**
Returns 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. Returns 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_Basis_method_rotated: .. _class_Basis_method_rotated:
- :ref:`Basis<class_Basis>` **rotated** **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` phi **)** - :ref:`Basis<class_Basis>` **rotated** **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` phi **)**
Introduce an additional rotation around the given axis by phi (radians). The axis must be a normalized vector. Introduce an additional rotation around the given axis by phi (radians). The axis must be a normalized vector.
----
.. _class_Basis_method_scaled: .. _class_Basis_method_scaled:
- :ref:`Basis<class_Basis>` **scaled** **(** :ref:`Vector3<class_Vector3>` scale **)** - :ref:`Basis<class_Basis>` **scaled** **(** :ref:`Vector3<class_Vector3>` scale **)**
Introduce an additional scaling specified by the given 3D scaling factor. Introduce an additional scaling specified by the given 3D scaling factor.
----
.. _class_Basis_method_slerp: .. _class_Basis_method_slerp:
- :ref:`Basis<class_Basis>` **slerp** **(** :ref:`Basis<class_Basis>` b, :ref:`float<class_float>` t **)** - :ref:`Basis<class_Basis>` **slerp** **(** :ref:`Basis<class_Basis>` b, :ref:`float<class_float>` t **)**
Assuming that the matrix is a proper rotation matrix, slerp performs a spherical-linear interpolation with another rotation matrix. Assuming that the matrix is a proper rotation matrix, slerp performs a spherical-linear interpolation with another rotation matrix.
----
.. _class_Basis_method_tdotx: .. _class_Basis_method_tdotx:
- :ref:`float<class_float>` **tdotx** **(** :ref:`Vector3<class_Vector3>` with **)** - :ref:`float<class_float>` **tdotx** **(** :ref:`Vector3<class_Vector3>` with **)**
Transposed dot product with the x axis of the matrix. Transposed dot product with the x axis of the matrix.
----
.. _class_Basis_method_tdoty: .. _class_Basis_method_tdoty:
- :ref:`float<class_float>` **tdoty** **(** :ref:`Vector3<class_Vector3>` with **)** - :ref:`float<class_float>` **tdoty** **(** :ref:`Vector3<class_Vector3>` with **)**
Transposed dot product with the y axis of the matrix. Transposed dot product with the y axis of the matrix.
----
.. _class_Basis_method_tdotz: .. _class_Basis_method_tdotz:
- :ref:`float<class_float>` **tdotz** **(** :ref:`Vector3<class_Vector3>` with **)** - :ref:`float<class_float>` **tdotz** **(** :ref:`Vector3<class_Vector3>` with **)**
Transposed dot product with the z axis of the matrix. Transposed dot product with the z axis of the matrix.
----
.. _class_Basis_method_transposed: .. _class_Basis_method_transposed:
- :ref:`Basis<class_Basis>` **transposed** **(** **)** - :ref:`Basis<class_Basis>` **transposed** **(** **)**
Returns the transposed version of the matrix. Returns the transposed version of the matrix.
----
.. _class_Basis_method_xform: .. _class_Basis_method_xform:
- :ref:`Vector3<class_Vector3>` **xform** **(** :ref:`Vector3<class_Vector3>` v **)** - :ref:`Vector3<class_Vector3>` **xform** **(** :ref:`Vector3<class_Vector3>` v **)**
Returns a vector transformed (multiplied) by the matrix. Returns a vector transformed (multiplied) by the matrix.
----
.. _class_Basis_method_xform_inv: .. _class_Basis_method_xform_inv:
- :ref:`Vector3<class_Vector3>` **xform_inv** **(** :ref:`Vector3<class_Vector3>` v **)** - :ref:`Vector3<class_Vector3>` **xform_inv** **(** :ref:`Vector3<class_Vector3>` v **)**

16
classes/class_bitmap.rst
View File

@@ -55,44 +55,60 @@ Method Descriptions
Creates a bitmap with the specified size, filled with ``false``. Creates a bitmap with the specified size, filled with ``false``.
----
.. _class_BitMap_method_create_from_image_alpha: .. _class_BitMap_method_create_from_image_alpha:
- void **create_from_image_alpha** **(** :ref:`Image<class_Image>` image, :ref:`float<class_float>` threshold=0.1 **)** - void **create_from_image_alpha** **(** :ref:`Image<class_Image>` image, :ref:`float<class_float>` threshold=0.1 **)**
Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to ``false`` if the alpha value of the image at that position is equal to ``threshold`` or less, and ``true`` in other case. Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to ``false`` if the alpha value of the image at that position is equal to ``threshold`` or less, and ``true`` in other case.
----
.. _class_BitMap_method_get_bit: .. _class_BitMap_method_get_bit:
- :ref:`bool<class_bool>` **get_bit** **(** :ref:`Vector2<class_Vector2>` position **)** const - :ref:`bool<class_bool>` **get_bit** **(** :ref:`Vector2<class_Vector2>` position **)** const
Returns bitmap's value at the specified position. Returns bitmap's value at the specified position.
----
.. _class_BitMap_method_get_size: .. _class_BitMap_method_get_size:
- :ref:`Vector2<class_Vector2>` **get_size** **(** **)** const - :ref:`Vector2<class_Vector2>` **get_size** **(** **)** const
Returns bitmap's dimensions. Returns bitmap's dimensions.
----
.. _class_BitMap_method_get_true_bit_count: .. _class_BitMap_method_get_true_bit_count:
- :ref:`int<class_int>` **get_true_bit_count** **(** **)** const - :ref:`int<class_int>` **get_true_bit_count** **(** **)** const
Returns the amount of bitmap elements that are set to ``true``. Returns the amount of bitmap elements that are set to ``true``.
----
.. _class_BitMap_method_grow_mask: .. _class_BitMap_method_grow_mask:
- void **grow_mask** **(** :ref:`int<class_int>` pixels, :ref:`Rect2<class_Rect2>` rect **)** - void **grow_mask** **(** :ref:`int<class_int>` pixels, :ref:`Rect2<class_Rect2>` rect **)**
----
.. _class_BitMap_method_opaque_to_polygons: .. _class_BitMap_method_opaque_to_polygons:
- :ref:`Array<class_Array>` **opaque_to_polygons** **(** :ref:`Rect2<class_Rect2>` rect, :ref:`float<class_float>` epsilon=2.0 **)** const - :ref:`Array<class_Array>` **opaque_to_polygons** **(** :ref:`Rect2<class_Rect2>` rect, :ref:`float<class_float>` epsilon=2.0 **)** const
----
.. _class_BitMap_method_set_bit: .. _class_BitMap_method_set_bit:
- void **set_bit** **(** :ref:`Vector2<class_Vector2>` position, :ref:`bool<class_bool>` bit **)** - void **set_bit** **(** :ref:`Vector2<class_Vector2>` position, :ref:`bool<class_bool>` bit **)**
Sets the bitmap's element at the specified position, to the specified value. Sets the bitmap's element at the specified position, to the specified value.
----
.. _class_BitMap_method_set_bit_rect: .. _class_BitMap_method_set_bit_rect:
- void **set_bit_rect** **(** :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` bit **)** - void **set_bit_rect** **(** :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` bit **)**

22
classes/class_bitmapfont.rst
View File

@@ -74,6 +74,8 @@ Property Descriptions
Ascent (number of pixels above the baseline). Ascent (number of pixels above the baseline).
----
.. _class_BitmapFont_property_distance_field: .. _class_BitmapFont_property_distance_field:
- :ref:`bool<class_bool>` **distance_field** - :ref:`bool<class_bool>` **distance_field**
@@ -86,6 +88,8 @@ Ascent (number of pixels above the baseline).
If ``true``, distance field hint is enabled. If ``true``, distance field hint is enabled.
----
.. _class_BitmapFont_property_fallback: .. _class_BitmapFont_property_fallback:
- :ref:`BitmapFont<class_BitmapFont>` **fallback** - :ref:`BitmapFont<class_BitmapFont>` **fallback**
@@ -98,6 +102,8 @@ If ``true``, distance field hint is enabled.
The fallback font. The fallback font.
----
.. _class_BitmapFont_property_height: .. _class_BitmapFont_property_height:
- :ref:`float<class_float>` **height** - :ref:`float<class_float>` **height**
@@ -119,48 +125,64 @@ Method Descriptions
Adds a character to the font, where ``character`` is the unicode value, ``texture`` is the texture index, ``rect`` is the region in the texture (in pixels!), ``align`` is the (optional) alignment for the character and ``advance`` is the (optional) advance. Adds a character to the font, where ``character`` is the unicode value, ``texture`` is the texture index, ``rect`` is the region in the texture (in pixels!), ``align`` is the (optional) alignment for the character and ``advance`` is the (optional) advance.
----
.. _class_BitmapFont_method_add_kerning_pair: .. _class_BitmapFont_method_add_kerning_pair:
- void **add_kerning_pair** **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b, :ref:`int<class_int>` kerning **)** - void **add_kerning_pair** **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b, :ref:`int<class_int>` kerning **)**
Adds a kerning pair to the ``BitmapFont`` as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. Adds a kerning pair to the ``BitmapFont`` as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character.
----
.. _class_BitmapFont_method_add_texture: .. _class_BitmapFont_method_add_texture:
- void **add_texture** **(** :ref:`Texture<class_Texture>` texture **)** - void **add_texture** **(** :ref:`Texture<class_Texture>` texture **)**
Adds a texture to the ``BitmapFont``. Adds a texture to the ``BitmapFont``.
----
.. _class_BitmapFont_method_clear: .. _class_BitmapFont_method_clear:
- void **clear** **(** **)** - void **clear** **(** **)**
Clears all the font data and settings. Clears all the font data and settings.
----
.. _class_BitmapFont_method_create_from_fnt: .. _class_BitmapFont_method_create_from_fnt:
- :ref:`Error<enum_@GlobalScope_Error>` **create_from_fnt** **(** :ref:`String<class_String>` path **)** - :ref:`Error<enum_@GlobalScope_Error>` **create_from_fnt** **(** :ref:`String<class_String>` path **)**
Creates a BitmapFont from the ``*.fnt`` file at ``path``. Creates a BitmapFont from the ``*.fnt`` file at ``path``.
----
.. _class_BitmapFont_method_get_char_size: .. _class_BitmapFont_method_get_char_size:
- :ref:`Vector2<class_Vector2>` **get_char_size** **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const - :ref:`Vector2<class_Vector2>` **get_char_size** **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const
Returns the size of a character, optionally taking kerning into account if the next character is provided. Returns the size of a character, optionally taking kerning into account if the next character is provided.
----
.. _class_BitmapFont_method_get_kerning_pair: .. _class_BitmapFont_method_get_kerning_pair:
- :ref:`int<class_int>` **get_kerning_pair** **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const - :ref:`int<class_int>` **get_kerning_pair** **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const
Returns a kerning pair as a difference. Returns a kerning pair as a difference.
----
.. _class_BitmapFont_method_get_texture: .. _class_BitmapFont_method_get_texture:
- :ref:`Texture<class_Texture>` **get_texture** **(** :ref:`int<class_int>` idx **)** const - :ref:`Texture<class_Texture>` **get_texture** **(** :ref:`int<class_int>` idx **)** const
Returns the font atlas texture at index ``idx``. Returns the font atlas texture at index ``idx``.
----
.. _class_BitmapFont_method_get_texture_count: .. _class_BitmapFont_method_get_texture_count:
- :ref:`int<class_int>` **get_texture_count** **(** **)** const - :ref:`int<class_int>` **get_texture_count** **(** **)** const

6
classes/class_bone2d.rst
View File

@@ -64,6 +64,8 @@ Property Descriptions
Length of the bone's representation drawn in the editor's viewport in pixels. Length of the bone's representation drawn in the editor's viewport in pixels.
----
.. _class_Bone2D_property_rest: .. _class_Bone2D_property_rest:
- :ref:`Transform2D<class_Transform2D>` **rest** - :ref:`Transform2D<class_Transform2D>` **rest**
@@ -85,12 +87,16 @@ Method Descriptions
Stores the node's current transforms in :ref:`rest<class_Bone2D_property_rest>`. Stores the node's current transforms in :ref:`rest<class_Bone2D_property_rest>`.
----
.. _class_Bone2D_method_get_index_in_skeleton: .. _class_Bone2D_method_get_index_in_skeleton:
- :ref:`int<class_int>` **get_index_in_skeleton** **(** **)** const - :ref:`int<class_int>` **get_index_in_skeleton** **(** **)** const
Returns the node's index as part of the entire skeleton. See :ref:`Skeleton2D<class_Skeleton2D>`. Returns the node's index as part of the entire skeleton. See :ref:`Skeleton2D<class_Skeleton2D>`.
----
.. _class_Bone2D_method_get_skeleton_rest: .. _class_Bone2D_method_get_skeleton_rest:
- :ref:`Transform2D<class_Transform2D>` **get_skeleton_rest** **(** **)** const - :ref:`Transform2D<class_Transform2D>` **get_skeleton_rest** **(** **)** const

4
classes/class_bool.rst
View File

@@ -41,10 +41,14 @@ Method Descriptions
Cast an :ref:`int<class_int>` value to a boolean value, this method will return ``true`` if called with an integer value different to 0 and ``false`` in other case. Cast an :ref:`int<class_int>` value to a boolean value, this method will return ``true`` if called with an integer value different to 0 and ``false`` in other case.
----
- :ref:`bool<class_bool>` **bool** **(** :ref:`float<class_float>` from **)** - :ref:`bool<class_bool>` **bool** **(** :ref:`float<class_float>` from **)**
Cast a :ref:`float<class_float>` value to a boolean value, this method will return ``true`` if called with a floating point value different to 0 and ``false`` in other case. Cast a :ref:`float<class_float>` value to a boolean value, this method will return ``true`` if called with a floating point value different to 0 and ``false`` in other case.
----
- :ref:`bool<class_bool>` **bool** **(** :ref:`String<class_String>` from **)** - :ref:`bool<class_bool>` **bool** **(** :ref:`String<class_String>` from **)**
Cast a :ref:`String<class_String>` value to a boolean value, this method will return ``true`` if called with a non empty string and ``false`` in other case. Examples: ``bool('False')`` returns ``true``, ``bool('')`` returns ``false``. Cast a :ref:`String<class_String>` value to a boolean value, this method will return ``true`` if called with a non empty string and ``false`` in other case. Examples: ``bool('False')`` returns ``true``, ``bool('')`` returns ``false``.

8
classes/class_button.rst
View File

@@ -101,6 +101,8 @@ Property Descriptions
Text alignment policy for the button's text, use one of the ALIGN\_\* constants. Text alignment policy for the button's text, use one of the ALIGN\_\* constants.
----
.. _class_Button_property_clip_text: .. _class_Button_property_clip_text:
- :ref:`bool<class_bool>` **clip_text** - :ref:`bool<class_bool>` **clip_text**
@@ -113,6 +115,8 @@ Text alignment policy for the button's text, use one of the ALIGN\_\* constants.
When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default. When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default.
----
.. _class_Button_property_flat: .. _class_Button_property_flat:
- :ref:`bool<class_bool>` **flat** - :ref:`bool<class_bool>` **flat**
@@ -125,6 +129,8 @@ When this property is enabled, text that is too large to fit the button is clipp
Flat buttons don't display decoration. Flat buttons don't display decoration.
----
.. _class_Button_property_icon: .. _class_Button_property_icon:
- :ref:`Texture<class_Texture>` **icon** - :ref:`Texture<class_Texture>` **icon**
@@ -137,6 +143,8 @@ Flat buttons don't display decoration.
Button's icon, if text is present the icon will be placed before the text. Button's icon, if text is present the icon will be placed before the text.
----
.. _class_Button_property_text: .. _class_Button_property_text:
- :ref:`String<class_String>` **text** - :ref:`String<class_String>` **text**

2
classes/class_buttongroup.rst
View File

@@ -43,6 +43,8 @@ Method Descriptions
Returns an :ref:`Array<class_Array>` of :ref:`Button<class_Button>`\ s who have this as their ``ButtonGroup`` (see :ref:`BaseButton.group<class_BaseButton_property_group>`). Returns an :ref:`Array<class_Array>` of :ref:`Button<class_Button>`\ s who have this as their ``ButtonGroup`` (see :ref:`BaseButton.group<class_BaseButton_property_group>`).
----
.. _class_ButtonGroup_method_get_pressed_button: .. _class_ButtonGroup_method_get_pressed_button:
- :ref:`BaseButton<class_BaseButton>` **get_pressed_button** **(** **)** - :ref:`BaseButton<class_BaseButton>` **get_pressed_button** **(** **)**

52
classes/class_camera.rst
View File

@@ -97,6 +97,8 @@ enum **Projection**:
- **PROJECTION_ORTHOGONAL** = **1** --- Orthogonal Projection (objects remain the same size on the screen no matter how far away they are; also known as orthographic projection). - **PROJECTION_ORTHOGONAL** = **1** --- Orthogonal Projection (objects remain the same size on the screen no matter how far away they are; also known as orthographic projection).
----
.. _enum_Camera_KeepAspect: .. _enum_Camera_KeepAspect:
.. _class_Camera_constant_KEEP_WIDTH: .. _class_Camera_constant_KEEP_WIDTH:
@@ -109,6 +111,8 @@ enum **KeepAspect**:
- **KEEP_HEIGHT** = **1** --- Preserves the vertical aspect ratio. - **KEEP_HEIGHT** = **1** --- Preserves the vertical aspect ratio.
----
.. _enum_Camera_DopplerTracking: .. _enum_Camera_DopplerTracking:
.. _class_Camera_constant_DOPPLER_TRACKING_DISABLED: .. _class_Camera_constant_DOPPLER_TRACKING_DISABLED:
@@ -145,6 +149,8 @@ Property Descriptions
The culling mask that describes which 3D render layers are rendered by this camera. The culling mask that describes which 3D render layers are rendered by this camera.
----
.. _class_Camera_property_current: .. _class_Camera_property_current:
- :ref:`bool<class_bool>` **current** - :ref:`bool<class_bool>` **current**
@@ -157,6 +163,8 @@ The culling mask that describes which 3D render layers are rendered by this came
If ``true``, the ancestor :ref:`Viewport<class_Viewport>` is currently using this Camera. Default value: ``false``. If ``true``, the ancestor :ref:`Viewport<class_Viewport>` is currently using this Camera. Default value: ``false``.
----
.. _class_Camera_property_doppler_tracking: .. _class_Camera_property_doppler_tracking:
- :ref:`DopplerTracking<enum_Camera_DopplerTracking>` **doppler_tracking** - :ref:`DopplerTracking<enum_Camera_DopplerTracking>` **doppler_tracking**
@@ -169,6 +177,8 @@ If ``true``, the ancestor :ref:`Viewport<class_Viewport>` is currently using thi
If not :ref:`DOPPLER_TRACKING_DISABLED<class_Camera_constant_DOPPLER_TRACKING_DISABLED>` this Camera will simulate the Doppler effect for objects changed in particular ``_process`` methods. Default value: :ref:`DOPPLER_TRACKING_DISABLED<class_Camera_constant_DOPPLER_TRACKING_DISABLED>`. If not :ref:`DOPPLER_TRACKING_DISABLED<class_Camera_constant_DOPPLER_TRACKING_DISABLED>` this Camera will simulate the Doppler effect for objects changed in particular ``_process`` methods. Default value: :ref:`DOPPLER_TRACKING_DISABLED<class_Camera_constant_DOPPLER_TRACKING_DISABLED>`.
----
.. _class_Camera_property_environment: .. _class_Camera_property_environment:
- :ref:`Environment<class_Environment>` **environment** - :ref:`Environment<class_Environment>` **environment**
@@ -181,6 +191,8 @@ If not :ref:`DOPPLER_TRACKING_DISABLED<class_Camera_constant_DOPPLER_TRACKING_DI
The :ref:`Environment<class_Environment>` to use for this Camera. The :ref:`Environment<class_Environment>` to use for this Camera.
----
.. _class_Camera_property_far: .. _class_Camera_property_far:
- :ref:`float<class_float>` **far** - :ref:`float<class_float>` **far**
@@ -193,6 +205,8 @@ The :ref:`Environment<class_Environment>` to use for this Camera.
The distance to the far culling boundary for this Camera relative to its local z-axis. The distance to the far culling boundary for this Camera relative to its local z-axis.
----
.. _class_Camera_property_fov: .. _class_Camera_property_fov:
- :ref:`float<class_float>` **fov** - :ref:`float<class_float>` **fov**
@@ -205,6 +219,8 @@ The distance to the far culling boundary for this Camera relative to its local z
The camera's field of view angle (in degrees). Only applicable in perspective mode. Since :ref:`keep_aspect<class_Camera_property_keep_aspect>` locks one axis, ``fov`` sets the other axis' field of view angle. The camera's field of view angle (in degrees). Only applicable in perspective mode. Since :ref:`keep_aspect<class_Camera_property_keep_aspect>` locks one axis, ``fov`` sets the other axis' field of view angle.
----
.. _class_Camera_property_h_offset: .. _class_Camera_property_h_offset:
- :ref:`float<class_float>` **h_offset** - :ref:`float<class_float>` **h_offset**
@@ -217,6 +233,8 @@ The camera's field of view angle (in degrees). Only applicable in perspective mo
The horizontal (X) offset of the Camera viewport. The horizontal (X) offset of the Camera viewport.
----
.. _class_Camera_property_keep_aspect: .. _class_Camera_property_keep_aspect:
- :ref:`KeepAspect<enum_Camera_KeepAspect>` **keep_aspect** - :ref:`KeepAspect<enum_Camera_KeepAspect>` **keep_aspect**
@@ -229,6 +247,8 @@ The horizontal (X) offset of the Camera viewport.
The axis to lock during :ref:`fov<class_Camera_property_fov>`/:ref:`size<class_Camera_property_size>` adjustments. Can be either :ref:`KEEP_WIDTH<class_Camera_constant_KEEP_WIDTH>` or :ref:`KEEP_HEIGHT<class_Camera_constant_KEEP_HEIGHT>`. The axis to lock during :ref:`fov<class_Camera_property_fov>`/:ref:`size<class_Camera_property_size>` adjustments. Can be either :ref:`KEEP_WIDTH<class_Camera_constant_KEEP_WIDTH>` or :ref:`KEEP_HEIGHT<class_Camera_constant_KEEP_HEIGHT>`.
----
.. _class_Camera_property_near: .. _class_Camera_property_near:
- :ref:`float<class_float>` **near** - :ref:`float<class_float>` **near**
@@ -241,6 +261,8 @@ The axis to lock during :ref:`fov<class_Camera_property_fov>`/:ref:`size<class_C
The distance to the near culling boundary for this Camera relative to its local z-axis. The distance to the near culling boundary for this Camera relative to its local z-axis.
----
.. _class_Camera_property_projection: .. _class_Camera_property_projection:
- :ref:`Projection<enum_Camera_Projection>` **projection** - :ref:`Projection<enum_Camera_Projection>` **projection**
@@ -253,6 +275,8 @@ The distance to the near culling boundary for this Camera relative to its local
The camera's projection mode. In :ref:`PROJECTION_PERSPECTIVE<class_Camera_constant_PROJECTION_PERSPECTIVE>` mode, objects' z-distance from the camera's local space scales their perceived size. The camera's projection mode. In :ref:`PROJECTION_PERSPECTIVE<class_Camera_constant_PROJECTION_PERSPECTIVE>` mode, objects' z-distance from the camera's local space scales their perceived size.
----
.. _class_Camera_property_size: .. _class_Camera_property_size:
- :ref:`float<class_float>` **size** - :ref:`float<class_float>` **size**
@@ -265,6 +289,8 @@ The camera's projection mode. In :ref:`PROJECTION_PERSPECTIVE<class_Camera_const
The camera's size measured as 1/2 the width or height. Only applicable in orthogonal mode. Since :ref:`keep_aspect<class_Camera_property_keep_aspect>` locks on axis, ``size`` sets the other axis' size length. The camera's size measured as 1/2 the width or height. Only applicable in orthogonal mode. Since :ref:`keep_aspect<class_Camera_property_keep_aspect>` locks on axis, ``size`` sets the other axis' size length.
----
.. _class_Camera_property_v_offset: .. _class_Camera_property_v_offset:
- :ref:`float<class_float>` **v_offset** - :ref:`float<class_float>` **v_offset**
@@ -286,72 +312,98 @@ Method Descriptions
If this is the current Camera, remove it from being current. If ``enable_next`` is ``true``, request to make the next Camera current, if any. If this is the current Camera, remove it from being current. If ``enable_next`` is ``true``, request to make the next Camera current, if any.
----
.. _class_Camera_method_get_camera_transform: .. _class_Camera_method_get_camera_transform:
- :ref:`Transform<class_Transform>` **get_camera_transform** **(** **)** const - :ref:`Transform<class_Transform>` **get_camera_transform** **(** **)** const
Gets the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the :ref:`Node<class_Node>` transform. Gets the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the :ref:`Node<class_Node>` transform.
----
.. _class_Camera_method_get_cull_mask_bit: .. _class_Camera_method_get_cull_mask_bit:
- :ref:`bool<class_bool>` **get_cull_mask_bit** **(** :ref:`int<class_int>` layer **)** const - :ref:`bool<class_bool>` **get_cull_mask_bit** **(** :ref:`int<class_int>` layer **)** const
----
.. _class_Camera_method_get_frustum: .. _class_Camera_method_get_frustum:
- :ref:`Array<class_Array>` **get_frustum** **(** **)** const - :ref:`Array<class_Array>` **get_frustum** **(** **)** const
----
.. _class_Camera_method_is_position_behind: .. _class_Camera_method_is_position_behind:
- :ref:`bool<class_bool>` **is_position_behind** **(** :ref:`Vector3<class_Vector3>` world_point **)** const - :ref:`bool<class_bool>` **is_position_behind** **(** :ref:`Vector3<class_Vector3>` world_point **)** const
Returns ``true`` if the given position is behind the Camera. Note that a position which returns ``false`` may still be outside the Camera's field of view. Returns ``true`` if the given position is behind the Camera. Note that a position which returns ``false`` may still be outside the Camera's field of view.
----
.. _class_Camera_method_make_current: .. _class_Camera_method_make_current:
- void **make_current** **(** **)** - void **make_current** **(** **)**
Makes this camera the current Camera for the :ref:`Viewport<class_Viewport>` (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added. Makes this camera the current Camera for the :ref:`Viewport<class_Viewport>` (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added.
----
.. _class_Camera_method_project_local_ray_normal: .. _class_Camera_method_project_local_ray_normal:
- :ref:`Vector3<class_Vector3>` **project_local_ray_normal** **(** :ref:`Vector2<class_Vector2>` screen_point **)** const - :ref:`Vector3<class_Vector3>` **project_local_ray_normal** **(** :ref:`Vector2<class_Vector2>` screen_point **)** const
Returns a normal vector from the screen point location directed along the camera. Orthogonal cameras are normalized. Perspective cameras account for perspective, screen width/height, etc. Returns a normal vector from the screen point location directed along the camera. Orthogonal cameras are normalized. Perspective cameras account for perspective, screen width/height, etc.
----
.. _class_Camera_method_project_position: .. _class_Camera_method_project_position:
- :ref:`Vector3<class_Vector3>` **project_position** **(** :ref:`Vector2<class_Vector2>` screen_point **)** const - :ref:`Vector3<class_Vector3>` **project_position** **(** :ref:`Vector2<class_Vector2>` screen_point **)** const
Returns the 3D point in worldspace that maps to the given 2D coordinate in the :ref:`Viewport<class_Viewport>` rectangle. Returns the 3D point in worldspace that maps to the given 2D coordinate in the :ref:`Viewport<class_Viewport>` rectangle.
----
.. _class_Camera_method_project_ray_normal: .. _class_Camera_method_project_ray_normal:
- :ref:`Vector3<class_Vector3>` **project_ray_normal** **(** :ref:`Vector2<class_Vector2>` screen_point **)** const - :ref:`Vector3<class_Vector3>` **project_ray_normal** **(** :ref:`Vector2<class_Vector2>` screen_point **)** const
Returns a normal vector in worldspace, that is the result of projecting a point on the :ref:`Viewport<class_Viewport>` rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. Returns a normal vector in worldspace, that is the result of projecting a point on the :ref:`Viewport<class_Viewport>` rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking.
----
.. _class_Camera_method_project_ray_origin: .. _class_Camera_method_project_ray_origin:
- :ref:`Vector3<class_Vector3>` **project_ray_origin** **(** :ref:`Vector2<class_Vector2>` screen_point **)** const - :ref:`Vector3<class_Vector3>` **project_ray_origin** **(** :ref:`Vector2<class_Vector2>` screen_point **)** const
Returns a 3D position in worldspace, that is the result of projecting a point on the :ref:`Viewport<class_Viewport>` rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. Returns a 3D position in worldspace, that is the result of projecting a point on the :ref:`Viewport<class_Viewport>` rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking.
----
.. _class_Camera_method_set_cull_mask_bit: .. _class_Camera_method_set_cull_mask_bit:
- void **set_cull_mask_bit** **(** :ref:`int<class_int>` layer, :ref:`bool<class_bool>` enable **)** - void **set_cull_mask_bit** **(** :ref:`int<class_int>` layer, :ref:`bool<class_bool>` enable **)**
----
.. _class_Camera_method_set_orthogonal: .. _class_Camera_method_set_orthogonal:
- void **set_orthogonal** **(** :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** - void **set_orthogonal** **(** :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
Sets the camera projection to orthogonal mode, by specifying a width and the *near* and *far* clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels) Sets the camera projection to orthogonal mode, by specifying a width and the *near* and *far* clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels)
----
.. _class_Camera_method_set_perspective: .. _class_Camera_method_set_perspective:
- void **set_perspective** **(** :ref:`float<class_float>` fov, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** - void **set_perspective** **(** :ref:`float<class_float>` fov, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
Sets 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. Sets 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_method_unproject_position: .. _class_Camera_method_unproject_position:
- :ref:`Vector2<class_Vector2>` **unproject_position** **(** :ref:`Vector3<class_Vector3>` world_point **)** const - :ref:`Vector2<class_Vector2>` **unproject_position** **(** :ref:`Vector3<class_Vector3>` world_point **)** const

62
classes/class_camera2d.rst
View File

@@ -107,6 +107,8 @@ enum **AnchorMode**:
- **ANCHOR_MODE_DRAG_CENTER** = **1** --- The camera's position takes into account vertical/horizontal offsets and the screen size. - **ANCHOR_MODE_DRAG_CENTER** = **1** --- The camera's position takes into account vertical/horizontal offsets and the screen size.
----
.. _enum_Camera2D_Camera2DProcessMode: .. _enum_Camera2D_Camera2DProcessMode:
.. _class_Camera2D_constant_CAMERA2D_PROCESS_PHYSICS: .. _class_Camera2D_constant_CAMERA2D_PROCESS_PHYSICS:
@@ -141,6 +143,8 @@ Property Descriptions
The Camera2D's anchor point. See ``ANCHOR_MODE_*`` constants. The Camera2D's anchor point. See ``ANCHOR_MODE_*`` constants.
----
.. _class_Camera2D_property_current: .. _class_Camera2D_property_current:
- :ref:`bool<class_bool>` **current** - :ref:`bool<class_bool>` **current**
@@ -151,6 +155,8 @@ The Camera2D's anchor point. See ``ANCHOR_MODE_*`` constants.
If ``true``, the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera ``current`` will disable this one. If ``true``, the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera ``current`` will disable this one.
----
.. _class_Camera2D_property_custom_viewport: .. _class_Camera2D_property_custom_viewport:
- :ref:`Node<class_Node>` **custom_viewport** - :ref:`Node<class_Node>` **custom_viewport**
@@ -163,6 +169,8 @@ If ``true``, the camera is the active camera for the current scene. Only one cam
The custom :ref:`Viewport<class_Viewport>` node attached to the ``Camera2D``. If null or not a :ref:`Viewport<class_Viewport>`, uses the default viewport instead. The custom :ref:`Viewport<class_Viewport>` node attached to the ``Camera2D``. If null or not a :ref:`Viewport<class_Viewport>`, uses the default viewport instead.
----
.. _class_Camera2D_property_drag_margin_bottom: .. _class_Camera2D_property_drag_margin_bottom:
- :ref:`float<class_float>` **drag_margin_bottom** - :ref:`float<class_float>` **drag_margin_bottom**
@@ -175,6 +183,8 @@ The custom :ref:`Viewport<class_Viewport>` node attached to the ``Camera2D``. If
Bottom margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. Bottom margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen.
----
.. _class_Camera2D_property_drag_margin_h_enabled: .. _class_Camera2D_property_drag_margin_h_enabled:
- :ref:`bool<class_bool>` **drag_margin_h_enabled** - :ref:`bool<class_bool>` **drag_margin_h_enabled**
@@ -187,6 +197,8 @@ Bottom margin needed to drag the camera. A value of ``1`` makes the camera move
If ``true``, the camera only moves when reaching the horizontal drag margins. If ``false``, the camera moves horizontally regardless of margins. Default value: ``true``. If ``true``, the camera only moves when reaching the horizontal drag margins. If ``false``, the camera moves horizontally regardless of margins. Default value: ``true``.
----
.. _class_Camera2D_property_drag_margin_left: .. _class_Camera2D_property_drag_margin_left:
- :ref:`float<class_float>` **drag_margin_left** - :ref:`float<class_float>` **drag_margin_left**
@@ -199,6 +211,8 @@ If ``true``, the camera only moves when reaching the horizontal drag margins. If
Left margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. Left margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen.
----
.. _class_Camera2D_property_drag_margin_right: .. _class_Camera2D_property_drag_margin_right:
- :ref:`float<class_float>` **drag_margin_right** - :ref:`float<class_float>` **drag_margin_right**
@@ -211,6 +225,8 @@ Left margin needed to drag the camera. A value of ``1`` makes the camera move on
Right margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. Right margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen.
----
.. _class_Camera2D_property_drag_margin_top: .. _class_Camera2D_property_drag_margin_top:
- :ref:`float<class_float>` **drag_margin_top** - :ref:`float<class_float>` **drag_margin_top**
@@ -223,6 +239,8 @@ Right margin needed to drag the camera. A value of ``1`` makes the camera move o
Top margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. Top margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen.
----
.. _class_Camera2D_property_drag_margin_v_enabled: .. _class_Camera2D_property_drag_margin_v_enabled:
- :ref:`bool<class_bool>` **drag_margin_v_enabled** - :ref:`bool<class_bool>` **drag_margin_v_enabled**
@@ -235,6 +253,8 @@ Top margin needed to drag the camera. A value of ``1`` makes the camera move onl
If ``true``, the camera only moves when reaching the vertical drag margins. If ``false``, the camera moves vertically regardless of margins. Default value: ``true``. If ``true``, the camera only moves when reaching the vertical drag margins. If ``false``, the camera moves vertically regardless of margins. Default value: ``true``.
----
.. _class_Camera2D_property_editor_draw_drag_margin: .. _class_Camera2D_property_editor_draw_drag_margin:
- :ref:`bool<class_bool>` **editor_draw_drag_margin** - :ref:`bool<class_bool>` **editor_draw_drag_margin**
@@ -247,6 +267,8 @@ If ``true``, the camera only moves when reaching the vertical drag margins. If `
If ``true``, draws the camera's drag margin rectangle in the editor. Default value: ``false`` If ``true``, draws the camera's drag margin rectangle in the editor. Default value: ``false``
----
.. _class_Camera2D_property_editor_draw_limits: .. _class_Camera2D_property_editor_draw_limits:
- :ref:`bool<class_bool>` **editor_draw_limits** - :ref:`bool<class_bool>` **editor_draw_limits**
@@ -259,6 +281,8 @@ If ``true``, draws the camera's drag margin rectangle in the editor. Default val
If ``true``, draws the camera's limits rectangle in the editor. Default value: ``true`` If ``true``, draws the camera's limits rectangle in the editor. Default value: ``true``
----
.. _class_Camera2D_property_editor_draw_screen: .. _class_Camera2D_property_editor_draw_screen:
- :ref:`bool<class_bool>` **editor_draw_screen** - :ref:`bool<class_bool>` **editor_draw_screen**
@@ -271,6 +295,8 @@ If ``true``, draws the camera's limits rectangle in the editor. Default value: `
If ``true``, draws the camera's screen rectangle in the editor. Default value: ``false`` If ``true``, draws the camera's screen rectangle in the editor. Default value: ``false``
----
.. _class_Camera2D_property_limit_bottom: .. _class_Camera2D_property_limit_bottom:
- :ref:`int<class_int>` **limit_bottom** - :ref:`int<class_int>` **limit_bottom**
@@ -283,6 +309,8 @@ If ``true``, draws the camera's screen rectangle in the editor. Default value: `
Bottom scroll limit in pixels. The camera stops moving when reaching this value. Bottom scroll limit in pixels. The camera stops moving when reaching this value.
----
.. _class_Camera2D_property_limit_left: .. _class_Camera2D_property_limit_left:
- :ref:`int<class_int>` **limit_left** - :ref:`int<class_int>` **limit_left**
@@ -295,6 +323,8 @@ Bottom scroll limit in pixels. The camera stops moving when reaching this value.
Left scroll limit in pixels. The camera stops moving when reaching this value. Left scroll limit in pixels. The camera stops moving when reaching this value.
----
.. _class_Camera2D_property_limit_right: .. _class_Camera2D_property_limit_right:
- :ref:`int<class_int>` **limit_right** - :ref:`int<class_int>` **limit_right**
@@ -307,6 +337,8 @@ Left scroll limit in pixels. The camera stops moving when reaching this value.
Right scroll limit in pixels. The camera stops moving when reaching this value. Right scroll limit in pixels. The camera stops moving when reaching this value.
----
.. _class_Camera2D_property_limit_smoothed: .. _class_Camera2D_property_limit_smoothed:
- :ref:`bool<class_bool>` **limit_smoothed** - :ref:`bool<class_bool>` **limit_smoothed**
@@ -319,6 +351,8 @@ Right scroll limit in pixels. The camera stops moving when reaching this value.
If ``true``, the camera smoothly stops when reaches its limits. Default value: ``false`` If ``true``, the camera smoothly stops when reaches its limits. Default value: ``false``
----
.. _class_Camera2D_property_limit_top: .. _class_Camera2D_property_limit_top:
- :ref:`int<class_int>` **limit_top** - :ref:`int<class_int>` **limit_top**
@@ -331,6 +365,8 @@ If ``true``, the camera smoothly stops when reaches its limits. Default value: `
Top scroll limit in pixels. The camera stops moving when reaching this value. Top scroll limit in pixels. The camera stops moving when reaching this value.
----
.. _class_Camera2D_property_offset: .. _class_Camera2D_property_offset:
- :ref:`Vector2<class_Vector2>` **offset** - :ref:`Vector2<class_Vector2>` **offset**
@@ -343,6 +379,8 @@ Top scroll limit in pixels. The camera stops moving when reaching this value.
The camera's offset, useful for looking around or camera shake animations. The camera's offset, useful for looking around or camera shake animations.
----
.. _class_Camera2D_property_offset_h: .. _class_Camera2D_property_offset_h:
- :ref:`float<class_float>` **offset_h** - :ref:`float<class_float>` **offset_h**
@@ -355,6 +393,8 @@ The camera's offset, useful for looking around or camera shake animations.
The horizontal offset of the camera, relative to the drag margins. Default value: ``0`` The horizontal offset of the camera, relative to the drag margins. Default value: ``0``
----
.. _class_Camera2D_property_offset_v: .. _class_Camera2D_property_offset_v:
- :ref:`float<class_float>` **offset_v** - :ref:`float<class_float>` **offset_v**
@@ -367,6 +407,8 @@ The horizontal offset of the camera, relative to the drag margins. Default value
The vertical offset of the camera, relative to the drag margins. Default value: ``0`` The vertical offset of the camera, relative to the drag margins. Default value: ``0``
----
.. _class_Camera2D_property_process_mode: .. _class_Camera2D_property_process_mode:
- :ref:`Camera2DProcessMode<enum_Camera2D_Camera2DProcessMode>` **process_mode** - :ref:`Camera2DProcessMode<enum_Camera2D_Camera2DProcessMode>` **process_mode**
@@ -377,6 +419,8 @@ The vertical offset of the camera, relative to the drag margins. Default value:
| *Getter* | get_process_mode() | | *Getter* | get_process_mode() |
+----------+-------------------------+ +----------+-------------------------+
----
.. _class_Camera2D_property_rotating: .. _class_Camera2D_property_rotating:
- :ref:`bool<class_bool>` **rotating** - :ref:`bool<class_bool>` **rotating**
@@ -389,6 +433,8 @@ The vertical offset of the camera, relative to the drag margins. Default value:
If ``true``, the camera rotates with the target. Default value: ``false`` If ``true``, the camera rotates with the target. Default value: ``false``
----
.. _class_Camera2D_property_smoothing_enabled: .. _class_Camera2D_property_smoothing_enabled:
- :ref:`bool<class_bool>` **smoothing_enabled** - :ref:`bool<class_bool>` **smoothing_enabled**
@@ -401,6 +447,8 @@ If ``true``, the camera rotates with the target. Default value: ``false``
If ``true``, the camera smoothly moves towards the target at :ref:`smoothing_speed<class_Camera2D_property_smoothing_speed>`. Default value: ``false`` If ``true``, the camera smoothly moves towards the target at :ref:`smoothing_speed<class_Camera2D_property_smoothing_speed>`. Default value: ``false``
----
.. _class_Camera2D_property_smoothing_speed: .. _class_Camera2D_property_smoothing_speed:
- :ref:`float<class_float>` **smoothing_speed** - :ref:`float<class_float>` **smoothing_speed**
@@ -413,6 +461,8 @@ If ``true``, the camera smoothly moves towards the target at :ref:`smoothing_spe
Speed in pixels per second of the camera's smoothing effect when :ref:`smoothing_enabled<class_Camera2D_property_smoothing_enabled>` is ``true`` Speed in pixels per second of the camera's smoothing effect when :ref:`smoothing_enabled<class_Camera2D_property_smoothing_enabled>` is ``true``
----
.. _class_Camera2D_property_zoom: .. _class_Camera2D_property_zoom:
- :ref:`Vector2<class_Vector2>` **zoom** - :ref:`Vector2<class_Vector2>` **zoom**
@@ -434,36 +484,48 @@ Method Descriptions
Align the camera to the tracked node Align the camera to the tracked node
----
.. _class_Camera2D_method_clear_current: .. _class_Camera2D_method_clear_current:
- void **clear_current** **(** **)** - void **clear_current** **(** **)**
Removes any ``Camera2D`` from the ancestor :ref:`Viewport<class_Viewport>`'s internal currently-assigned camera. Removes any ``Camera2D`` from the ancestor :ref:`Viewport<class_Viewport>`'s internal currently-assigned camera.
----
.. _class_Camera2D_method_force_update_scroll: .. _class_Camera2D_method_force_update_scroll:
- void **force_update_scroll** **(** **)** - void **force_update_scroll** **(** **)**
Force the camera to update scroll immediately. Force the camera to update scroll immediately.
----
.. _class_Camera2D_method_get_camera_position: .. _class_Camera2D_method_get_camera_position:
- :ref:`Vector2<class_Vector2>` **get_camera_position** **(** **)** const - :ref:`Vector2<class_Vector2>` **get_camera_position** **(** **)** const
Returns the camera position. Returns the camera position.
----
.. _class_Camera2D_method_get_camera_screen_center: .. _class_Camera2D_method_get_camera_screen_center:
- :ref:`Vector2<class_Vector2>` **get_camera_screen_center** **(** **)** const - :ref:`Vector2<class_Vector2>` **get_camera_screen_center** **(** **)** const
Returns the location of the ``Camera2D``'s screen-center, relative to the origin. Returns the location of the ``Camera2D``'s screen-center, relative to the origin.
----
.. _class_Camera2D_method_make_current: .. _class_Camera2D_method_make_current:
- void **make_current** **(** **)** - void **make_current** **(** **)**
Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene. Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene.
----
.. _class_Camera2D_method_reset_smoothing: .. _class_Camera2D_method_reset_smoothing:
- void **reset_smoothing** **(** **)** - void **reset_smoothing** **(** **)**

108
classes/class_canvasitem.rst
View File

@@ -145,18 +145,24 @@ Signals
Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing. Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing.
----
.. _class_CanvasItem_signal_hide: .. _class_CanvasItem_signal_hide:
- **hide** **(** **)** - **hide** **(** **)**
Emitted when becoming hidden. Emitted when becoming hidden.
----
.. _class_CanvasItem_signal_item_rect_changed: .. _class_CanvasItem_signal_item_rect_changed:
- **item_rect_changed** **(** **)** - **item_rect_changed** **(** **)**
Emitted when the item rect has changed. Emitted when the item rect has changed.
----
.. _class_CanvasItem_signal_visibility_changed: .. _class_CanvasItem_signal_visibility_changed:
- **visibility_changed** **(** **)** - **visibility_changed** **(** **)**
@@ -252,6 +258,8 @@ Property Descriptions
The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D<class_Light2D>` nodes. Default value: ``1``. The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D<class_Light2D>` nodes. Default value: ``1``.
----
.. _class_CanvasItem_property_material: .. _class_CanvasItem_property_material:
- :ref:`Material<class_Material>` **material** - :ref:`Material<class_Material>` **material**
@@ -264,6 +272,8 @@ The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D<clas
The material applied to textures on this ``CanvasItem``. Default value: ``null``. The material applied to textures on this ``CanvasItem``. Default value: ``null``.
----
.. _class_CanvasItem_property_modulate: .. _class_CanvasItem_property_modulate:
- :ref:`Color<class_Color>` **modulate** - :ref:`Color<class_Color>` **modulate**
@@ -276,6 +286,8 @@ The material applied to textures on this ``CanvasItem``. Default value: ``null``
The color applied to textures on this ``CanvasItem``. Default value: ``Color(1, 1, 1, 1)`` (opaque "white"). The color applied to textures on this ``CanvasItem``. Default value: ``Color(1, 1, 1, 1)`` (opaque "white").
----
.. _class_CanvasItem_property_self_modulate: .. _class_CanvasItem_property_self_modulate:
- :ref:`Color<class_Color>` **self_modulate** - :ref:`Color<class_Color>` **self_modulate**
@@ -288,6 +300,8 @@ The color applied to textures on this ``CanvasItem``. Default value: ``Color(1,
The color applied to textures on this ``CanvasItem``. This is not inherited by children ``CanvasItem``\ s. Default value: ``Color(1, 1, 1, 1)`` (opaque "white").. The color applied to textures on this ``CanvasItem``. This is not inherited by children ``CanvasItem``\ s. Default value: ``Color(1, 1, 1, 1)`` (opaque "white")..
----
.. _class_CanvasItem_property_show_behind_parent: .. _class_CanvasItem_property_show_behind_parent:
- :ref:`bool<class_bool>` **show_behind_parent** - :ref:`bool<class_bool>` **show_behind_parent**
@@ -300,12 +314,16 @@ The color applied to textures on this ``CanvasItem``. This is not inherited by c
If ``true``, the object draws behind its parent. Default value: ``false``. If ``true``, the object draws behind its parent. Default value: ``false``.
----
.. _class_CanvasItem_property_show_on_top: .. _class_CanvasItem_property_show_on_top:
- :ref:`bool<class_bool>` **show_on_top** - :ref:`bool<class_bool>` **show_on_top**
If ``true``, the object draws on top of its parent. Default value: ``true``. If ``true``, the object draws on top of its parent. Default value: ``true``.
----
.. _class_CanvasItem_property_use_parent_material: .. _class_CanvasItem_property_use_parent_material:
- :ref:`bool<class_bool>` **use_parent_material** - :ref:`bool<class_bool>` **use_parent_material**
@@ -318,6 +336,8 @@ If ``true``, the object draws on top of its parent. Default value: ``true``.
If ``true``, the parent ``CanvasItem``'s :ref:`material<class_CanvasItem_property_material>` property is used as this one's material. Default value: ``false``. If ``true``, the parent ``CanvasItem``'s :ref:`material<class_CanvasItem_property_material>` property is used as this one's material. Default value: ``false``.
----
.. _class_CanvasItem_property_visible: .. _class_CanvasItem_property_visible:
- :ref:`bool<class_bool>` **visible** - :ref:`bool<class_bool>` **visible**
@@ -339,258 +359,346 @@ Method Descriptions
Called (if exists) to draw the canvas item. Called (if exists) to draw the canvas item.
----
.. _class_CanvasItem_method_draw_char: .. _class_CanvasItem_method_draw_char:
- :ref:`float<class_float>` **draw_char** **(** :ref:`Font<class_Font>` font, :ref:`Vector2<class_Vector2>` position, :ref:`String<class_String>` char, :ref:`String<class_String>` next, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ) **)** - :ref:`float<class_float>` **draw_char** **(** :ref:`Font<class_Font>` font, :ref:`Vector2<class_Vector2>` position, :ref:`String<class_String>` char, :ref:`String<class_String>` next, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ) **)**
Draws a string character using a custom font. Returns the advance, depending on the character width and kerning with an optional next character. Draws a string character using a custom font. Returns the advance, depending on the character width and kerning with an optional next character.
----
.. _class_CanvasItem_method_draw_circle: .. _class_CanvasItem_method_draw_circle:
- void **draw_circle** **(** :ref:`Vector2<class_Vector2>` position, :ref:`float<class_float>` radius, :ref:`Color<class_Color>` color **)** - void **draw_circle** **(** :ref:`Vector2<class_Vector2>` position, :ref:`float<class_float>` radius, :ref:`Color<class_Color>` color **)**
Draws a colored circle. Draws a colored circle.
----
.. _class_CanvasItem_method_draw_colored_polygon: .. _class_CanvasItem_method_draw_colored_polygon:
- void **draw_colored_polygon** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs=PoolVector2Array( ), :ref:`Texture<class_Texture>` texture=null, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` antialiased=false **)** - void **draw_colored_polygon** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs=PoolVector2Array( ), :ref:`Texture<class_Texture>` texture=null, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` antialiased=false **)**
Draws a colored polygon of any amount of points, convex or concave. Draws a colored polygon of any amount of points, convex or concave.
----
.. _class_CanvasItem_method_draw_line: .. _class_CanvasItem_method_draw_line:
- void **draw_line** **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** - void **draw_line** **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased. Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased.
----
.. _class_CanvasItem_method_draw_mesh: .. _class_CanvasItem_method_draw_mesh:
- void **draw_mesh** **(** :ref:`Mesh<class_Mesh>` mesh, :ref:`Texture<class_Texture>` texture, :ref:`Texture<class_Texture>` normal_map=null **)** - void **draw_mesh** **(** :ref:`Mesh<class_Mesh>` mesh, :ref:`Texture<class_Texture>` texture, :ref:`Texture<class_Texture>` normal_map=null **)**
----
.. _class_CanvasItem_method_draw_multiline: .. _class_CanvasItem_method_draw_multiline:
- void **draw_multiline** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** - void **draw_multiline** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
Draws multiple, parallel lines with a uniform ``color``. ``width`` and ``antialiased`` are currently not implemented and have no effect. Draws multiple, parallel lines with a uniform ``color``. ``width`` and ``antialiased`` are currently not implemented and have no effect.
----
.. _class_CanvasItem_method_draw_multiline_colors: .. _class_CanvasItem_method_draw_multiline_colors:
- void **draw_multiline_colors** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** - void **draw_multiline_colors** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
Draws multiple, parallel lines with a uniform ``width``, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between ``points`` and ``colors``. Draws multiple, parallel lines with a uniform ``width``, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between ``points`` and ``colors``.
----
.. _class_CanvasItem_method_draw_multimesh: .. _class_CanvasItem_method_draw_multimesh:
- void **draw_multimesh** **(** :ref:`MultiMesh<class_MultiMesh>` multimesh, :ref:`Texture<class_Texture>` texture, :ref:`Texture<class_Texture>` normal_map=null **)** - void **draw_multimesh** **(** :ref:`MultiMesh<class_MultiMesh>` multimesh, :ref:`Texture<class_Texture>` texture, :ref:`Texture<class_Texture>` normal_map=null **)**
----
.. _class_CanvasItem_method_draw_polygon: .. _class_CanvasItem_method_draw_polygon:
- void **draw_polygon** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs=PoolVector2Array( ), :ref:`Texture<class_Texture>` texture=null, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` antialiased=false **)** - void **draw_polygon** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs=PoolVector2Array( ), :ref:`Texture<class_Texture>` texture=null, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` antialiased=false **)**
Draws a polygon of any amount of points, convex or concave. Draws a polygon of any amount of points, convex or concave.
----
.. _class_CanvasItem_method_draw_polyline: .. _class_CanvasItem_method_draw_polyline:
- void **draw_polyline** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** - void **draw_polyline** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
Draws interconnected line segments with a uniform ``color`` and ``width`` and optional antialiasing. Draws interconnected line segments with a uniform ``color`` and ``width`` and optional antialiasing.
----
.. _class_CanvasItem_method_draw_polyline_colors: .. _class_CanvasItem_method_draw_polyline_colors:
- void **draw_polyline_colors** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** - void **draw_polyline_colors** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
Draws interconnected line segments with a uniform ``width``, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between ``points`` and ``colors``. Draws interconnected line segments with a uniform ``width``, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between ``points`` and ``colors``.
----
.. _class_CanvasItem_method_draw_primitive: .. _class_CanvasItem_method_draw_primitive:
- void **draw_primitive** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs, :ref:`Texture<class_Texture>` texture=null, :ref:`float<class_float>` width=1.0, :ref:`Texture<class_Texture>` normal_map=null **)** - void **draw_primitive** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs, :ref:`Texture<class_Texture>` texture=null, :ref:`float<class_float>` width=1.0, :ref:`Texture<class_Texture>` normal_map=null **)**
Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad. Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.
----
.. _class_CanvasItem_method_draw_rect: .. _class_CanvasItem_method_draw_rect:
- void **draw_rect** **(** :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` filled=true **)** - void **draw_rect** **(** :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` filled=true **)**
Draws a colored rectangle. Draws a colored rectangle.
----
.. _class_CanvasItem_method_draw_set_transform: .. _class_CanvasItem_method_draw_set_transform:
- void **draw_set_transform** **(** :ref:`Vector2<class_Vector2>` position, :ref:`float<class_float>` rotation, :ref:`Vector2<class_Vector2>` scale **)** - void **draw_set_transform** **(** :ref:`Vector2<class_Vector2>` position, :ref:`float<class_float>` rotation, :ref:`Vector2<class_Vector2>` scale **)**
Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this. Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this.
----
.. _class_CanvasItem_method_draw_set_transform_matrix: .. _class_CanvasItem_method_draw_set_transform_matrix:
- void **draw_set_transform_matrix** **(** :ref:`Transform2D<class_Transform2D>` xform **)** - void **draw_set_transform_matrix** **(** :ref:`Transform2D<class_Transform2D>` xform **)**
Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this. Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this.
----
.. _class_CanvasItem_method_draw_string: .. _class_CanvasItem_method_draw_string:
- void **draw_string** **(** :ref:`Font<class_Font>` font, :ref:`Vector2<class_Vector2>` position, :ref:`String<class_String>` text, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`int<class_int>` clip_w=-1 **)** - void **draw_string** **(** :ref:`Font<class_Font>` font, :ref:`Vector2<class_Vector2>` position, :ref:`String<class_String>` text, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`int<class_int>` clip_w=-1 **)**
Draws a string using a custom font. Draws a string using a custom font.
----
.. _class_CanvasItem_method_draw_style_box: .. _class_CanvasItem_method_draw_style_box:
- void **draw_style_box** **(** :ref:`StyleBox<class_StyleBox>` style_box, :ref:`Rect2<class_Rect2>` rect **)** - void **draw_style_box** **(** :ref:`StyleBox<class_StyleBox>` style_box, :ref:`Rect2<class_Rect2>` rect **)**
Draws a styled rectangle. Draws a styled rectangle.
----
.. _class_CanvasItem_method_draw_texture: .. _class_CanvasItem_method_draw_texture:
- void **draw_texture** **(** :ref:`Texture<class_Texture>` texture, :ref:`Vector2<class_Vector2>` position, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture<class_Texture>` normal_map=null **)** - void **draw_texture** **(** :ref:`Texture<class_Texture>` texture, :ref:`Vector2<class_Vector2>` position, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture<class_Texture>` normal_map=null **)**
Draws a texture at a given position. Draws a texture at a given position.
----
.. _class_CanvasItem_method_draw_texture_rect: .. _class_CanvasItem_method_draw_texture_rect:
- void **draw_texture_rect** **(** :ref:`Texture<class_Texture>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` tile, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null **)** - void **draw_texture_rect** **(** :ref:`Texture<class_Texture>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` tile, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null **)**
Draws a textured rectangle at a given position, optionally modulated by a color. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped. Draws a textured rectangle at a given position, optionally modulated by a color. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped.
----
.. _class_CanvasItem_method_draw_texture_rect_region: .. _class_CanvasItem_method_draw_texture_rect_region:
- void **draw_texture_rect_region** **(** :ref:`Texture<class_Texture>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` clip_uv=true **)** - void **draw_texture_rect_region** **(** :ref:`Texture<class_Texture>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` clip_uv=true **)**
Draws a textured rectangle region at a given position, optionally modulated by a color. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped. Draws a textured rectangle region at a given position, optionally modulated by a color. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped.
----
.. _class_CanvasItem_method_force_update_transform: .. _class_CanvasItem_method_force_update_transform:
- void **force_update_transform** **(** **)** - void **force_update_transform** **(** **)**
----
.. _class_CanvasItem_method_get_canvas: .. _class_CanvasItem_method_get_canvas:
- :ref:`RID<class_RID>` **get_canvas** **(** **)** const - :ref:`RID<class_RID>` **get_canvas** **(** **)** const
Returns the :ref:`RID<class_RID>` of the :ref:`World2D<class_World2D>` canvas where this item is in. Returns the :ref:`RID<class_RID>` of the :ref:`World2D<class_World2D>` canvas where this item is in.
----
.. _class_CanvasItem_method_get_canvas_item: .. _class_CanvasItem_method_get_canvas_item:
- :ref:`RID<class_RID>` **get_canvas_item** **(** **)** const - :ref:`RID<class_RID>` **get_canvas_item** **(** **)** const
Returns the canvas item RID used by :ref:`VisualServer<class_VisualServer>` for this item. Returns the canvas item RID used by :ref:`VisualServer<class_VisualServer>` for this item.
----
.. _class_CanvasItem_method_get_canvas_transform: .. _class_CanvasItem_method_get_canvas_transform:
- :ref:`Transform2D<class_Transform2D>` **get_canvas_transform** **(** **)** const - :ref:`Transform2D<class_Transform2D>` **get_canvas_transform** **(** **)** const
Get the transform matrix of this item's canvas. Get the transform matrix of this item's canvas.
----
.. _class_CanvasItem_method_get_global_mouse_position: .. _class_CanvasItem_method_get_global_mouse_position:
- :ref:`Vector2<class_Vector2>` **get_global_mouse_position** **(** **)** const - :ref:`Vector2<class_Vector2>` **get_global_mouse_position** **(** **)** const
Get the global position of the mouse. Get the global position of the mouse.
----
.. _class_CanvasItem_method_get_global_transform: .. _class_CanvasItem_method_get_global_transform:
- :ref:`Transform2D<class_Transform2D>` **get_global_transform** **(** **)** const - :ref:`Transform2D<class_Transform2D>` **get_global_transform** **(** **)** const
Get the global transform matrix of this item. Get the global transform matrix of this item.
----
.. _class_CanvasItem_method_get_global_transform_with_canvas: .. _class_CanvasItem_method_get_global_transform_with_canvas:
- :ref:`Transform2D<class_Transform2D>` **get_global_transform_with_canvas** **(** **)** const - :ref:`Transform2D<class_Transform2D>` **get_global_transform_with_canvas** **(** **)** const
Get the global transform matrix of this item in relation to the canvas. Get the global transform matrix of this item in relation to the canvas.
----
.. _class_CanvasItem_method_get_local_mouse_position: .. _class_CanvasItem_method_get_local_mouse_position:
- :ref:`Vector2<class_Vector2>` **get_local_mouse_position** **(** **)** const - :ref:`Vector2<class_Vector2>` **get_local_mouse_position** **(** **)** const
Get the mouse position relative to this item's position. Get the mouse position relative to this item's position.
----
.. _class_CanvasItem_method_get_transform: .. _class_CanvasItem_method_get_transform:
- :ref:`Transform2D<class_Transform2D>` **get_transform** **(** **)** const - :ref:`Transform2D<class_Transform2D>` **get_transform** **(** **)** const
Get the transform matrix of this item. Get the transform matrix of this item.
----
.. _class_CanvasItem_method_get_viewport_rect: .. _class_CanvasItem_method_get_viewport_rect:
- :ref:`Rect2<class_Rect2>` **get_viewport_rect** **(** **)** const - :ref:`Rect2<class_Rect2>` **get_viewport_rect** **(** **)** const
Get the viewport's boundaries as a :ref:`Rect2<class_Rect2>`. Get the viewport's boundaries as a :ref:`Rect2<class_Rect2>`.
----
.. _class_CanvasItem_method_get_viewport_transform: .. _class_CanvasItem_method_get_viewport_transform:
- :ref:`Transform2D<class_Transform2D>` **get_viewport_transform** **(** **)** const - :ref:`Transform2D<class_Transform2D>` **get_viewport_transform** **(** **)** const
Get this item's transform in relation to the viewport. Get this item's transform in relation to the viewport.
----
.. _class_CanvasItem_method_get_world_2d: .. _class_CanvasItem_method_get_world_2d:
- :ref:`World2D<class_World2D>` **get_world_2d** **(** **)** const - :ref:`World2D<class_World2D>` **get_world_2d** **(** **)** const
Get the :ref:`World2D<class_World2D>` where this item is in. Get the :ref:`World2D<class_World2D>` where this item is in.
----
.. _class_CanvasItem_method_hide: .. _class_CanvasItem_method_hide:
- void **hide** **(** **)** - void **hide** **(** **)**
Hide the CanvasItem if it's currently visible. Hide the CanvasItem if it's currently visible.
----
.. _class_CanvasItem_method_is_local_transform_notification_enabled: .. _class_CanvasItem_method_is_local_transform_notification_enabled:
- :ref:`bool<class_bool>` **is_local_transform_notification_enabled** **(** **)** const - :ref:`bool<class_bool>` **is_local_transform_notification_enabled** **(** **)** const
Returns ``true`` if local transform notifications are communicated to children. Returns ``true`` if local transform notifications are communicated to children.
----
.. _class_CanvasItem_method_is_set_as_toplevel: .. _class_CanvasItem_method_is_set_as_toplevel:
- :ref:`bool<class_bool>` **is_set_as_toplevel** **(** **)** const - :ref:`bool<class_bool>` **is_set_as_toplevel** **(** **)** const
Returns ``true`` if the node is set as top-level. See :ref:`set_as_toplevel<class_CanvasItem_method_set_as_toplevel>`. Returns ``true`` if the node is set as top-level. See :ref:`set_as_toplevel<class_CanvasItem_method_set_as_toplevel>`.
----
.. _class_CanvasItem_method_is_transform_notification_enabled: .. _class_CanvasItem_method_is_transform_notification_enabled:
- :ref:`bool<class_bool>` **is_transform_notification_enabled** **(** **)** const - :ref:`bool<class_bool>` **is_transform_notification_enabled** **(** **)** const
Returns ``true`` if global transform notifications are communicated to children. Returns ``true`` if global transform notifications are communicated to children.
----
.. _class_CanvasItem_method_is_visible_in_tree: .. _class_CanvasItem_method_is_visible_in_tree:
- :ref:`bool<class_bool>` **is_visible_in_tree** **(** **)** const - :ref:`bool<class_bool>` **is_visible_in_tree** **(** **)** const
Returns ``true`` if the node is present in the :ref:`SceneTree<class_SceneTree>`, its :ref:`visible<class_CanvasItem_property_visible>` property is ``true`` and its inherited visibility is also ``true``. Returns ``true`` if the node is present in the :ref:`SceneTree<class_SceneTree>`, its :ref:`visible<class_CanvasItem_property_visible>` property is ``true`` and its inherited visibility is also ``true``.
----
.. _class_CanvasItem_method_make_canvas_position_local: .. _class_CanvasItem_method_make_canvas_position_local:
- :ref:`Vector2<class_Vector2>` **make_canvas_position_local** **(** :ref:`Vector2<class_Vector2>` screen_point **)** const - :ref:`Vector2<class_Vector2>` **make_canvas_position_local** **(** :ref:`Vector2<class_Vector2>` screen_point **)** const
Assigns ``screen_point`` as this node's new local transform. Assigns ``screen_point`` as this node's new local transform.
----
.. _class_CanvasItem_method_make_input_local: .. _class_CanvasItem_method_make_input_local:
- :ref:`InputEvent<class_InputEvent>` **make_input_local** **(** :ref:`InputEvent<class_InputEvent>` event **)** const - :ref:`InputEvent<class_InputEvent>` **make_input_local** **(** :ref:`InputEvent<class_InputEvent>` event **)** const
Transformations issued by ``event``'s inputs are applied in local space instead of global space. Transformations issued by ``event``'s inputs are applied in local space instead of global space.
----
.. _class_CanvasItem_method_set_as_toplevel: .. _class_CanvasItem_method_set_as_toplevel:
- void **set_as_toplevel** **(** :ref:`bool<class_bool>` enable **)** - void **set_as_toplevel** **(** :ref:`bool<class_bool>` enable **)**
If ``enable`` is ``true``, the node won't inherit its transform from parent canvas items. If ``enable`` is ``true``, the node won't inherit its transform from parent canvas items.
----
.. _class_CanvasItem_method_set_notify_local_transform: .. _class_CanvasItem_method_set_notify_local_transform:
- void **set_notify_local_transform** **(** :ref:`bool<class_bool>` enable **)** - void **set_notify_local_transform** **(** :ref:`bool<class_bool>` enable **)**
If ``enable`` is ``true``, children will be updated with local transform data. If ``enable`` is ``true``, children will be updated with local transform data.
----
.. _class_CanvasItem_method_set_notify_transform: .. _class_CanvasItem_method_set_notify_transform:
- void **set_notify_transform** **(** :ref:`bool<class_bool>` enable **)** - void **set_notify_transform** **(** :ref:`bool<class_bool>` enable **)**
If ``enable`` is ``true``, children will be updated with global transform data. If ``enable`` is ``true``, children will be updated with global transform data.
----
.. _class_CanvasItem_method_show: .. _class_CanvasItem_method_show:
- void **show** **(** **)** - void **show** **(** **)**
Show the CanvasItem if it's currently hidden. For controls that inherit :ref:`Popup<class_Popup>`, the correct way to make them visible is to call one of the multiple ``popup*()`` functions instead. Show the CanvasItem if it's currently hidden. For controls that inherit :ref:`Popup<class_Popup>`, the correct way to make them visible is to call one of the multiple ``popup*()`` functions instead.
----
.. _class_CanvasItem_method_update: .. _class_CanvasItem_method_update:
- void **update** **(** **)** - void **update** **(** **)**

12
classes/class_canvasitemmaterial.rst
View File

@@ -62,6 +62,8 @@ enum **BlendMode**:
- **BLEND_MODE_PREMULT_ALPHA** = **4** --- Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value. - **BLEND_MODE_PREMULT_ALPHA** = **4** --- Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value.
----
.. _enum_CanvasItemMaterial_LightMode: .. _enum_CanvasItemMaterial_LightMode:
.. _class_CanvasItemMaterial_constant_LIGHT_MODE_NORMAL: .. _class_CanvasItemMaterial_constant_LIGHT_MODE_NORMAL:
@@ -98,6 +100,8 @@ Property Descriptions
The manner in which a material's rendering is applied to underlying textures. The manner in which a material's rendering is applied to underlying textures.
----
.. _class_CanvasItemMaterial_property_light_mode: .. _class_CanvasItemMaterial_property_light_mode:
- :ref:`LightMode<enum_CanvasItemMaterial_LightMode>` **light_mode** - :ref:`LightMode<enum_CanvasItemMaterial_LightMode>` **light_mode**
@@ -110,6 +114,8 @@ The manner in which a material's rendering is applied to underlying textures.
The manner in which material reacts to lighting. The manner in which material reacts to lighting.
----
.. _class_CanvasItemMaterial_property_particles_anim_h_frames: .. _class_CanvasItemMaterial_property_particles_anim_h_frames:
- :ref:`int<class_int>` **particles_anim_h_frames** - :ref:`int<class_int>` **particles_anim_h_frames**
@@ -120,6 +126,8 @@ The manner in which material reacts to lighting.
| *Getter* | get_particles_anim_h_frames() | | *Getter* | get_particles_anim_h_frames() |
+----------+------------------------------------+ +----------+------------------------------------+
----
.. _class_CanvasItemMaterial_property_particles_anim_loop: .. _class_CanvasItemMaterial_property_particles_anim_loop:
- :ref:`bool<class_bool>` **particles_anim_loop** - :ref:`bool<class_bool>` **particles_anim_loop**
@@ -130,6 +138,8 @@ The manner in which material reacts to lighting.
| *Getter* | get_particles_anim_loop() | | *Getter* | get_particles_anim_loop() |
+----------+--------------------------------+ +----------+--------------------------------+
----
.. _class_CanvasItemMaterial_property_particles_anim_v_frames: .. _class_CanvasItemMaterial_property_particles_anim_v_frames:
- :ref:`int<class_int>` **particles_anim_v_frames** - :ref:`int<class_int>` **particles_anim_v_frames**
@@ -140,6 +150,8 @@ The manner in which material reacts to lighting.
| *Getter* | get_particles_anim_v_frames() | | *Getter* | get_particles_anim_v_frames() |
+----------+------------------------------------+ +----------+------------------------------------+
----
.. _class_CanvasItemMaterial_property_particles_animation: .. _class_CanvasItemMaterial_property_particles_animation:
- :ref:`bool<class_bool>` **particles_animation** - :ref:`bool<class_bool>` **particles_animation**

12
classes/class_canvaslayer.rst
View File

@@ -73,6 +73,8 @@ Property Descriptions
The custom :ref:`Viewport<class_Viewport>` node assigned to the ``CanvasLayer``. If null, uses the default viewport instead. The custom :ref:`Viewport<class_Viewport>` node assigned to the ``CanvasLayer``. If null, uses the default viewport instead.
----
.. _class_CanvasLayer_property_layer: .. _class_CanvasLayer_property_layer:
- :ref:`int<class_int>` **layer** - :ref:`int<class_int>` **layer**
@@ -85,6 +87,8 @@ The custom :ref:`Viewport<class_Viewport>` node assigned to the ``CanvasLayer``.
Layer index for draw order. Lower values are drawn first. Default value: ``1``. Layer index for draw order. Lower values are drawn first. Default value: ``1``.
----
.. _class_CanvasLayer_property_offset: .. _class_CanvasLayer_property_offset:
- :ref:`Vector2<class_Vector2>` **offset** - :ref:`Vector2<class_Vector2>` **offset**
@@ -97,6 +101,8 @@ Layer index for draw order. Lower values are drawn first. Default value: ``1``.
The layer's base offset. The layer's base offset.
----
.. _class_CanvasLayer_property_rotation: .. _class_CanvasLayer_property_rotation:
- :ref:`float<class_float>` **rotation** - :ref:`float<class_float>` **rotation**
@@ -109,6 +115,8 @@ The layer's base offset.
The layer's rotation in radians. The layer's rotation in radians.
----
.. _class_CanvasLayer_property_rotation_degrees: .. _class_CanvasLayer_property_rotation_degrees:
- :ref:`float<class_float>` **rotation_degrees** - :ref:`float<class_float>` **rotation_degrees**
@@ -121,6 +129,8 @@ The layer's rotation in radians.
The layer's rotation in degrees. The layer's rotation in degrees.
----
.. _class_CanvasLayer_property_scale: .. _class_CanvasLayer_property_scale:
- :ref:`Vector2<class_Vector2>` **scale** - :ref:`Vector2<class_Vector2>` **scale**
@@ -133,6 +143,8 @@ The layer's rotation in degrees.
The layer's scale. The layer's scale.
----
.. _class_CanvasLayer_property_transform: .. _class_CanvasLayer_property_transform:
- :ref:`Transform2D<class_Transform2D>` **transform** - :ref:`Transform2D<class_Transform2D>` **transform**

6
classes/class_capsulemesh.rst
View File

@@ -51,6 +51,8 @@ Property Descriptions
Height of the capsule mesh from the center point. Defaults to 1.0. Height of the capsule mesh from the center point. Defaults to 1.0.
----
.. _class_CapsuleMesh_property_radial_segments: .. _class_CapsuleMesh_property_radial_segments:
- :ref:`int<class_int>` **radial_segments** - :ref:`int<class_int>` **radial_segments**
@@ -63,6 +65,8 @@ Height of the capsule mesh from the center point. Defaults to 1.0.
Number of radial segments on the capsule mesh. Defaults to 64. Number of radial segments on the capsule mesh. Defaults to 64.
----
.. _class_CapsuleMesh_property_radius: .. _class_CapsuleMesh_property_radius:
- :ref:`float<class_float>` **radius** - :ref:`float<class_float>` **radius**
@@ -75,6 +79,8 @@ Number of radial segments on the capsule mesh. Defaults to 64.
Radius of the capsule mesh. Defaults to 1.0. Radius of the capsule mesh. Defaults to 1.0.
----
.. _class_CapsuleMesh_property_rings: .. _class_CapsuleMesh_property_rings:
- :ref:`int<class_int>` **rings** - :ref:`int<class_int>` **rings**

2
classes/class_capsuleshape.rst
View File

@@ -47,6 +47,8 @@ Property Descriptions
The capsule's height. The capsule's height.
----
.. _class_CapsuleShape_property_radius: .. _class_CapsuleShape_property_radius:
- :ref:`float<class_float>` **radius** - :ref:`float<class_float>` **radius**

2
classes/class_capsuleshape2d.rst
View File

@@ -47,6 +47,8 @@ Property Descriptions
The capsule's height. The capsule's height.
----
.. _class_CapsuleShape2D_property_radius: .. _class_CapsuleShape2D_property_radius:
- :ref:`float<class_float>` **radius** - :ref:`float<class_float>` **radius**

38
classes/class_classdb.rst
View File

@@ -77,114 +77,152 @@ Method Descriptions
Returns ``true`` if you can instance objects from the specified 'class', ``false`` in other case. Returns ``true`` if you can instance objects from the specified 'class', ``false`` in other case.
----
.. _class_ClassDB_method_class_exists: .. _class_ClassDB_method_class_exists:
- :ref:`bool<class_bool>` **class_exists** **(** :ref:`String<class_String>` class **)** const - :ref:`bool<class_bool>` **class_exists** **(** :ref:`String<class_String>` class **)** const
Returns whether the specified 'class' is available or not. Returns whether the specified 'class' is available or not.
----
.. _class_ClassDB_method_class_get_category: .. _class_ClassDB_method_class_get_category:
- :ref:`String<class_String>` **class_get_category** **(** :ref:`String<class_String>` class **)** const - :ref:`String<class_String>` **class_get_category** **(** :ref:`String<class_String>` class **)** const
Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required. Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required.
----
.. _class_ClassDB_method_class_get_integer_constant: .. _class_ClassDB_method_class_get_integer_constant:
- :ref:`int<class_int>` **class_get_integer_constant** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name **)** const - :ref:`int<class_int>` **class_get_integer_constant** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name **)** const
Returns the value of the integer constant 'name' of 'class' or its ancestry. Always returns 0 when the constant could not be found. Returns the value of the integer constant 'name' of 'class' or its ancestry. Always returns 0 when the constant could not be found.
----
.. _class_ClassDB_method_class_get_integer_constant_list: .. _class_ClassDB_method_class_get_integer_constant_list:
- :ref:`PoolStringArray<class_PoolStringArray>` **class_get_integer_constant_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const - :ref:`PoolStringArray<class_PoolStringArray>` **class_get_integer_constant_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
Returns an array with the names all the integer constants of 'class' or its ancestry. Returns an array with the names all the integer constants of 'class' or its ancestry.
----
.. _class_ClassDB_method_class_get_method_list: .. _class_ClassDB_method_class_get_method_list:
- :ref:`Array<class_Array>` **class_get_method_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const - :ref:`Array<class_Array>` **class_get_method_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
Returns an array with all the methods of 'class' or its ancestry if 'no_inheritance' is ``false``. Every element of the array is a :ref:`Dictionary<class_Dictionary>` with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage). Returns an array with all the methods of 'class' or its ancestry if 'no_inheritance' is ``false``. Every element of the array is a :ref:`Dictionary<class_Dictionary>` with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage).
----
.. _class_ClassDB_method_class_get_property: .. _class_ClassDB_method_class_get_property:
- :ref:`Variant<class_Variant>` **class_get_property** **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property **)** const - :ref:`Variant<class_Variant>` **class_get_property** **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property **)** const
Returns the value of 'property' of 'class' or its ancestry. Returns the value of 'property' of 'class' or its ancestry.
----
.. _class_ClassDB_method_class_get_property_list: .. _class_ClassDB_method_class_get_property_list:
- :ref:`Array<class_Array>` **class_get_property_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const - :ref:`Array<class_Array>` **class_get_property_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
Returns an array with all the properties of 'class' or its ancestry if 'no_inheritance' is ``false``. Returns an array with all the properties of 'class' or its ancestry if 'no_inheritance' is ``false``.
----
.. _class_ClassDB_method_class_get_signal: .. _class_ClassDB_method_class_get_signal:
- :ref:`Dictionary<class_Dictionary>` **class_get_signal** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` signal **)** const - :ref:`Dictionary<class_Dictionary>` **class_get_signal** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` signal **)** const
Returns the 'signal' data of 'class' or its ancestry. The returned value is a :ref:`Dictionary<class_Dictionary>` with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage). Returns the 'signal' data of 'class' or its ancestry. The returned value is a :ref:`Dictionary<class_Dictionary>` with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage).
----
.. _class_ClassDB_method_class_get_signal_list: .. _class_ClassDB_method_class_get_signal_list:
- :ref:`Array<class_Array>` **class_get_signal_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const - :ref:`Array<class_Array>` **class_get_signal_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is ``false``. Every element of the array is a :ref:`Dictionary<class_Dictionary>` as described in :ref:`class_get_signal<class_ClassDB_method_class_get_signal>`. Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is ``false``. Every element of the array is a :ref:`Dictionary<class_Dictionary>` as described in :ref:`class_get_signal<class_ClassDB_method_class_get_signal>`.
----
.. _class_ClassDB_method_class_has_integer_constant: .. _class_ClassDB_method_class_has_integer_constant:
- :ref:`bool<class_bool>` **class_has_integer_constant** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name **)** const - :ref:`bool<class_bool>` **class_has_integer_constant** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name **)** const
Returns whether 'class' or its ancestry has an integer constant called 'name' or not. Returns whether 'class' or its ancestry has an integer constant called 'name' or not.
----
.. _class_ClassDB_method_class_has_method: .. _class_ClassDB_method_class_has_method:
- :ref:`bool<class_bool>` **class_has_method** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` method, :ref:`bool<class_bool>` no_inheritance=false **)** const - :ref:`bool<class_bool>` **class_has_method** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` method, :ref:`bool<class_bool>` no_inheritance=false **)** const
Returns whether 'class' (or its ancestry if 'no_inheritance' is false) has a method called 'method' or not. Returns whether 'class' (or its ancestry if 'no_inheritance' is false) has a method called 'method' or not.
----
.. _class_ClassDB_method_class_has_signal: .. _class_ClassDB_method_class_has_signal:
- :ref:`bool<class_bool>` **class_has_signal** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` signal **)** const - :ref:`bool<class_bool>` **class_has_signal** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` signal **)** const
Returns whether 'class' or its ancestry has a signal called 'signal' or not. Returns whether 'class' or its ancestry has a signal called 'signal' or not.
----
.. _class_ClassDB_method_class_set_property: .. _class_ClassDB_method_class_set_property:
- :ref:`Error<enum_@GlobalScope_Error>` **class_set_property** **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value **)** const - :ref:`Error<enum_@GlobalScope_Error>` **class_set_property** **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value **)** const
Sets 'property' value of 'class' to 'value'. Sets 'property' value of 'class' to 'value'.
----
.. _class_ClassDB_method_get_class_list: .. _class_ClassDB_method_get_class_list:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_class_list** **(** **)** const - :ref:`PoolStringArray<class_PoolStringArray>` **get_class_list** **(** **)** const
Returns the names of all the classes available. Returns the names of all the classes available.
----
.. _class_ClassDB_method_get_inheriters_from_class: .. _class_ClassDB_method_get_inheriters_from_class:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_inheriters_from_class** **(** :ref:`String<class_String>` class **)** const - :ref:`PoolStringArray<class_PoolStringArray>` **get_inheriters_from_class** **(** :ref:`String<class_String>` class **)** const
Returns the names of all the classes that directly or indirectly inherit from 'class'. Returns the names of all the classes that directly or indirectly inherit from 'class'.
----
.. _class_ClassDB_method_get_parent_class: .. _class_ClassDB_method_get_parent_class:
- :ref:`String<class_String>` **get_parent_class** **(** :ref:`String<class_String>` class **)** const - :ref:`String<class_String>` **get_parent_class** **(** :ref:`String<class_String>` class **)** const
Returns the parent class of 'class'. Returns the parent class of 'class'.
----
.. _class_ClassDB_method_instance: .. _class_ClassDB_method_instance:
- :ref:`Variant<class_Variant>` **instance** **(** :ref:`String<class_String>` class **)** const - :ref:`Variant<class_Variant>` **instance** **(** :ref:`String<class_String>` class **)** const
Creates an instance of 'class'. Creates an instance of 'class'.
----
.. _class_ClassDB_method_is_class_enabled: .. _class_ClassDB_method_is_class_enabled:
- :ref:`bool<class_bool>` **is_class_enabled** **(** :ref:`String<class_String>` class **)** const - :ref:`bool<class_bool>` **is_class_enabled** **(** :ref:`String<class_String>` class **)** const
Returns whether this class is enabled or not. Returns whether this class is enabled or not.
----
.. _class_ClassDB_method_is_parent_class: .. _class_ClassDB_method_is_parent_class:
- :ref:`bool<class_bool>` **is_parent_class** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` inherits **)** const - :ref:`bool<class_bool>` **is_parent_class** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` inherits **)** const

20
classes/class_clippedcamera.rst
View File

@@ -80,6 +80,8 @@ Property Descriptions
| *Getter* | is_clip_to_areas_enabled() | | *Getter* | is_clip_to_areas_enabled() |
+----------+----------------------------+ +----------+----------------------------+
----
.. _class_ClippedCamera_property_clip_to_bodies: .. _class_ClippedCamera_property_clip_to_bodies:
- :ref:`bool<class_bool>` **clip_to_bodies** - :ref:`bool<class_bool>` **clip_to_bodies**
@@ -90,6 +92,8 @@ Property Descriptions
| *Getter* | is_clip_to_bodies_enabled() | | *Getter* | is_clip_to_bodies_enabled() |
+----------+-----------------------------+ +----------+-----------------------------+
----
.. _class_ClippedCamera_property_collision_mask: .. _class_ClippedCamera_property_collision_mask:
- :ref:`int<class_int>` **collision_mask** - :ref:`int<class_int>` **collision_mask**
@@ -100,6 +104,8 @@ Property Descriptions
| *Getter* | get_collision_mask() | | *Getter* | get_collision_mask() |
+----------+---------------------------+ +----------+---------------------------+
----
.. _class_ClippedCamera_property_margin: .. _class_ClippedCamera_property_margin:
- :ref:`float<class_float>` **margin** - :ref:`float<class_float>` **margin**
@@ -110,6 +116,8 @@ Property Descriptions
| *Getter* | get_margin() | | *Getter* | get_margin() |
+----------+-------------------+ +----------+-------------------+
----
.. _class_ClippedCamera_property_process_mode: .. _class_ClippedCamera_property_process_mode:
- :ref:`ProcessMode<enum_ClippedCamera_ProcessMode>` **process_mode** - :ref:`ProcessMode<enum_ClippedCamera_ProcessMode>` **process_mode**
@@ -127,26 +135,38 @@ Method Descriptions
- void **add_exception** **(** :ref:`Object<class_Object>` node **)** - void **add_exception** **(** :ref:`Object<class_Object>` node **)**
----
.. _class_ClippedCamera_method_add_exception_rid: .. _class_ClippedCamera_method_add_exception_rid:
- void **add_exception_rid** **(** :ref:`RID<class_RID>` rid **)** - void **add_exception_rid** **(** :ref:`RID<class_RID>` rid **)**
----
.. _class_ClippedCamera_method_clear_exceptions: .. _class_ClippedCamera_method_clear_exceptions:
- void **clear_exceptions** **(** **)** - void **clear_exceptions** **(** **)**
----
.. _class_ClippedCamera_method_get_collision_mask_bit: .. _class_ClippedCamera_method_get_collision_mask_bit:
- :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const - :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const
----
.. _class_ClippedCamera_method_remove_exception: .. _class_ClippedCamera_method_remove_exception:
- void **remove_exception** **(** :ref:`Object<class_Object>` node **)** - void **remove_exception** **(** :ref:`Object<class_Object>` node **)**
----
.. _class_ClippedCamera_method_remove_exception_rid: .. _class_ClippedCamera_method_remove_exception_rid:
- void **remove_exception_rid** **(** :ref:`RID<class_RID>` rid **)** - void **remove_exception_rid** **(** :ref:`RID<class_RID>` rid **)**
----
.. _class_ClippedCamera_method_set_collision_mask_bit: .. _class_ClippedCamera_method_set_collision_mask_bit:
- void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** - void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**

38
classes/class_collisionobject.rst
View File

@@ -77,12 +77,16 @@ Signals
Emitted when :ref:`_input_event<class_CollisionObject_method__input_event>` receives an event. See its description for details. Emitted when :ref:`_input_event<class_CollisionObject_method__input_event>` receives an event. See its description for details.
----
.. _class_CollisionObject_signal_mouse_entered: .. _class_CollisionObject_signal_mouse_entered:
- **mouse_entered** **(** **)** - **mouse_entered** **(** **)**
Emitted when the mouse pointer enters any of this object's shapes. Emitted when the mouse pointer enters any of this object's shapes.
----
.. _class_CollisionObject_signal_mouse_exited: .. _class_CollisionObject_signal_mouse_exited:
- **mouse_exited** **(** **)** - **mouse_exited** **(** **)**
@@ -109,6 +113,8 @@ Property Descriptions
If ``true``, the ``CollisionObject`` will continue to receive input events as the mouse is dragged across its shapes. Default value: ``false``. If ``true``, the ``CollisionObject`` will continue to receive input events as the mouse is dragged across its shapes. Default value: ``false``.
----
.. _class_CollisionObject_property_input_ray_pickable: .. _class_CollisionObject_property_input_ray_pickable:
- :ref:`bool<class_bool>` **input_ray_pickable** - :ref:`bool<class_bool>` **input_ray_pickable**
@@ -130,96 +136,128 @@ Method Descriptions
Accepts unhandled :ref:`InputEvent<class_InputEvent>`\ s. ``click_position`` is the clicked location in world space and ``click_normal`` is the normal vector extending from the clicked surface of the :ref:`Shape<class_Shape>` at ``shape_idx``. Connect to the ``input_event`` signal to easily pick up these events. Accepts unhandled :ref:`InputEvent<class_InputEvent>`\ s. ``click_position`` is the clicked location in world space and ``click_normal`` is the normal vector extending from the clicked surface of the :ref:`Shape<class_Shape>` at ``shape_idx``. Connect to the ``input_event`` signal to easily pick up these events.
----
.. _class_CollisionObject_method_create_shape_owner: .. _class_CollisionObject_method_create_shape_owner:
- :ref:`int<class_int>` **create_shape_owner** **(** :ref:`Object<class_Object>` owner **)** - :ref:`int<class_int>` **create_shape_owner** **(** :ref:`Object<class_Object>` owner **)**
Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference. Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference.
----
.. _class_CollisionObject_method_get_rid: .. _class_CollisionObject_method_get_rid:
- :ref:`RID<class_RID>` **get_rid** **(** **)** const - :ref:`RID<class_RID>` **get_rid** **(** **)** const
Returns the object's :ref:`RID<class_RID>`. Returns the object's :ref:`RID<class_RID>`.
----
.. _class_CollisionObject_method_get_shape_owners: .. _class_CollisionObject_method_get_shape_owners:
- :ref:`Array<class_Array>` **get_shape_owners** **(** **)** - :ref:`Array<class_Array>` **get_shape_owners** **(** **)**
Returns an :ref:`Array<class_Array>` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument. Returns an :ref:`Array<class_Array>` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument.
----
.. _class_CollisionObject_method_is_shape_owner_disabled: .. _class_CollisionObject_method_is_shape_owner_disabled:
- :ref:`bool<class_bool>` **is_shape_owner_disabled** **(** :ref:`int<class_int>` owner_id **)** const - :ref:`bool<class_bool>` **is_shape_owner_disabled** **(** :ref:`int<class_int>` owner_id **)** const
If ``true``, the shape owner and its shapes are disabled. If ``true``, the shape owner and its shapes are disabled.
----
.. _class_CollisionObject_method_remove_shape_owner: .. _class_CollisionObject_method_remove_shape_owner:
- void **remove_shape_owner** **(** :ref:`int<class_int>` owner_id **)** - void **remove_shape_owner** **(** :ref:`int<class_int>` owner_id **)**
Removes the given shape owner. Removes the given shape owner.
----
.. _class_CollisionObject_method_shape_find_owner: .. _class_CollisionObject_method_shape_find_owner:
- :ref:`int<class_int>` **shape_find_owner** **(** :ref:`int<class_int>` shape_index **)** const - :ref:`int<class_int>` **shape_find_owner** **(** :ref:`int<class_int>` shape_index **)** const
Returns the ``owner_id`` of the given shape. Returns the ``owner_id`` of the given shape.
----
.. _class_CollisionObject_method_shape_owner_add_shape: .. _class_CollisionObject_method_shape_owner_add_shape:
- void **shape_owner_add_shape** **(** :ref:`int<class_int>` owner_id, :ref:`Shape<class_Shape>` shape **)** - void **shape_owner_add_shape** **(** :ref:`int<class_int>` owner_id, :ref:`Shape<class_Shape>` shape **)**
Adds a :ref:`Shape<class_Shape>` to the shape owner. Adds a :ref:`Shape<class_Shape>` to the shape owner.
----
.. _class_CollisionObject_method_shape_owner_clear_shapes: .. _class_CollisionObject_method_shape_owner_clear_shapes:
- void **shape_owner_clear_shapes** **(** :ref:`int<class_int>` owner_id **)** - void **shape_owner_clear_shapes** **(** :ref:`int<class_int>` owner_id **)**
Removes all shapes from the shape owner. Removes all shapes from the shape owner.
----
.. _class_CollisionObject_method_shape_owner_get_owner: .. _class_CollisionObject_method_shape_owner_get_owner:
- :ref:`Object<class_Object>` **shape_owner_get_owner** **(** :ref:`int<class_int>` owner_id **)** const - :ref:`Object<class_Object>` **shape_owner_get_owner** **(** :ref:`int<class_int>` owner_id **)** const
Returns the parent object of the given shape owner. Returns the parent object of the given shape owner.
----
.. _class_CollisionObject_method_shape_owner_get_shape: .. _class_CollisionObject_method_shape_owner_get_shape:
- :ref:`Shape<class_Shape>` **shape_owner_get_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const - :ref:`Shape<class_Shape>` **shape_owner_get_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const
Returns the :ref:`Shape<class_Shape>` with the given id from the given shape owner. Returns the :ref:`Shape<class_Shape>` with the given id from the given shape owner.
----
.. _class_CollisionObject_method_shape_owner_get_shape_count: .. _class_CollisionObject_method_shape_owner_get_shape_count:
- :ref:`int<class_int>` **shape_owner_get_shape_count** **(** :ref:`int<class_int>` owner_id **)** const - :ref:`int<class_int>` **shape_owner_get_shape_count** **(** :ref:`int<class_int>` owner_id **)** const
Returns the number of shapes the given shape owner contains. Returns the number of shapes the given shape owner contains.
----
.. _class_CollisionObject_method_shape_owner_get_shape_index: .. _class_CollisionObject_method_shape_owner_get_shape_index:
- :ref:`int<class_int>` **shape_owner_get_shape_index** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const - :ref:`int<class_int>` **shape_owner_get_shape_index** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const
Returns the child index of the :ref:`Shape<class_Shape>` with the given id from the given shape owner. Returns the child index of the :ref:`Shape<class_Shape>` with the given id from the given shape owner.
----
.. _class_CollisionObject_method_shape_owner_get_transform: .. _class_CollisionObject_method_shape_owner_get_transform:
- :ref:`Transform<class_Transform>` **shape_owner_get_transform** **(** :ref:`int<class_int>` owner_id **)** const - :ref:`Transform<class_Transform>` **shape_owner_get_transform** **(** :ref:`int<class_int>` owner_id **)** const
Returns the shape owner's :ref:`Transform<class_Transform>`. Returns the shape owner's :ref:`Transform<class_Transform>`.
----
.. _class_CollisionObject_method_shape_owner_remove_shape: .. _class_CollisionObject_method_shape_owner_remove_shape:
- void **shape_owner_remove_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** - void **shape_owner_remove_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)**
Removes a shape from the given shape owner. Removes a shape from the given shape owner.
----
.. _class_CollisionObject_method_shape_owner_set_disabled: .. _class_CollisionObject_method_shape_owner_set_disabled:
- void **shape_owner_set_disabled** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)** - void **shape_owner_set_disabled** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)**
If ``true``, disables the given shape owner. If ``true``, disables the given shape owner.
----
.. _class_CollisionObject_method_shape_owner_set_transform: .. _class_CollisionObject_method_shape_owner_set_transform:
- void **shape_owner_set_transform** **(** :ref:`int<class_int>` owner_id, :ref:`Transform<class_Transform>` transform **)** - void **shape_owner_set_transform** **(** :ref:`int<class_int>` owner_id, :ref:`Transform<class_Transform>` transform **)**

44
classes/class_collisionobject2d.rst
View File

@@ -83,12 +83,16 @@ Signals
Emitted when an input event occurs. Requires :ref:`input_pickable<class_CollisionObject2D_property_input_pickable>` to be ``true`` and at least one ``collision_layer`` bit to be set. See :ref:`_input_event<class_CollisionObject2D_method__input_event>` for details. Emitted when an input event occurs. Requires :ref:`input_pickable<class_CollisionObject2D_property_input_pickable>` to be ``true`` and at least one ``collision_layer`` bit to be set. See :ref:`_input_event<class_CollisionObject2D_method__input_event>` for details.
----
.. _class_CollisionObject2D_signal_mouse_entered: .. _class_CollisionObject2D_signal_mouse_entered:
- **mouse_entered** **(** **)** - **mouse_entered** **(** **)**
Emitted when the mouse pointer enters any of this object's shapes. Requires :ref:`input_pickable<class_CollisionObject2D_property_input_pickable>` to be ``true`` and at least one ``collision_layer`` bit to be set. Emitted when the mouse pointer enters any of this object's shapes. Requires :ref:`input_pickable<class_CollisionObject2D_property_input_pickable>` to be ``true`` and at least one ``collision_layer`` bit to be set.
----
.. _class_CollisionObject2D_signal_mouse_exited: .. _class_CollisionObject2D_signal_mouse_exited:
- **mouse_exited** **(** **)** - **mouse_exited** **(** **)**
@@ -124,116 +128,156 @@ Method Descriptions
Accepts unhandled :ref:`InputEvent<class_InputEvent>`\ s. Requires :ref:`input_pickable<class_CollisionObject2D_property_input_pickable>` to be ``true``. ``shape_idx`` is the child index of the clicked :ref:`Shape2D<class_Shape2D>`. Connect to the ``input_event`` signal to easily pick up these events. Accepts unhandled :ref:`InputEvent<class_InputEvent>`\ s. Requires :ref:`input_pickable<class_CollisionObject2D_property_input_pickable>` to be ``true``. ``shape_idx`` is the child index of the clicked :ref:`Shape2D<class_Shape2D>`. Connect to the ``input_event`` signal to easily pick up these events.
----
.. _class_CollisionObject2D_method_create_shape_owner: .. _class_CollisionObject2D_method_create_shape_owner:
- :ref:`int<class_int>` **create_shape_owner** **(** :ref:`Object<class_Object>` owner **)** - :ref:`int<class_int>` **create_shape_owner** **(** :ref:`Object<class_Object>` owner **)**
Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference. Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference.
----
.. _class_CollisionObject2D_method_get_rid: .. _class_CollisionObject2D_method_get_rid:
- :ref:`RID<class_RID>` **get_rid** **(** **)** const - :ref:`RID<class_RID>` **get_rid** **(** **)** const
Returns the object's :ref:`RID<class_RID>`. Returns the object's :ref:`RID<class_RID>`.
----
.. _class_CollisionObject2D_method_get_shape_owner_one_way_collision_margin: .. _class_CollisionObject2D_method_get_shape_owner_one_way_collision_margin:
- :ref:`float<class_float>` **get_shape_owner_one_way_collision_margin** **(** :ref:`int<class_int>` owner_id **)** const - :ref:`float<class_float>` **get_shape_owner_one_way_collision_margin** **(** :ref:`int<class_int>` owner_id **)** const
----
.. _class_CollisionObject2D_method_get_shape_owners: .. _class_CollisionObject2D_method_get_shape_owners:
- :ref:`Array<class_Array>` **get_shape_owners** **(** **)** - :ref:`Array<class_Array>` **get_shape_owners** **(** **)**
Returns an :ref:`Array<class_Array>` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument. Returns an :ref:`Array<class_Array>` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument.
----
.. _class_CollisionObject2D_method_is_shape_owner_disabled: .. _class_CollisionObject2D_method_is_shape_owner_disabled:
- :ref:`bool<class_bool>` **is_shape_owner_disabled** **(** :ref:`int<class_int>` owner_id **)** const - :ref:`bool<class_bool>` **is_shape_owner_disabled** **(** :ref:`int<class_int>` owner_id **)** const
If ``true``, the shape owner and its shapes are disabled. If ``true``, the shape owner and its shapes are disabled.
----
.. _class_CollisionObject2D_method_is_shape_owner_one_way_collision_enabled: .. _class_CollisionObject2D_method_is_shape_owner_one_way_collision_enabled:
- :ref:`bool<class_bool>` **is_shape_owner_one_way_collision_enabled** **(** :ref:`int<class_int>` owner_id **)** const - :ref:`bool<class_bool>` **is_shape_owner_one_way_collision_enabled** **(** :ref:`int<class_int>` owner_id **)** const
Returns ``true`` if collisions for the shape owner originating from this ``CollisionObject2D`` will not be reported to collided with ``CollisionObject2D``\ s. Returns ``true`` if collisions for the shape owner originating from this ``CollisionObject2D`` will not be reported to collided with ``CollisionObject2D``\ s.
----
.. _class_CollisionObject2D_method_remove_shape_owner: .. _class_CollisionObject2D_method_remove_shape_owner:
- void **remove_shape_owner** **(** :ref:`int<class_int>` owner_id **)** - void **remove_shape_owner** **(** :ref:`int<class_int>` owner_id **)**
Removes the given shape owner. Removes the given shape owner.
----
.. _class_CollisionObject2D_method_shape_find_owner: .. _class_CollisionObject2D_method_shape_find_owner:
- :ref:`int<class_int>` **shape_find_owner** **(** :ref:`int<class_int>` shape_index **)** const - :ref:`int<class_int>` **shape_find_owner** **(** :ref:`int<class_int>` shape_index **)** const
Returns the ``owner_id`` of the given shape. Returns the ``owner_id`` of the given shape.
----
.. _class_CollisionObject2D_method_shape_owner_add_shape: .. _class_CollisionObject2D_method_shape_owner_add_shape:
- void **shape_owner_add_shape** **(** :ref:`int<class_int>` owner_id, :ref:`Shape2D<class_Shape2D>` shape **)** - void **shape_owner_add_shape** **(** :ref:`int<class_int>` owner_id, :ref:`Shape2D<class_Shape2D>` shape **)**
Adds a :ref:`Shape2D<class_Shape2D>` to the shape owner. Adds a :ref:`Shape2D<class_Shape2D>` to the shape owner.
----
.. _class_CollisionObject2D_method_shape_owner_clear_shapes: .. _class_CollisionObject2D_method_shape_owner_clear_shapes:
- void **shape_owner_clear_shapes** **(** :ref:`int<class_int>` owner_id **)** - void **shape_owner_clear_shapes** **(** :ref:`int<class_int>` owner_id **)**
Removes all shapes from the shape owner. Removes all shapes from the shape owner.
----
.. _class_CollisionObject2D_method_shape_owner_get_owner: .. _class_CollisionObject2D_method_shape_owner_get_owner:
- :ref:`Object<class_Object>` **shape_owner_get_owner** **(** :ref:`int<class_int>` owner_id **)** const - :ref:`Object<class_Object>` **shape_owner_get_owner** **(** :ref:`int<class_int>` owner_id **)** const
Returns the parent object of the given shape owner. Returns the parent object of the given shape owner.
----
.. _class_CollisionObject2D_method_shape_owner_get_shape: .. _class_CollisionObject2D_method_shape_owner_get_shape:
- :ref:`Shape2D<class_Shape2D>` **shape_owner_get_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const - :ref:`Shape2D<class_Shape2D>` **shape_owner_get_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const
Returns the :ref:`Shape2D<class_Shape2D>` with the given id from the given shape owner. Returns the :ref:`Shape2D<class_Shape2D>` with the given id from the given shape owner.
----
.. _class_CollisionObject2D_method_shape_owner_get_shape_count: .. _class_CollisionObject2D_method_shape_owner_get_shape_count:
- :ref:`int<class_int>` **shape_owner_get_shape_count** **(** :ref:`int<class_int>` owner_id **)** const - :ref:`int<class_int>` **shape_owner_get_shape_count** **(** :ref:`int<class_int>` owner_id **)** const
Returns the number of shapes the given shape owner contains. Returns the number of shapes the given shape owner contains.
----
.. _class_CollisionObject2D_method_shape_owner_get_shape_index: .. _class_CollisionObject2D_method_shape_owner_get_shape_index:
- :ref:`int<class_int>` **shape_owner_get_shape_index** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const - :ref:`int<class_int>` **shape_owner_get_shape_index** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const
Returns the child index of the :ref:`Shape2D<class_Shape2D>` with the given id from the given shape owner. Returns the child index of the :ref:`Shape2D<class_Shape2D>` with the given id from the given shape owner.
----
.. _class_CollisionObject2D_method_shape_owner_get_transform: .. _class_CollisionObject2D_method_shape_owner_get_transform:
- :ref:`Transform2D<class_Transform2D>` **shape_owner_get_transform** **(** :ref:`int<class_int>` owner_id **)** const - :ref:`Transform2D<class_Transform2D>` **shape_owner_get_transform** **(** :ref:`int<class_int>` owner_id **)** const
Returns the shape owner's :ref:`Transform2D<class_Transform2D>`. Returns the shape owner's :ref:`Transform2D<class_Transform2D>`.
----
.. _class_CollisionObject2D_method_shape_owner_remove_shape: .. _class_CollisionObject2D_method_shape_owner_remove_shape:
- void **shape_owner_remove_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** - void **shape_owner_remove_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)**
Removes a shape from the given shape owner. Removes a shape from the given shape owner.
----
.. _class_CollisionObject2D_method_shape_owner_set_disabled: .. _class_CollisionObject2D_method_shape_owner_set_disabled:
- void **shape_owner_set_disabled** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)** - void **shape_owner_set_disabled** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)**
If ``true``, disables the given shape owner. If ``true``, disables the given shape owner.
----
.. _class_CollisionObject2D_method_shape_owner_set_one_way_collision: .. _class_CollisionObject2D_method_shape_owner_set_one_way_collision:
- void **shape_owner_set_one_way_collision** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` enable **)** - void **shape_owner_set_one_way_collision** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` enable **)**
If ``enable`` is ``true``, collisions for the shape owner originating from this ``CollisionObject2D`` will not be reported to collided with ``CollisionObject2D``\ s. If ``enable`` is ``true``, collisions for the shape owner originating from this ``CollisionObject2D`` will not be reported to collided with ``CollisionObject2D``\ s.
----
.. _class_CollisionObject2D_method_shape_owner_set_one_way_collision_margin: .. _class_CollisionObject2D_method_shape_owner_set_one_way_collision_margin:
- void **shape_owner_set_one_way_collision_margin** **(** :ref:`int<class_int>` owner_id, :ref:`float<class_float>` margin **)** - void **shape_owner_set_one_way_collision_margin** **(** :ref:`int<class_int>` owner_id, :ref:`float<class_float>` margin **)**
----
.. _class_CollisionObject2D_method_shape_owner_set_transform: .. _class_CollisionObject2D_method_shape_owner_set_transform:
- void **shape_owner_set_transform** **(** :ref:`int<class_int>` owner_id, :ref:`Transform2D<class_Transform2D>` transform **)** - void **shape_owner_set_transform** **(** :ref:`int<class_int>` owner_id, :ref:`Transform2D<class_Transform2D>` transform **)**

4
classes/class_collisionpolygon.rst
View File

@@ -49,6 +49,8 @@ Property Descriptions
Length that the resulting collision extends in either direction perpendicular to its polygon. Length that the resulting collision extends in either direction perpendicular to its polygon.
----
.. _class_CollisionPolygon_property_disabled: .. _class_CollisionPolygon_property_disabled:
- :ref:`bool<class_bool>` **disabled** - :ref:`bool<class_bool>` **disabled**
@@ -61,6 +63,8 @@ Length that the resulting collision extends in either direction perpendicular to
If ``true``, no collision will be produced. If ``true``, no collision will be produced.
----
.. _class_CollisionPolygon_property_polygon: .. _class_CollisionPolygon_property_polygon:
- :ref:`PoolVector2Array<class_PoolVector2Array>` **polygon** - :ref:`PoolVector2Array<class_PoolVector2Array>` **polygon**

8
classes/class_collisionpolygon2d.rst
View File

@@ -68,6 +68,8 @@ Property Descriptions
Collision build mode. Use one of the ``BUILD_*`` constants. Default value: :ref:`BUILD_SOLIDS<class_CollisionPolygon2D_constant_BUILD_SOLIDS>`. Collision build mode. Use one of the ``BUILD_*`` constants. Default value: :ref:`BUILD_SOLIDS<class_CollisionPolygon2D_constant_BUILD_SOLIDS>`.
----
.. _class_CollisionPolygon2D_property_disabled: .. _class_CollisionPolygon2D_property_disabled:
- :ref:`bool<class_bool>` **disabled** - :ref:`bool<class_bool>` **disabled**
@@ -80,6 +82,8 @@ Collision build mode. Use one of the ``BUILD_*`` constants. Default value: :ref:
If ``true``, no collisions will be detected. If ``true``, no collisions will be detected.
----
.. _class_CollisionPolygon2D_property_one_way_collision: .. _class_CollisionPolygon2D_property_one_way_collision:
- :ref:`bool<class_bool>` **one_way_collision** - :ref:`bool<class_bool>` **one_way_collision**
@@ -92,6 +96,8 @@ If ``true``, no collisions will be detected.
If ``true``, only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects. If ``true``, only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects.
----
.. _class_CollisionPolygon2D_property_one_way_collision_margin: .. _class_CollisionPolygon2D_property_one_way_collision_margin:
- :ref:`float<class_float>` **one_way_collision_margin** - :ref:`float<class_float>` **one_way_collision_margin**
@@ -102,6 +108,8 @@ If ``true``, only edges that face up, relative to CollisionPolygon2D's rotation,
| *Getter* | get_one_way_collision_margin() | | *Getter* | get_one_way_collision_margin() |
+----------+-------------------------------------+ +----------+-------------------------------------+
----
.. _class_CollisionPolygon2D_property_polygon: .. _class_CollisionPolygon2D_property_polygon:
- :ref:`PoolVector2Array<class_PoolVector2Array>` **polygon** - :ref:`PoolVector2Array<class_PoolVector2Array>` **polygon**

4
classes/class_collisionshape.rst
View File

@@ -61,6 +61,8 @@ Property Descriptions
A disabled collision shape has no effect in the world. A disabled collision shape has no effect in the world.
----
.. _class_CollisionShape_property_shape: .. _class_CollisionShape_property_shape:
- :ref:`Shape<class_Shape>` **shape** - :ref:`Shape<class_Shape>` **shape**
@@ -82,6 +84,8 @@ Method Descriptions
Sets the collision shape's shape to the addition of all its convexed :ref:`MeshInstance<class_MeshInstance>` siblings geometry. Sets the collision shape's shape to the addition of all its convexed :ref:`MeshInstance<class_MeshInstance>` siblings geometry.
----
.. _class_CollisionShape_method_resource_changed: .. _class_CollisionShape_method_resource_changed:
- void **resource_changed** **(** :ref:`Resource<class_Resource>` resource **)** - void **resource_changed** **(** :ref:`Resource<class_Resource>` resource **)**

6
classes/class_collisionshape2d.rst
View File

@@ -56,6 +56,8 @@ Property Descriptions
A disabled collision shape has no effect in the world. A disabled collision shape has no effect in the world.
----
.. _class_CollisionShape2D_property_one_way_collision: .. _class_CollisionShape2D_property_one_way_collision:
- :ref:`bool<class_bool>` **one_way_collision** - :ref:`bool<class_bool>` **one_way_collision**
@@ -68,6 +70,8 @@ A disabled collision shape has no effect in the world.
Sets whether this collision shape should only detect collision on one side (top or bottom). Sets whether this collision shape should only detect collision on one side (top or bottom).
----
.. _class_CollisionShape2D_property_one_way_collision_margin: .. _class_CollisionShape2D_property_one_way_collision_margin:
- :ref:`float<class_float>` **one_way_collision_margin** - :ref:`float<class_float>` **one_way_collision_margin**
@@ -78,6 +82,8 @@ Sets whether this collision shape should only detect collision on one side (top
| *Getter* | get_one_way_collision_margin() | | *Getter* | get_one_way_collision_margin() |
+----------+-------------------------------------+ +----------+-------------------------------------+
----
.. _class_CollisionShape2D_property_shape: .. _class_CollisionShape2D_property_shape:
- :ref:`Shape2D<class_Shape2D>` **shape** - :ref:`Shape2D<class_Shape2D>` **shape**

56
classes/class_color.rst
View File

@@ -685,60 +685,80 @@ Property Descriptions
Alpha value (range 0 to 1). Alpha value (range 0 to 1).
----
.. _class_Color_property_a8: .. _class_Color_property_a8:
- :ref:`int<class_int>` **a8** - :ref:`int<class_int>` **a8**
Alpha value (range 0 to 255). Alpha value (range 0 to 255).
----
.. _class_Color_property_b: .. _class_Color_property_b:
- :ref:`float<class_float>` **b** - :ref:`float<class_float>` **b**
Blue value (range 0 to 1). Blue value (range 0 to 1).
----
.. _class_Color_property_b8: .. _class_Color_property_b8:
- :ref:`int<class_int>` **b8** - :ref:`int<class_int>` **b8**
Blue value (range 0 to 255). Blue value (range 0 to 255).
----
.. _class_Color_property_g: .. _class_Color_property_g:
- :ref:`float<class_float>` **g** - :ref:`float<class_float>` **g**
Green value (range 0 to 1). Green value (range 0 to 1).
----
.. _class_Color_property_g8: .. _class_Color_property_g8:
- :ref:`int<class_int>` **g8** - :ref:`int<class_int>` **g8**
Green value (range 0 to 255). Green value (range 0 to 255).
----
.. _class_Color_property_h: .. _class_Color_property_h:
- :ref:`float<class_float>` **h** - :ref:`float<class_float>` **h**
HSV hue value (range 0 to 1). HSV hue value (range 0 to 1).
----
.. _class_Color_property_r: .. _class_Color_property_r:
- :ref:`float<class_float>` **r** - :ref:`float<class_float>` **r**
Red value (range 0 to 1). Red value (range 0 to 1).
----
.. _class_Color_property_r8: .. _class_Color_property_r8:
- :ref:`int<class_int>` **r8** - :ref:`int<class_int>` **r8**
Red value (range 0 to 255). Red value (range 0 to 255).
----
.. _class_Color_property_s: .. _class_Color_property_s:
- :ref:`float<class_float>` **s** - :ref:`float<class_float>` **s**
HSV saturation value (range 0 to 1). HSV saturation value (range 0 to 1).
----
.. _class_Color_property_v: .. _class_Color_property_v:
- :ref:`float<class_float>` **v** - :ref:`float<class_float>` **v**
@@ -762,6 +782,8 @@ Constructs a color from an HTML hexadecimal color string in ARGB or RGB format.
var c3 = Color("#b2d90a") # RGB format with '#' var c3 = Color("#b2d90a") # RGB format with '#'
var c4 = Color("b2d90a") # RGB format var c4 = Color("b2d90a") # RGB format
----
- :ref:`Color<class_Color>` **Color** **(** :ref:`int<class_int>` from **)** - :ref:`Color<class_Color>` **Color** **(** :ref:`int<class_int>` from **)**
Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile). Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile).
@@ -770,6 +792,8 @@ Constructs a color from a 32-bit integer (each byte represents a component of th
var c = Color(274) # Equivalent to RGBA(0, 0, 1, 18) var c = Color(274) # Equivalent to RGBA(0, 0, 1, 18)
----
- :ref:`Color<class_Color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)** - :ref:`Color<class_Color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)**
Constructs a color from an RGB profile using values between 0 and 1. Alpha will always be 1. Constructs a color from an RGB profile using values between 0 and 1. Alpha will always be 1.
@@ -778,6 +802,8 @@ Constructs a color from an RGB profile using values between 0 and 1. Alpha will
var c = Color(0.2, 1.0, 0.7) # Equivalent to RGBA(51, 255, 178, 255) var c = Color(0.2, 1.0, 0.7) # Equivalent to RGBA(51, 255, 178, 255)
----
- :ref:`Color<class_Color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b, :ref:`float<class_float>` a **)** - :ref:`Color<class_Color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b, :ref:`float<class_float>` a **)**
Constructs a color from an RGBA profile using values between 0 and 1. Constructs a color from an RGBA profile using values between 0 and 1.
@@ -786,6 +812,8 @@ Constructs a color from an RGBA profile using values between 0 and 1.
var c = Color(0.2, 1.0, 0.7, 0.8) # Equivalent to RGBA(51, 255, 178, 204) var c = Color(0.2, 1.0, 0.7, 0.8) # Equivalent to RGBA(51, 255, 178, 204)
----
.. _class_Color_method_blend: .. _class_Color_method_blend:
- :ref:`Color<class_Color>` **blend** **(** :ref:`Color<class_Color>` over **)** - :ref:`Color<class_Color>` **blend** **(** :ref:`Color<class_Color>` over **)**
@@ -798,6 +826,8 @@ Returns a new color resulting from blending this color over another. If the colo
var fg = Color(1.0, 0.0, 0.0, 0.5) # Red with alpha of 50% var fg = Color(1.0, 0.0, 0.0, 0.5) # Red with alpha of 50%
var blended_color = bg.blend(fg) # Brown with alpha of 75% var blended_color = bg.blend(fg) # Brown with alpha of 75%
----
.. _class_Color_method_contrasted: .. _class_Color_method_contrasted:
- :ref:`Color<class_Color>` **contrasted** **(** **)** - :ref:`Color<class_Color>` **contrasted** **(** **)**
@@ -809,6 +839,8 @@ Returns the most contrasting color.
var c = Color(0.3, 0.4, 0.9) var c = Color(0.3, 0.4, 0.9)
var contrasted_color = c.contrasted() # Equivalent to RGBA(204, 229, 102, 255) var contrasted_color = c.contrasted() # Equivalent to RGBA(204, 229, 102, 255)
----
.. _class_Color_method_darkened: .. _class_Color_method_darkened:
- :ref:`Color<class_Color>` **darkened** **(** :ref:`float<class_float>` amount **)** - :ref:`Color<class_Color>` **darkened** **(** :ref:`float<class_float>` amount **)**
@@ -820,6 +852,8 @@ Returns a new color resulting from making this color darker by the specified per
var green = Color(0.0, 1.0, 0.0) var green = Color(0.0, 1.0, 0.0)
var darkgreen = green.darkened(0.2) # 20% darker than regular green var darkgreen = green.darkened(0.2) # 20% darker than regular green
----
.. _class_Color_method_from_hsv: .. _class_Color_method_from_hsv:
- :ref:`Color<class_Color>` **from_hsv** **(** :ref:`float<class_float>` h, :ref:`float<class_float>` s, :ref:`float<class_float>` v, :ref:`float<class_float>` a=1 **)** - :ref:`Color<class_Color>` **from_hsv** **(** :ref:`float<class_float>` h, :ref:`float<class_float>` s, :ref:`float<class_float>` v, :ref:`float<class_float>` a=1 **)**
@@ -830,6 +864,8 @@ Constructs a color from an HSV profile. ``h``, ``s``, and ``v`` are values betwe
var c = Color.from_hsv(0.58, 0.5, 0.79, 0.8) # Equivalent to HSV(210, 50, 79, 0.8) or Color8(100, 151, 201, 0.8) var c = Color.from_hsv(0.58, 0.5, 0.79, 0.8) # Equivalent to HSV(210, 50, 79, 0.8) or Color8(100, 151, 201, 0.8)
----
.. _class_Color_method_gray: .. _class_Color_method_gray:
- :ref:`float<class_float>` **gray** **(** **)** - :ref:`float<class_float>` **gray** **(** **)**
@@ -843,6 +879,8 @@ The gray value is calculated as ``(r + g + b) / 3``.
var c = Color(0.2, 0.45, 0.82) var c = Color(0.2, 0.45, 0.82)
var gray = c.gray() # a value of 0.466667 var gray = c.gray() # a value of 0.466667
----
.. _class_Color_method_inverted: .. _class_Color_method_inverted:
- :ref:`Color<class_Color>` **inverted** **(** **)** - :ref:`Color<class_Color>` **inverted** **(** **)**
@@ -854,6 +892,8 @@ Returns the inverted color ``(1 - r, 1 - g, 1 - b, a)``.
var c = Color(0.3, 0.4, 0.9) var c = Color(0.3, 0.4, 0.9)
var inverted_color = c.inverted() # a color of an RGBA(178, 153, 26, 255) var inverted_color = c.inverted() # a color of an RGBA(178, 153, 26, 255)
----
.. _class_Color_method_lightened: .. _class_Color_method_lightened:
- :ref:`Color<class_Color>` **lightened** **(** :ref:`float<class_float>` amount **)** - :ref:`Color<class_Color>` **lightened** **(** :ref:`float<class_float>` amount **)**
@@ -865,6 +905,8 @@ Returns a new color resulting from making this color lighter by the specified pe
var green = Color(0.0, 1.0, 0.0) var green = Color(0.0, 1.0, 0.0)
var lightgreen = green.lightened(0.2) # 20% lighter than regular green var lightgreen = green.lightened(0.2) # 20% lighter than regular green
----
.. _class_Color_method_linear_interpolate: .. _class_Color_method_linear_interpolate:
- :ref:`Color<class_Color>` **linear_interpolate** **(** :ref:`Color<class_Color>` b, :ref:`float<class_float>` t **)** - :ref:`Color<class_Color>` **linear_interpolate** **(** :ref:`Color<class_Color>` b, :ref:`float<class_float>` t **)**
@@ -877,6 +919,8 @@ Returns the linear interpolation with another color. The interpolation factor ``
var c2 = Color(0.0, 1.0, 0.0) var c2 = Color(0.0, 1.0, 0.0)
var li_c = c1.linear_interpolate(c2, 0.5) # a color of an RGBA(128, 128, 0, 255) var li_c = c1.linear_interpolate(c2, 0.5) # a color of an RGBA(128, 128, 0, 255)
----
.. _class_Color_method_to_abgr32: .. _class_Color_method_to_abgr32:
- :ref:`int<class_int>` **to_abgr32** **(** **)** - :ref:`int<class_int>` **to_abgr32** **(** **)**
@@ -888,6 +932,8 @@ Returns the color's 32-bit integer in ABGR format (each byte represents a compon
var c = Color(1, 0.5, 0.2) var c = Color(1, 0.5, 0.2)
print(c.to_abgr32()) # Prints 4281565439 print(c.to_abgr32()) # Prints 4281565439
----
.. _class_Color_method_to_abgr64: .. _class_Color_method_to_abgr64:
- :ref:`int<class_int>` **to_abgr64** **(** **)** - :ref:`int<class_int>` **to_abgr64** **(** **)**
@@ -899,6 +945,8 @@ Returns the color's 64-bit integer in ABGR format (each word represents a compon
var c = Color(1, 0.5, 0.2) var c = Color(1, 0.5, 0.2)
print(c.to_abgr64()) # Prints -225178692812801 print(c.to_abgr64()) # Prints -225178692812801
----
.. _class_Color_method_to_argb32: .. _class_Color_method_to_argb32:
- :ref:`int<class_int>` **to_argb32** **(** **)** - :ref:`int<class_int>` **to_argb32** **(** **)**
@@ -910,6 +958,8 @@ Returns the color's 32-bit integer in ARGB format (each byte represents a compon
var c = Color(1, 0.5, 0.2) var c = Color(1, 0.5, 0.2)
print(c.to_argb32()) # Prints 4294934323 print(c.to_argb32()) # Prints 4294934323
----
.. _class_Color_method_to_argb64: .. _class_Color_method_to_argb64:
- :ref:`int<class_int>` **to_argb64** **(** **)** - :ref:`int<class_int>` **to_argb64** **(** **)**
@@ -921,6 +971,8 @@ Returns the color's 64-bit integer in ARGB format (each word represents a compon
var c = Color(1, 0.5, 0.2) var c = Color(1, 0.5, 0.2)
print(c.to_argb64()) # Prints -2147470541 print(c.to_argb64()) # Prints -2147470541
----
.. _class_Color_method_to_html: .. _class_Color_method_to_html:
- :ref:`String<class_String>` **to_html** **(** :ref:`bool<class_bool>` with_alpha=True **)** - :ref:`String<class_String>` **to_html** **(** :ref:`bool<class_bool>` with_alpha=True **)**
@@ -935,6 +987,8 @@ Setting ``with_alpha`` to ``false`` excludes alpha from the hexadecimal string.
var s1 = c.to_html() # Results "7fffffff" var s1 = c.to_html() # Results "7fffffff"
var s2 = c.to_html(false) # Results 'ffffff' var s2 = c.to_html(false) # Results 'ffffff'
----
.. _class_Color_method_to_rgba32: .. _class_Color_method_to_rgba32:
- :ref:`int<class_int>` **to_rgba32** **(** **)** - :ref:`int<class_int>` **to_rgba32** **(** **)**
@@ -946,6 +1000,8 @@ Returns the color's 32-bit integer in RGBA format (each byte represents a compon
var c = Color(1, 0.5, 0.2) var c = Color(1, 0.5, 0.2)
print(c.to_rgba32()) # Prints 4286526463 print(c.to_rgba32()) # Prints 4286526463
----
.. _class_Color_method_to_rgba64: .. _class_Color_method_to_rgba64:
- :ref:`int<class_int>` **to_rgba64** **(** **)** - :ref:`int<class_int>` **to_rgba64** **(** **)**

14
classes/class_colorpicker.rst
View File

@@ -76,12 +76,16 @@ Signals
Emitted when the color is changed. Emitted when the color is changed.
----
.. _class_ColorPicker_signal_preset_added: .. _class_ColorPicker_signal_preset_added:
- **preset_added** **(** :ref:`Color<class_Color>` color **)** - **preset_added** **(** :ref:`Color<class_Color>` color **)**
Emitted when a preset is added. Emitted when a preset is added.
----
.. _class_ColorPicker_signal_preset_removed: .. _class_ColorPicker_signal_preset_removed:
- **preset_removed** **(** :ref:`Color<class_Color>` color **)** - **preset_removed** **(** :ref:`Color<class_Color>` color **)**
@@ -108,6 +112,8 @@ Property Descriptions
The currently selected color. The currently selected color.
----
.. _class_ColorPicker_property_deferred_mode: .. _class_ColorPicker_property_deferred_mode:
- :ref:`bool<class_bool>` **deferred_mode** - :ref:`bool<class_bool>` **deferred_mode**
@@ -120,6 +126,8 @@ The currently selected color.
If ``true``, the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues). If ``true``, the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues).
----
.. _class_ColorPicker_property_edit_alpha: .. _class_ColorPicker_property_edit_alpha:
- :ref:`bool<class_bool>` **edit_alpha** - :ref:`bool<class_bool>` **edit_alpha**
@@ -132,6 +140,8 @@ If ``true``, the color will apply only after the user releases the mouse button,
If ``true``, shows an alpha channel slider (transparency). If ``true``, shows an alpha channel slider (transparency).
----
.. _class_ColorPicker_property_raw_mode: .. _class_ColorPicker_property_raw_mode:
- :ref:`bool<class_bool>` **raw_mode** - :ref:`bool<class_bool>` **raw_mode**
@@ -153,12 +163,16 @@ Method Descriptions
Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. Note: the presets list is only for *this* color picker. Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. Note: the presets list is only for *this* color picker.
----
.. _class_ColorPicker_method_erase_preset: .. _class_ColorPicker_method_erase_preset:
- void **erase_preset** **(** :ref:`Color<class_Color>` color **)** - void **erase_preset** **(** :ref:`Color<class_Color>` color **)**
Remove the given color from the list of color presets of this color picker. Remove the given color from the list of color presets of this color picker.
----
.. _class_ColorPicker_method_get_presets: .. _class_ColorPicker_method_get_presets:
- :ref:`PoolColorArray<class_PoolColorArray>` **get_presets** **(** **)** const - :ref:`PoolColorArray<class_PoolColorArray>` **get_presets** **(** **)** const

6
classes/class_colorpickerbutton.rst
View File

@@ -74,6 +74,8 @@ Signals
Emitted when the color changes. Emitted when the color changes.
----
.. _class_ColorPickerButton_signal_popup_closed: .. _class_ColorPickerButton_signal_popup_closed:
- **popup_closed** **(** **)** - **popup_closed** **(** **)**
@@ -98,6 +100,8 @@ Property Descriptions
The currently selected color. The currently selected color.
----
.. _class_ColorPickerButton_property_edit_alpha: .. _class_ColorPickerButton_property_edit_alpha:
- :ref:`bool<class_bool>` **edit_alpha** - :ref:`bool<class_bool>` **edit_alpha**
@@ -119,6 +123,8 @@ Method Descriptions
Returns the :ref:`ColorPicker<class_ColorPicker>` that this node toggles. Returns the :ref:`ColorPicker<class_ColorPicker>` that this node toggles.
----
.. _class_ColorPickerButton_method_get_popup: .. _class_ColorPickerButton_method_get_popup:
- :ref:`PopupPanel<class_PopupPanel>` **get_popup** **(** **)** - :ref:`PopupPanel<class_PopupPanel>` **get_popup** **(** **)**

2
classes/class_concavepolygonshape.rst
View File

@@ -41,6 +41,8 @@ Method Descriptions
Returns the faces (an array of triangles). Returns the faces (an array of triangles).
----
.. _class_ConcavePolygonShape_method_set_faces: .. _class_ConcavePolygonShape_method_set_faces:
- void **set_faces** **(** :ref:`PoolVector3Array<class_PoolVector3Array>` faces **)** - void **set_faces** **(** :ref:`PoolVector3Array<class_PoolVector3Array>` faces **)**

8
classes/class_conetwistjoint.rst
View File

@@ -100,6 +100,8 @@ The speed with which the swing or twist will take place.
The higher, the faster. The higher, the faster.
----
.. _class_ConeTwistJoint_property_relaxation: .. _class_ConeTwistJoint_property_relaxation:
- :ref:`float<class_float>` **relaxation** - :ref:`float<class_float>` **relaxation**
@@ -112,6 +114,8 @@ The higher, the faster.
Defines, how fast the swing- and twist-speed-difference on both sides gets synced. Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
----
.. _class_ConeTwistJoint_property_softness: .. _class_ConeTwistJoint_property_softness:
- :ref:`float<class_float>` **softness** - :ref:`float<class_float>` **softness**
@@ -124,6 +128,8 @@ Defines, how fast the swing- and twist-speed-difference on both sides gets synce
The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint. The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.
----
.. _class_ConeTwistJoint_property_swing_span: .. _class_ConeTwistJoint_property_swing_span:
- :ref:`float<class_float>` **swing_span** - :ref:`float<class_float>` **swing_span**
@@ -136,6 +142,8 @@ Could be defined as looseness in the ``ConeTwistJoint``.
If below 0.05, this behavior is locked. Default value: ``PI/4``. If below 0.05, this behavior is locked. Default value: ``PI/4``.
----
.. _class_ConeTwistJoint_property_twist_span: .. _class_ConeTwistJoint_property_twist_span:
- :ref:`float<class_float>` **twist_span** - :ref:`float<class_float>` **twist_span**

16
classes/class_configfile.rst
View File

@@ -81,48 +81,64 @@ Method Descriptions
Deletes the specified section along with all the key-value pairs inside. Deletes the specified section along with all the key-value pairs inside.
----
.. _class_ConfigFile_method_get_section_keys: .. _class_ConfigFile_method_get_section_keys:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_section_keys** **(** :ref:`String<class_String>` section **)** const - :ref:`PoolStringArray<class_PoolStringArray>` **get_section_keys** **(** :ref:`String<class_String>` section **)** const
Returns an array of all defined key identifiers in the specified section. Returns an array of all defined key identifiers in the specified section.
----
.. _class_ConfigFile_method_get_sections: .. _class_ConfigFile_method_get_sections:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_sections** **(** **)** const - :ref:`PoolStringArray<class_PoolStringArray>` **get_sections** **(** **)** const
Returns an array of all defined section identifiers. Returns an array of all defined section identifiers.
----
.. _class_ConfigFile_method_get_value: .. _class_ConfigFile_method_get_value:
- :ref:`Variant<class_Variant>` **get_value** **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` default=null **)** const - :ref:`Variant<class_Variant>` **get_value** **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` default=null **)** const
Returns the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional ``default`` argument, or ``null`` if it is omitted. Returns the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional ``default`` argument, or ``null`` if it is omitted.
----
.. _class_ConfigFile_method_has_section: .. _class_ConfigFile_method_has_section:
- :ref:`bool<class_bool>` **has_section** **(** :ref:`String<class_String>` section **)** const - :ref:`bool<class_bool>` **has_section** **(** :ref:`String<class_String>` section **)** const
Returns ``true`` if the specified section exists. Returns ``true`` if the specified section exists.
----
.. _class_ConfigFile_method_has_section_key: .. _class_ConfigFile_method_has_section_key:
- :ref:`bool<class_bool>` **has_section_key** **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key **)** const - :ref:`bool<class_bool>` **has_section_key** **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key **)** const
Returns ``true`` if the specified section-key pair exists. Returns ``true`` if the specified section-key pair exists.
----
.. _class_ConfigFile_method_load: .. _class_ConfigFile_method_load:
- :ref:`Error<enum_@GlobalScope_Error>` **load** **(** :ref:`String<class_String>` path **)** - :ref:`Error<enum_@GlobalScope_Error>` **load** **(** :ref:`String<class_String>` path **)**
Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>`, :ref:`@GlobalScope.FAILED<class_@GlobalScope_constant_FAILED>` or ``ERR_*`` constants listed in :ref:`@GlobalScope<class_@GlobalScope>`. If the load was successful, the return value is :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>`. Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>`, :ref:`@GlobalScope.FAILED<class_@GlobalScope_constant_FAILED>` or ``ERR_*`` constants listed in :ref:`@GlobalScope<class_@GlobalScope>`. If the load was successful, the return value is :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>`.
----
.. _class_ConfigFile_method_save: .. _class_ConfigFile_method_save:
- :ref:`Error<enum_@GlobalScope_Error>` **save** **(** :ref:`String<class_String>` path **)** - :ref:`Error<enum_@GlobalScope_Error>` **save** **(** :ref:`String<class_String>` path **)**
Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>`, :ref:`@GlobalScope.FAILED<class_@GlobalScope_constant_FAILED>` or ``ERR_*`` constants listed in :ref:`@GlobalScope<class_@GlobalScope>`. If the load was successful, the return value is :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>`. Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>`, :ref:`@GlobalScope.FAILED<class_@GlobalScope_constant_FAILED>` or ``ERR_*`` constants listed in :ref:`@GlobalScope<class_@GlobalScope>`. If the load was successful, the return value is :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>`.
----
.. _class_ConfigFile_method_set_value: .. _class_ConfigFile_method_set_value:
- void **set_value** **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` value **)** - void **set_value** **(** :ref:`String<class_String>` section, :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` value **)**

2
classes/class_container.rst
View File

@@ -61,6 +61,8 @@ Method Descriptions
Fit a child control in a given rect. This is mainly a helper for creating custom container classes. Fit a child control in a given rect. This is mainly a helper for creating custom container classes.
----
.. _class_Container_method_queue_sort: .. _class_Container_method_queue_sort:
- void **queue_sort** **(** **)** - void **queue_sort** **(** **)**

212
classes/class_control.rst
View File

@@ -225,48 +225,64 @@ Signals
Emitted when the node gains keyboard focus. Emitted when the node gains keyboard focus.
----
.. _class_Control_signal_focus_exited: .. _class_Control_signal_focus_exited:
- **focus_exited** **(** **)** - **focus_exited** **(** **)**
Emitted when the node loses keyboard focus. Emitted when the node loses keyboard focus.
----
.. _class_Control_signal_gui_input: .. _class_Control_signal_gui_input:
- **gui_input** **(** :ref:`InputEvent<class_InputEvent>` event **)** - **gui_input** **(** :ref:`InputEvent<class_InputEvent>` event **)**
Emitted when the node receives an :ref:`InputEvent<class_InputEvent>`. Emitted when the node receives an :ref:`InputEvent<class_InputEvent>`.
----
.. _class_Control_signal_minimum_size_changed: .. _class_Control_signal_minimum_size_changed:
- **minimum_size_changed** **(** **)** - **minimum_size_changed** **(** **)**
Emitted when the node's minimum size changes. Emitted when the node's minimum size changes.
----
.. _class_Control_signal_modal_closed: .. _class_Control_signal_modal_closed:
- **modal_closed** **(** **)** - **modal_closed** **(** **)**
Emitted when a modal ``Control`` is closed. See :ref:`show_modal<class_Control_method_show_modal>`. Emitted when a modal ``Control`` is closed. See :ref:`show_modal<class_Control_method_show_modal>`.
----
.. _class_Control_signal_mouse_entered: .. _class_Control_signal_mouse_entered:
- **mouse_entered** **(** **)** - **mouse_entered** **(** **)**
Emitted when the mouse enters the control's ``Rect`` area, provided its :ref:`mouse_filter<class_Control_property_mouse_filter>` lets the event reach it. Emitted when the mouse enters the control's ``Rect`` area, provided its :ref:`mouse_filter<class_Control_property_mouse_filter>` lets the event reach it.
----
.. _class_Control_signal_mouse_exited: .. _class_Control_signal_mouse_exited:
- **mouse_exited** **(** **)** - **mouse_exited** **(** **)**
Emitted when the mouse leaves the control's ``Rect`` area, provided its :ref:`mouse_filter<class_Control_property_mouse_filter>` lets the event reach it. Emitted when the mouse leaves the control's ``Rect`` area, provided its :ref:`mouse_filter<class_Control_property_mouse_filter>` lets the event reach it.
----
.. _class_Control_signal_resized: .. _class_Control_signal_resized:
- **resized** **(** **)** - **resized** **(** **)**
Emitted when the control changes size. Emitted when the control changes size.
----
.. _class_Control_signal_size_flags_changed: .. _class_Control_signal_size_flags_changed:
- **size_flags_changed** **(** **)** - **size_flags_changed** **(** **)**
@@ -292,6 +308,8 @@ enum **FocusMode**:
- **FOCUS_ALL** = **2** --- The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with :ref:`focus_mode<class_Control_property_focus_mode>`. - **FOCUS_ALL** = **2** --- The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with :ref:`focus_mode<class_Control_property_focus_mode>`.
----
.. _enum_Control_CursorShape: .. _enum_Control_CursorShape:
.. _class_Control_constant_CURSOR_ARROW: .. _class_Control_constant_CURSOR_ARROW:
@@ -364,6 +382,8 @@ enum **CursorShape**:
- **CURSOR_HELP** = **16** --- Show the system's help mouse cursor when the user hovers the node, a question mark. - **CURSOR_HELP** = **16** --- Show the system's help mouse cursor when the user hovers the node, a question mark.
----
.. _enum_Control_LayoutPreset: .. _enum_Control_LayoutPreset:
.. _class_Control_constant_PRESET_TOP_LEFT: .. _class_Control_constant_PRESET_TOP_LEFT:
@@ -432,6 +452,8 @@ enum **LayoutPreset**:
- **PRESET_WIDE** = **15** --- Snap all 4 anchors to the respective corners of the parent control. Set all 4 margins to 0 after you applied this preset and the ``Control`` will fit its parent control. This is equivalent to to the "Full Rect" layout option in the editor. Use with :ref:`set_anchors_preset<class_Control_method_set_anchors_preset>`. - **PRESET_WIDE** = **15** --- Snap all 4 anchors to the respective corners of the parent control. Set all 4 margins to 0 after you applied this preset and the ``Control`` will fit its parent control. This is equivalent to to the "Full Rect" layout option in the editor. Use with :ref:`set_anchors_preset<class_Control_method_set_anchors_preset>`.
----
.. _enum_Control_LayoutPresetMode: .. _enum_Control_LayoutPresetMode:
.. _class_Control_constant_PRESET_MODE_MINSIZE: .. _class_Control_constant_PRESET_MODE_MINSIZE:
@@ -452,6 +474,8 @@ enum **LayoutPresetMode**:
- **PRESET_MODE_KEEP_SIZE** = **3** - **PRESET_MODE_KEEP_SIZE** = **3**
----
.. _enum_Control_SizeFlags: .. _enum_Control_SizeFlags:
.. _class_Control_constant_SIZE_FILL: .. _class_Control_constant_SIZE_FILL:
@@ -476,6 +500,8 @@ enum **SizeFlags**:
- **SIZE_SHRINK_END** = **8** --- Tells the parent :ref:`Container<class_Container>` to align the node with its end, either the bottom or the right edge. It doesn't work with the fill or expand size flags. Use with :ref:`size_flags_horizontal<class_Control_property_size_flags_horizontal>` and :ref:`size_flags_vertical<class_Control_property_size_flags_vertical>`. - **SIZE_SHRINK_END** = **8** --- Tells the parent :ref:`Container<class_Container>` to align the node with its end, either the bottom or the right edge. It doesn't work with the fill or expand size flags. Use with :ref:`size_flags_horizontal<class_Control_property_size_flags_horizontal>` and :ref:`size_flags_vertical<class_Control_property_size_flags_vertical>`.
----
.. _enum_Control_MouseFilter: .. _enum_Control_MouseFilter:
.. _class_Control_constant_MOUSE_FILTER_STOP: .. _class_Control_constant_MOUSE_FILTER_STOP:
@@ -492,6 +518,8 @@ enum **MouseFilter**:
- **MOUSE_FILTER_IGNORE** = **2** --- The control will not receive mouse button input events through :ref:`_gui_input<class_Control_method__gui_input>`. Also the control will not receive the :ref:`mouse_entered<class_Control_signal_mouse_entered>` nor :ref:`mouse_exited<class_Control_signal_mouse_exited>` signals. This will not block other controls from receiving these events or firing the signals. Ignored events will not be handled automatically. - **MOUSE_FILTER_IGNORE** = **2** --- The control will not receive mouse button input events through :ref:`_gui_input<class_Control_method__gui_input>`. Also the control will not receive the :ref:`mouse_entered<class_Control_signal_mouse_entered>` nor :ref:`mouse_exited<class_Control_signal_mouse_exited>` signals. This will not block other controls from receiving these events or firing the signals. Ignored events will not be handled automatically.
----
.. _enum_Control_GrowDirection: .. _enum_Control_GrowDirection:
.. _class_Control_constant_GROW_DIRECTION_BEGIN: .. _class_Control_constant_GROW_DIRECTION_BEGIN:
@@ -508,6 +536,8 @@ enum **GrowDirection**:
- **GROW_DIRECTION_BOTH** = **2** --- The control will grow in both directions equally to make up if its minimum size is changed to be greater than its current size. - **GROW_DIRECTION_BOTH** = **2** --- The control will grow in both directions equally to make up if its minimum size is changed to be greater than its current size.
----
.. _enum_Control_Anchor: .. _enum_Control_Anchor:
.. _class_Control_constant_ANCHOR_BEGIN: .. _class_Control_constant_ANCHOR_BEGIN:
@@ -596,6 +626,8 @@ Property Descriptions
Anchors the bottom edge of the node to the origin, the center, or the end of its parent control. It changes how the bottom margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience. Default value: :ref:`ANCHOR_BEGIN<class_Control_constant_ANCHOR_BEGIN>`. Anchors the bottom edge of the node to the origin, the center, or the end of its parent control. It changes how the bottom margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience. Default value: :ref:`ANCHOR_BEGIN<class_Control_constant_ANCHOR_BEGIN>`.
----
.. _class_Control_property_anchor_left: .. _class_Control_property_anchor_left:
- :ref:`float<class_float>` **anchor_left** - :ref:`float<class_float>` **anchor_left**
@@ -606,6 +638,8 @@ Anchors the bottom edge of the node to the origin, the center, or the end of its
Anchors the left edge of the node to the origin, the center or the end of its parent control. It changes how the left margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience.Default value: :ref:`ANCHOR_BEGIN<class_Control_constant_ANCHOR_BEGIN>`. Anchors the left edge of the node to the origin, the center or the end of its parent control. It changes how the left margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience.Default value: :ref:`ANCHOR_BEGIN<class_Control_constant_ANCHOR_BEGIN>`.
----
.. _class_Control_property_anchor_right: .. _class_Control_property_anchor_right:
- :ref:`float<class_float>` **anchor_right** - :ref:`float<class_float>` **anchor_right**
@@ -616,6 +650,8 @@ Anchors the left edge of the node to the origin, the center or the end of its pa
Anchors the right edge of the node to the origin, the center or the end of its parent control. It changes how the right margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience. Default value: :ref:`ANCHOR_BEGIN<class_Control_constant_ANCHOR_BEGIN>`. Anchors the right edge of the node to the origin, the center or the end of its parent control. It changes how the right margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience. Default value: :ref:`ANCHOR_BEGIN<class_Control_constant_ANCHOR_BEGIN>`.
----
.. _class_Control_property_anchor_top: .. _class_Control_property_anchor_top:
- :ref:`float<class_float>` **anchor_top** - :ref:`float<class_float>` **anchor_top**
@@ -626,6 +662,8 @@ Anchors the right edge of the node to the origin, the center or the end of its p
Anchors the top edge of the node to the origin, the center or the end of its parent control. It changes how the top margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience. Default value: :ref:`ANCHOR_BEGIN<class_Control_constant_ANCHOR_BEGIN>`. Anchors the top edge of the node to the origin, the center or the end of its parent control. It changes how the top margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience. Default value: :ref:`ANCHOR_BEGIN<class_Control_constant_ANCHOR_BEGIN>`.
----
.. _class_Control_property_focus_mode: .. _class_Control_property_focus_mode:
- :ref:`FocusMode<enum_Control_FocusMode>` **focus_mode** - :ref:`FocusMode<enum_Control_FocusMode>` **focus_mode**
@@ -638,6 +676,8 @@ Anchors the top edge of the node to the origin, the center or the end of its par
The focus access mode for the control (None, Click or All). Only one Control can be focused at the same time, and it will receive keyboard signals. The focus access mode for the control (None, Click or All). Only one Control can be focused at the same time, and it will receive keyboard signals.
----
.. _class_Control_property_focus_neighbour_bottom: .. _class_Control_property_focus_neighbour_bottom:
- :ref:`NodePath<class_NodePath>` **focus_neighbour_bottom** - :ref:`NodePath<class_NodePath>` **focus_neighbour_bottom**
@@ -650,6 +690,8 @@ The focus access mode for the control (None, Click or All). Only one Control can
Tells Godot which node it should give keyboard focus to if the user presses the down arrow on the keyboard or down on a gamepad by default. You can change the key by editing the ``ui_down`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. Tells Godot which node it should give keyboard focus to if the user presses the down arrow on the keyboard or down on a gamepad by default. You can change the key by editing the ``ui_down`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one.
----
.. _class_Control_property_focus_neighbour_left: .. _class_Control_property_focus_neighbour_left:
- :ref:`NodePath<class_NodePath>` **focus_neighbour_left** - :ref:`NodePath<class_NodePath>` **focus_neighbour_left**
@@ -662,6 +704,8 @@ Tells Godot which node it should give keyboard focus to if the user presses the
Tells Godot which node it should give keyboard focus to if the user presses the left arrow on the keyboard or left on a gamepad by default. You can change the key by editing the ``ui_left`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the left of this one. Tells Godot which node it should give keyboard focus to if the user presses the left arrow on the keyboard or left on a gamepad by default. You can change the key by editing the ``ui_left`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the left of this one.
----
.. _class_Control_property_focus_neighbour_right: .. _class_Control_property_focus_neighbour_right:
- :ref:`NodePath<class_NodePath>` **focus_neighbour_right** - :ref:`NodePath<class_NodePath>` **focus_neighbour_right**
@@ -674,6 +718,8 @@ Tells Godot which node it should give keyboard focus to if the user presses the
Tells Godot which node it should give keyboard focus to if the user presses the right arrow on the keyboard or right on a gamepad by default. You can change the key by editing the ``ui_right`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. Tells Godot which node it should give keyboard focus to if the user presses the right arrow on the keyboard or right on a gamepad by default. You can change the key by editing the ``ui_right`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one.
----
.. _class_Control_property_focus_neighbour_top: .. _class_Control_property_focus_neighbour_top:
- :ref:`NodePath<class_NodePath>` **focus_neighbour_top** - :ref:`NodePath<class_NodePath>` **focus_neighbour_top**
@@ -686,6 +732,8 @@ Tells Godot which node it should give keyboard focus to if the user presses the
Tells Godot which node it should give keyboard focus to if the user presses the top arrow on the keyboard or top on a gamepad by default. You can change the key by editing the ``ui_top`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. Tells Godot which node it should give keyboard focus to if the user presses the top arrow on the keyboard or top on a gamepad by default. You can change the key by editing the ``ui_top`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one.
----
.. _class_Control_property_focus_next: .. _class_Control_property_focus_next:
- :ref:`NodePath<class_NodePath>` **focus_next** - :ref:`NodePath<class_NodePath>` **focus_next**
@@ -700,6 +748,8 @@ Tells Godot which node it should give keyboard focus to if the user presses Tab
If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree. If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree.
----
.. _class_Control_property_focus_previous: .. _class_Control_property_focus_previous:
- :ref:`NodePath<class_NodePath>` **focus_previous** - :ref:`NodePath<class_NodePath>` **focus_previous**
@@ -714,6 +764,8 @@ Tells Godot which node it should give keyboard focus to if the user presses Shif
If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree. If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree.
----
.. _class_Control_property_grow_horizontal: .. _class_Control_property_grow_horizontal:
- :ref:`GrowDirection<enum_Control_GrowDirection>` **grow_horizontal** - :ref:`GrowDirection<enum_Control_GrowDirection>` **grow_horizontal**
@@ -726,6 +778,8 @@ If this property is not set, Godot will select a "best guess" based on surroundi
Controls the direction on the horizontal axis in which the control should grow if its horizontal minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size. Controls the direction on the horizontal axis in which the control should grow if its horizontal minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size.
----
.. _class_Control_property_grow_vertical: .. _class_Control_property_grow_vertical:
- :ref:`GrowDirection<enum_Control_GrowDirection>` **grow_vertical** - :ref:`GrowDirection<enum_Control_GrowDirection>` **grow_vertical**
@@ -738,6 +792,8 @@ Controls the direction on the horizontal axis in which the control should grow i
Controls the direction on the vertical axis in which the control should grow if its vertical minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size. Controls the direction on the vertical axis in which the control should grow if its vertical minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size.
----
.. _class_Control_property_hint_tooltip: .. _class_Control_property_hint_tooltip:
- :ref:`String<class_String>` **hint_tooltip** - :ref:`String<class_String>` **hint_tooltip**
@@ -748,6 +804,8 @@ Controls the direction on the vertical axis in which the control should grow if
Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments, provided that the :ref:`mouse_filter<class_Control_property_mouse_filter>` property is not :ref:`MOUSE_FILTER_IGNORE<class_Control_constant_MOUSE_FILTER_IGNORE>`. Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments, provided that the :ref:`mouse_filter<class_Control_property_mouse_filter>` property is not :ref:`MOUSE_FILTER_IGNORE<class_Control_constant_MOUSE_FILTER_IGNORE>`.
----
.. _class_Control_property_margin_bottom: .. _class_Control_property_margin_bottom:
- :ref:`float<class_float>` **margin_bottom** - :ref:`float<class_float>` **margin_bottom**
@@ -762,6 +820,8 @@ Distance between the node's bottom edge and its parent control, based on :ref:`a
Margins are often controlled by one or multiple parent :ref:`Container<class_Container>` nodes, so you should not modify them manually if your node is a direct child of a :ref:`Container<class_Container>`. Margins update automatically when you move or resize the node. Margins are often controlled by one or multiple parent :ref:`Container<class_Container>` nodes, so you should not modify them manually if your node is a direct child of a :ref:`Container<class_Container>`. Margins update automatically when you move or resize the node.
----
.. _class_Control_property_margin_left: .. _class_Control_property_margin_left:
- :ref:`float<class_float>` **margin_left** - :ref:`float<class_float>` **margin_left**
@@ -776,6 +836,8 @@ Distance between the node's left edge and its parent control, based on :ref:`anc
Margins are often controlled by one or multiple parent :ref:`Container<class_Container>` nodes, so you should not modify them manually if your node is a direct child of a :ref:`Container<class_Container>`. Margins update automatically when you move or resize the node. Margins are often controlled by one or multiple parent :ref:`Container<class_Container>` nodes, so you should not modify them manually if your node is a direct child of a :ref:`Container<class_Container>`. Margins update automatically when you move or resize the node.
----
.. _class_Control_property_margin_right: .. _class_Control_property_margin_right:
- :ref:`float<class_float>` **margin_right** - :ref:`float<class_float>` **margin_right**
@@ -790,6 +852,8 @@ Distance between the node's right edge and its parent control, based on :ref:`an
Margins are often controlled by one or multiple parent :ref:`Container<class_Container>` nodes, so you should not modify them manually if your node is a direct child of a :ref:`Container<class_Container>`. Margins update automatically when you move or resize the node. Margins are often controlled by one or multiple parent :ref:`Container<class_Container>` nodes, so you should not modify them manually if your node is a direct child of a :ref:`Container<class_Container>`. Margins update automatically when you move or resize the node.
----
.. _class_Control_property_margin_top: .. _class_Control_property_margin_top:
- :ref:`float<class_float>` **margin_top** - :ref:`float<class_float>` **margin_top**
@@ -804,6 +868,8 @@ Distance between the node's top edge and its parent control, based on :ref:`anch
Margins are often controlled by one or multiple parent :ref:`Container<class_Container>` nodes, so you should not modify them manually if your node is a direct child of a :ref:`Container<class_Container>`. Margins update automatically when you move or resize the node. Margins are often controlled by one or multiple parent :ref:`Container<class_Container>` nodes, so you should not modify them manually if your node is a direct child of a :ref:`Container<class_Container>`. Margins update automatically when you move or resize the node.
----
.. _class_Control_property_mouse_default_cursor_shape: .. _class_Control_property_mouse_default_cursor_shape:
- :ref:`CursorShape<enum_Control_CursorShape>` **mouse_default_cursor_shape** - :ref:`CursorShape<enum_Control_CursorShape>` **mouse_default_cursor_shape**
@@ -818,6 +884,8 @@ The default cursor shape for this control. Useful for Godot plugins and applicat
**Note:** On Linux, shapes may vary depending on the cursor theme of the system. **Note:** On Linux, shapes may vary depending on the cursor theme of the system.
----
.. _class_Control_property_mouse_filter: .. _class_Control_property_mouse_filter:
- :ref:`MouseFilter<enum_Control_MouseFilter>` **mouse_filter** - :ref:`MouseFilter<enum_Control_MouseFilter>` **mouse_filter**
@@ -830,6 +898,8 @@ The default cursor shape for this control. Useful for Godot plugins and applicat
Controls whether the control will be able to receive mouse button input events through :ref:`_gui_input<class_Control_method__gui_input>` and how these events should be handled. Also controls whether the control can receive the :ref:`mouse_entered<class_Control_signal_mouse_entered>`, and :ref:`mouse_exited<class_Control_signal_mouse_exited>` signals. See the constants to learn what each does. Controls whether the control will be able to receive mouse button input events through :ref:`_gui_input<class_Control_method__gui_input>` and how these events should be handled. Also controls whether the control can receive the :ref:`mouse_entered<class_Control_signal_mouse_entered>`, and :ref:`mouse_exited<class_Control_signal_mouse_exited>` signals. See the constants to learn what each does.
----
.. _class_Control_property_rect_clip_content: .. _class_Control_property_rect_clip_content:
- :ref:`bool<class_bool>` **rect_clip_content** - :ref:`bool<class_bool>` **rect_clip_content**
@@ -842,6 +912,8 @@ Controls whether the control will be able to receive mouse button input events t
Enables whether rendering of children should be clipped to this control's rectangle. If ``true``, parts of a child which would be visibly outside of this control's rectangle will not be rendered. Enables whether rendering of children should be clipped to this control's rectangle. If ``true``, parts of a child which would be visibly outside of this control's rectangle will not be rendered.
----
.. _class_Control_property_rect_global_position: .. _class_Control_property_rect_global_position:
- :ref:`Vector2<class_Vector2>` **rect_global_position** - :ref:`Vector2<class_Vector2>` **rect_global_position**
@@ -854,6 +926,8 @@ Enables whether rendering of children should be clipped to this control's rectan
The node's global position, relative to the world (usually to the top-left corner of the window). The node's global position, relative to the world (usually to the top-left corner of the window).
----
.. _class_Control_property_rect_min_size: .. _class_Control_property_rect_min_size:
- :ref:`Vector2<class_Vector2>` **rect_min_size** - :ref:`Vector2<class_Vector2>` **rect_min_size**
@@ -866,6 +940,8 @@ The node's global position, relative to the world (usually to the top-left corne
The minimum size of the node's bounding rectangle. If you set it to a value greater than (0, 0), the node's bounding rectangle will always have at least this size, even if its content is smaller. If it's set to (0, 0), the node sizes automatically to fit its content, be it a texture or child nodes. The minimum size of the node's bounding rectangle. If you set it to a value greater than (0, 0), the node's bounding rectangle will always have at least this size, even if its content is smaller. If it's set to (0, 0), the node sizes automatically to fit its content, be it a texture or child nodes.
----
.. _class_Control_property_rect_pivot_offset: .. _class_Control_property_rect_pivot_offset:
- :ref:`Vector2<class_Vector2>` **rect_pivot_offset** - :ref:`Vector2<class_Vector2>` **rect_pivot_offset**
@@ -878,6 +954,8 @@ The minimum size of the node's bounding rectangle. If you set it to a value grea
By default, the node's pivot is its top-left corner. When you change its :ref:`rect_scale<class_Control_property_rect_scale>`, it will scale around this pivot. Set this property to :ref:`rect_size<class_Control_property_rect_size>` / 2 to center the pivot in the node's rectangle. By default, the node's pivot is its top-left corner. When you change its :ref:`rect_scale<class_Control_property_rect_scale>`, it will scale around this pivot. Set this property to :ref:`rect_size<class_Control_property_rect_size>` / 2 to center the pivot in the node's rectangle.
----
.. _class_Control_property_rect_position: .. _class_Control_property_rect_position:
- :ref:`Vector2<class_Vector2>` **rect_position** - :ref:`Vector2<class_Vector2>` **rect_position**
@@ -890,6 +968,8 @@ By default, the node's pivot is its top-left corner. When you change its :ref:`r
The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by :ref:`rect_pivot_offset<class_Control_property_rect_pivot_offset>`. The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by :ref:`rect_pivot_offset<class_Control_property_rect_pivot_offset>`.
----
.. _class_Control_property_rect_rotation: .. _class_Control_property_rect_rotation:
- :ref:`float<class_float>` **rect_rotation** - :ref:`float<class_float>` **rect_rotation**
@@ -902,6 +982,8 @@ The node's position, relative to its parent. It corresponds to the rectangle's t
The node's rotation around its pivot, in degrees. See :ref:`rect_pivot_offset<class_Control_property_rect_pivot_offset>` to change the pivot's position. The node's rotation around its pivot, in degrees. See :ref:`rect_pivot_offset<class_Control_property_rect_pivot_offset>` to change the pivot's position.
----
.. _class_Control_property_rect_scale: .. _class_Control_property_rect_scale:
- :ref:`Vector2<class_Vector2>` **rect_scale** - :ref:`Vector2<class_Vector2>` **rect_scale**
@@ -914,6 +996,8 @@ The node's rotation around its pivot, in degrees. See :ref:`rect_pivot_offset<cl
The node's scale, relative to its :ref:`rect_size<class_Control_property_rect_size>`. Change this property to scale the node around its :ref:`rect_pivot_offset<class_Control_property_rect_pivot_offset>`. The node's scale, relative to its :ref:`rect_size<class_Control_property_rect_size>`. Change this property to scale the node around its :ref:`rect_pivot_offset<class_Control_property_rect_pivot_offset>`.
----
.. _class_Control_property_rect_size: .. _class_Control_property_rect_size:
- :ref:`Vector2<class_Vector2>` **rect_size** - :ref:`Vector2<class_Vector2>` **rect_size**
@@ -926,6 +1010,8 @@ The node's scale, relative to its :ref:`rect_size<class_Control_property_rect_si
The size of the node's bounding rectangle, in pixels. :ref:`Container<class_Container>` nodes update this property automatically. The size of the node's bounding rectangle, in pixels. :ref:`Container<class_Container>` nodes update this property automatically.
----
.. _class_Control_property_size_flags_horizontal: .. _class_Control_property_size_flags_horizontal:
- :ref:`int<class_int>` **size_flags_horizontal** - :ref:`int<class_int>` **size_flags_horizontal**
@@ -938,6 +1024,8 @@ The size of the node's bounding rectangle, in pixels. :ref:`Container<class_Cont
Tells the parent :ref:`Container<class_Container>` nodes how they should resize and place the node on the X axis. Use one of the ``SIZE_*`` constants to change the flags. See the constants to learn what each does. Tells the parent :ref:`Container<class_Container>` nodes how they should resize and place the node on the X axis. Use one of the ``SIZE_*`` constants to change the flags. See the constants to learn what each does.
----
.. _class_Control_property_size_flags_stretch_ratio: .. _class_Control_property_size_flags_stretch_ratio:
- :ref:`float<class_float>` **size_flags_stretch_ratio** - :ref:`float<class_float>` **size_flags_stretch_ratio**
@@ -950,6 +1038,8 @@ Tells the parent :ref:`Container<class_Container>` nodes how they should resize
If the node and at least one of its neighbours uses the :ref:`SIZE_EXPAND<class_Control_constant_SIZE_EXPAND>` size flag, the parent :ref:`Container<class_Container>` will let it take more or less space depending on this property. If this node has a stretch ratio of 2 and its neighbour a ratio of 1, this node will take two thirds of the available space. If the node and at least one of its neighbours uses the :ref:`SIZE_EXPAND<class_Control_constant_SIZE_EXPAND>` size flag, the parent :ref:`Container<class_Container>` will let it take more or less space depending on this property. If this node has a stretch ratio of 2 and its neighbour a ratio of 1, this node will take two thirds of the available space.
----
.. _class_Control_property_size_flags_vertical: .. _class_Control_property_size_flags_vertical:
- :ref:`int<class_int>` **size_flags_vertical** - :ref:`int<class_int>` **size_flags_vertical**
@@ -962,6 +1052,8 @@ If the node and at least one of its neighbours uses the :ref:`SIZE_EXPAND<class_
Tells the parent :ref:`Container<class_Container>` nodes how they should resize and place the node on the Y axis. Use one of the ``SIZE_*`` constants to change the flags. See the constants to learn what each does. Tells the parent :ref:`Container<class_Container>` nodes how they should resize and place the node on the Y axis. Use one of the ``SIZE_*`` constants to change the flags. See the constants to learn what each does.
----
.. _class_Control_property_theme: .. _class_Control_property_theme:
- :ref:`Theme<class_Theme>` **theme** - :ref:`Theme<class_Theme>` **theme**
@@ -981,12 +1073,16 @@ Method Descriptions
- :ref:`bool<class_bool>` **_clips_input** **(** **)** virtual - :ref:`bool<class_bool>` **_clips_input** **(** **)** virtual
----
.. _class_Control_method__get_minimum_size: .. _class_Control_method__get_minimum_size:
- :ref:`Vector2<class_Vector2>` **_get_minimum_size** **(** **)** virtual - :ref:`Vector2<class_Vector2>` **_get_minimum_size** **(** **)** virtual
Returns the minimum size for this control. See :ref:`rect_min_size<class_Control_property_rect_min_size>`. Returns the minimum size for this control. See :ref:`rect_min_size<class_Control_property_rect_min_size>`.
----
.. _class_Control_method__gui_input: .. _class_Control_method__gui_input:
- void **_gui_input** **(** :ref:`InputEvent<class_InputEvent>` event **)** virtual - void **_gui_input** **(** :ref:`InputEvent<class_InputEvent>` event **)** virtual
@@ -995,52 +1091,70 @@ Use this method to process and accept inputs on UI elements. See :ref:`accept_ev
Replaces Godot 2's ``_input_event``. Replaces Godot 2's ``_input_event``.
----
.. _class_Control_method__make_custom_tooltip: .. _class_Control_method__make_custom_tooltip:
- :ref:`Object<class_Object>` **_make_custom_tooltip** **(** :ref:`String<class_String>` for_text **)** virtual - :ref:`Object<class_Object>` **_make_custom_tooltip** **(** :ref:`String<class_String>` for_text **)** virtual
----
.. _class_Control_method_accept_event: .. _class_Control_method_accept_event:
- void **accept_event** **(** **)** - void **accept_event** **(** **)**
Marks an input event as handled. Once you accept an input event, it stops propagating, even to nodes listening to :ref:`Node._unhandled_input<class_Node_method__unhandled_input>` or :ref:`Node._unhandled_key_input<class_Node_method__unhandled_key_input>`. Marks an input event as handled. Once you accept an input event, it stops propagating, even to nodes listening to :ref:`Node._unhandled_input<class_Node_method__unhandled_input>` or :ref:`Node._unhandled_key_input<class_Node_method__unhandled_key_input>`.
----
.. _class_Control_method_add_color_override: .. _class_Control_method_add_color_override:
- void **add_color_override** **(** :ref:`String<class_String>` name, :ref:`Color<class_Color>` color **)** - void **add_color_override** **(** :ref:`String<class_String>` name, :ref:`Color<class_Color>` color **)**
Overrides the color in the :ref:`theme<class_Control_property_theme>` resource the node uses. Overrides the color in the :ref:`theme<class_Control_property_theme>` resource the node uses.
----
.. _class_Control_method_add_constant_override: .. _class_Control_method_add_constant_override:
- void **add_constant_override** **(** :ref:`String<class_String>` name, :ref:`int<class_int>` constant **)** - void **add_constant_override** **(** :ref:`String<class_String>` name, :ref:`int<class_int>` constant **)**
Overrides an integer constant in the :ref:`theme<class_Control_property_theme>` resource the node uses. If the ``constant`` is invalid, Godot clears the override. Overrides an integer constant in the :ref:`theme<class_Control_property_theme>` resource the node uses. If the ``constant`` is invalid, Godot clears the override.
----
.. _class_Control_method_add_font_override: .. _class_Control_method_add_font_override:
- void **add_font_override** **(** :ref:`String<class_String>` name, :ref:`Font<class_Font>` font **)** - void **add_font_override** **(** :ref:`String<class_String>` name, :ref:`Font<class_Font>` font **)**
Overrides the ``name`` font in the :ref:`theme<class_Control_property_theme>` resource the node uses. If ``font`` is empty, Godot clears the override. Overrides the ``name`` font in the :ref:`theme<class_Control_property_theme>` resource the node uses. If ``font`` is empty, Godot clears the override.
----
.. _class_Control_method_add_icon_override: .. _class_Control_method_add_icon_override:
- void **add_icon_override** **(** :ref:`String<class_String>` name, :ref:`Texture<class_Texture>` texture **)** - void **add_icon_override** **(** :ref:`String<class_String>` name, :ref:`Texture<class_Texture>` texture **)**
Overrides the ``name`` icon in the :ref:`theme<class_Control_property_theme>` resource the node uses. If ``icon`` is empty, Godot clears the override. Overrides the ``name`` icon in the :ref:`theme<class_Control_property_theme>` resource the node uses. If ``icon`` is empty, Godot clears the override.
----
.. _class_Control_method_add_shader_override: .. _class_Control_method_add_shader_override:
- void **add_shader_override** **(** :ref:`String<class_String>` name, :ref:`Shader<class_Shader>` shader **)** - void **add_shader_override** **(** :ref:`String<class_String>` name, :ref:`Shader<class_Shader>` shader **)**
Overrides the ``name`` shader in the :ref:`theme<class_Control_property_theme>` resource the node uses. If ``shader`` is empty, Godot clears the override. Overrides the ``name`` shader in the :ref:`theme<class_Control_property_theme>` resource the node uses. If ``shader`` is empty, Godot clears the override.
----
.. _class_Control_method_add_stylebox_override: .. _class_Control_method_add_stylebox_override:
- void **add_stylebox_override** **(** :ref:`String<class_String>` name, :ref:`StyleBox<class_StyleBox>` stylebox **)** - void **add_stylebox_override** **(** :ref:`String<class_String>` name, :ref:`StyleBox<class_StyleBox>` stylebox **)**
Overrides the ``name`` :ref:`StyleBox<class_StyleBox>` in the :ref:`theme<class_Control_property_theme>` resource the node uses. If ``stylebox`` is empty, Godot clears the override. Overrides the ``name`` :ref:`StyleBox<class_StyleBox>` in the :ref:`theme<class_Control_property_theme>` resource the node uses. If ``stylebox`` is empty, Godot clears the override.
----
.. _class_Control_method_can_drop_data: .. _class_Control_method_can_drop_data:
- :ref:`bool<class_bool>` **can_drop_data** **(** :ref:`Vector2<class_Vector2>` position, :ref:`Variant<class_Variant>` data **)** virtual - :ref:`bool<class_bool>` **can_drop_data** **(** :ref:`Vector2<class_Vector2>` position, :ref:`Variant<class_Variant>` data **)** virtual
@@ -1058,6 +1172,8 @@ This method should only be used to test the data. Process the data in :ref:`drop
# otherwise just check data # otherwise just check data
return typeof(data) == TYPE_DICTIONARY and data.has('expected') return typeof(data) == TYPE_DICTIONARY and data.has('expected')
----
.. _class_Control_method_drop_data: .. _class_Control_method_drop_data:
- void **drop_data** **(** :ref:`Vector2<class_Vector2>` position, :ref:`Variant<class_Variant>` data **)** virtual - void **drop_data** **(** :ref:`Vector2<class_Vector2>` position, :ref:`Variant<class_Variant>` data **)** virtual
@@ -1074,6 +1190,8 @@ Godot calls this method to pass you the ``data`` from a control's :ref:`get_drag
func drop_data(position, data): func drop_data(position, data):
color = data['color'] color = data['color']
----
.. _class_Control_method_force_drag: .. _class_Control_method_force_drag:
- void **force_drag** **(** :ref:`Variant<class_Variant>` data, :ref:`Control<class_Control>` preview **)** - void **force_drag** **(** :ref:`Variant<class_Variant>` data, :ref:`Control<class_Control>` preview **)**
@@ -1082,30 +1200,42 @@ Forces drag and bypasses :ref:`get_drag_data<class_Control_method_get_drag_data>
The methods :ref:`can_drop_data<class_Control_method_can_drop_data>` and :ref:`drop_data<class_Control_method_drop_data>` must be implemented on controls that want to receive drop data. The methods :ref:`can_drop_data<class_Control_method_can_drop_data>` and :ref:`drop_data<class_Control_method_drop_data>` must be implemented on controls that want to receive drop data.
----
.. _class_Control_method_get_begin: .. _class_Control_method_get_begin:
- :ref:`Vector2<class_Vector2>` **get_begin** **(** **)** const - :ref:`Vector2<class_Vector2>` **get_begin** **(** **)** const
Returns :ref:`margin_left<class_Control_property_margin_left>` and :ref:`margin_top<class_Control_property_margin_top>`. See also :ref:`rect_position<class_Control_property_rect_position>`. Returns :ref:`margin_left<class_Control_property_margin_left>` and :ref:`margin_top<class_Control_property_margin_top>`. See also :ref:`rect_position<class_Control_property_rect_position>`.
----
.. _class_Control_method_get_color: .. _class_Control_method_get_color:
- :ref:`Color<class_Color>` **get_color** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const - :ref:`Color<class_Color>` **get_color** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
----
.. _class_Control_method_get_combined_minimum_size: .. _class_Control_method_get_combined_minimum_size:
- :ref:`Vector2<class_Vector2>` **get_combined_minimum_size** **(** **)** const - :ref:`Vector2<class_Vector2>` **get_combined_minimum_size** **(** **)** const
----
.. _class_Control_method_get_constant: .. _class_Control_method_get_constant:
- :ref:`int<class_int>` **get_constant** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const - :ref:`int<class_int>` **get_constant** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
----
.. _class_Control_method_get_cursor_shape: .. _class_Control_method_get_cursor_shape:
- :ref:`CursorShape<enum_Control_CursorShape>` **get_cursor_shape** **(** :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)** const - :ref:`CursorShape<enum_Control_CursorShape>` **get_cursor_shape** **(** :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)** const
Returns the mouse cursor shape the control displays on mouse hover. See :ref:`CursorShape<enum_Control_CursorShape>`. Returns the mouse cursor shape the control displays on mouse hover. See :ref:`CursorShape<enum_Control_CursorShape>`.
----
.. _class_Control_method_get_drag_data: .. _class_Control_method_get_drag_data:
- :ref:`Object<class_Object>` **get_drag_data** **(** :ref:`Vector2<class_Vector2>` position **)** virtual - :ref:`Object<class_Object>` **get_drag_data** **(** :ref:`Vector2<class_Vector2>` position **)** virtual
@@ -1123,168 +1253,238 @@ A preview that will follow the mouse that should represent the data can be set w
set_drag_preview(make_preview(mydata)) set_drag_preview(make_preview(mydata))
return mydata return mydata
----
.. _class_Control_method_get_end: .. _class_Control_method_get_end:
- :ref:`Vector2<class_Vector2>` **get_end** **(** **)** const - :ref:`Vector2<class_Vector2>` **get_end** **(** **)** const
Returns :ref:`margin_right<class_Control_property_margin_right>` and :ref:`margin_bottom<class_Control_property_margin_bottom>`. Returns :ref:`margin_right<class_Control_property_margin_right>` and :ref:`margin_bottom<class_Control_property_margin_bottom>`.
----
.. _class_Control_method_get_focus_owner: .. _class_Control_method_get_focus_owner:
- :ref:`Control<class_Control>` **get_focus_owner** **(** **)** const - :ref:`Control<class_Control>` **get_focus_owner** **(** **)** const
Returns the control that has the keyboard focus or ``null`` if none. Returns the control that has the keyboard focus or ``null`` if none.
----
.. _class_Control_method_get_font: .. _class_Control_method_get_font:
- :ref:`Font<class_Font>` **get_font** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const - :ref:`Font<class_Font>` **get_font** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
----
.. _class_Control_method_get_global_rect: .. _class_Control_method_get_global_rect:
- :ref:`Rect2<class_Rect2>` **get_global_rect** **(** **)** const - :ref:`Rect2<class_Rect2>` **get_global_rect** **(** **)** const
Returns the position and size of the control relative to the top-left corner of the screen. See :ref:`rect_position<class_Control_property_rect_position>` and :ref:`rect_size<class_Control_property_rect_size>`. Returns the position and size of the control relative to the top-left corner of the screen. See :ref:`rect_position<class_Control_property_rect_position>` and :ref:`rect_size<class_Control_property_rect_size>`.
----
.. _class_Control_method_get_icon: .. _class_Control_method_get_icon:
- :ref:`Texture<class_Texture>` **get_icon** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const - :ref:`Texture<class_Texture>` **get_icon** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
----
.. _class_Control_method_get_minimum_size: .. _class_Control_method_get_minimum_size:
- :ref:`Vector2<class_Vector2>` **get_minimum_size** **(** **)** const - :ref:`Vector2<class_Vector2>` **get_minimum_size** **(** **)** const
Returns the minimum size for this control. See :ref:`rect_min_size<class_Control_property_rect_min_size>`. Returns the minimum size for this control. See :ref:`rect_min_size<class_Control_property_rect_min_size>`.
----
.. _class_Control_method_get_parent_area_size: .. _class_Control_method_get_parent_area_size:
- :ref:`Vector2<class_Vector2>` **get_parent_area_size** **(** **)** const - :ref:`Vector2<class_Vector2>` **get_parent_area_size** **(** **)** const
Returns the width/height occupied in the parent control. Returns the width/height occupied in the parent control.
----
.. _class_Control_method_get_parent_control: .. _class_Control_method_get_parent_control:
- :ref:`Control<class_Control>` **get_parent_control** **(** **)** const - :ref:`Control<class_Control>` **get_parent_control** **(** **)** const
Returns the parent control node. Returns the parent control node.
----
.. _class_Control_method_get_rect: .. _class_Control_method_get_rect:
- :ref:`Rect2<class_Rect2>` **get_rect** **(** **)** const - :ref:`Rect2<class_Rect2>` **get_rect** **(** **)** const
Returns the position and size of the control relative to the top-left corner of the parent Control. See :ref:`rect_position<class_Control_property_rect_position>` and :ref:`rect_size<class_Control_property_rect_size>`. Returns the position and size of the control relative to the top-left corner of the parent Control. See :ref:`rect_position<class_Control_property_rect_position>` and :ref:`rect_size<class_Control_property_rect_size>`.
----
.. _class_Control_method_get_rotation: .. _class_Control_method_get_rotation:
- :ref:`float<class_float>` **get_rotation** **(** **)** const - :ref:`float<class_float>` **get_rotation** **(** **)** const
Returns the rotation (in radians). Returns the rotation (in radians).
----
.. _class_Control_method_get_stylebox: .. _class_Control_method_get_stylebox:
- :ref:`StyleBox<class_StyleBox>` **get_stylebox** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const - :ref:`StyleBox<class_StyleBox>` **get_stylebox** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
----
.. _class_Control_method_get_tooltip: .. _class_Control_method_get_tooltip:
- :ref:`String<class_String>` **get_tooltip** **(** :ref:`Vector2<class_Vector2>` at_position=Vector2( 0, 0 ) **)** const - :ref:`String<class_String>` **get_tooltip** **(** :ref:`Vector2<class_Vector2>` at_position=Vector2( 0, 0 ) **)** const
Returns the tooltip, which will appear when the cursor is resting over this control. Returns the tooltip, which will appear when the cursor is resting over this control.
----
.. _class_Control_method_grab_click_focus: .. _class_Control_method_grab_click_focus:
- void **grab_click_focus** **(** **)** - void **grab_click_focus** **(** **)**
----
.. _class_Control_method_grab_focus: .. _class_Control_method_grab_focus:
- void **grab_focus** **(** **)** - void **grab_focus** **(** **)**
Steal the focus from another control and become the focused control (see :ref:`focus_mode<class_Control_property_focus_mode>`). Steal the focus from another control and become the focused control (see :ref:`focus_mode<class_Control_property_focus_mode>`).
----
.. _class_Control_method_has_color: .. _class_Control_method_has_color:
- :ref:`bool<class_bool>` **has_color** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const - :ref:`bool<class_bool>` **has_color** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
----
.. _class_Control_method_has_color_override: .. _class_Control_method_has_color_override:
- :ref:`bool<class_bool>` **has_color_override** **(** :ref:`String<class_String>` name **)** const - :ref:`bool<class_bool>` **has_color_override** **(** :ref:`String<class_String>` name **)** const
----
.. _class_Control_method_has_constant: .. _class_Control_method_has_constant:
- :ref:`bool<class_bool>` **has_constant** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const - :ref:`bool<class_bool>` **has_constant** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
----
.. _class_Control_method_has_constant_override: .. _class_Control_method_has_constant_override:
- :ref:`bool<class_bool>` **has_constant_override** **(** :ref:`String<class_String>` name **)** const - :ref:`bool<class_bool>` **has_constant_override** **(** :ref:`String<class_String>` name **)** const
----
.. _class_Control_method_has_focus: .. _class_Control_method_has_focus:
- :ref:`bool<class_bool>` **has_focus** **(** **)** const - :ref:`bool<class_bool>` **has_focus** **(** **)** const
Returns ``true`` if this is the current focused control. See :ref:`focus_mode<class_Control_property_focus_mode>`. Returns ``true`` if this is the current focused control. See :ref:`focus_mode<class_Control_property_focus_mode>`.
----
.. _class_Control_method_has_font: .. _class_Control_method_has_font:
- :ref:`bool<class_bool>` **has_font** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const - :ref:`bool<class_bool>` **has_font** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
----
.. _class_Control_method_has_font_override: .. _class_Control_method_has_font_override:
- :ref:`bool<class_bool>` **has_font_override** **(** :ref:`String<class_String>` name **)** const - :ref:`bool<class_bool>` **has_font_override** **(** :ref:`String<class_String>` name **)** const
----
.. _class_Control_method_has_icon: .. _class_Control_method_has_icon:
- :ref:`bool<class_bool>` **has_icon** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const - :ref:`bool<class_bool>` **has_icon** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
----
.. _class_Control_method_has_icon_override: .. _class_Control_method_has_icon_override:
- :ref:`bool<class_bool>` **has_icon_override** **(** :ref:`String<class_String>` name **)** const - :ref:`bool<class_bool>` **has_icon_override** **(** :ref:`String<class_String>` name **)** const
----
.. _class_Control_method_has_point: .. _class_Control_method_has_point:
- :ref:`bool<class_bool>` **has_point** **(** :ref:`Vector2<class_Vector2>` point **)** virtual - :ref:`bool<class_bool>` **has_point** **(** :ref:`Vector2<class_Vector2>` point **)** virtual
----
.. _class_Control_method_has_shader_override: .. _class_Control_method_has_shader_override:
- :ref:`bool<class_bool>` **has_shader_override** **(** :ref:`String<class_String>` name **)** const - :ref:`bool<class_bool>` **has_shader_override** **(** :ref:`String<class_String>` name **)** const
----
.. _class_Control_method_has_stylebox: .. _class_Control_method_has_stylebox:
- :ref:`bool<class_bool>` **has_stylebox** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const - :ref:`bool<class_bool>` **has_stylebox** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type="" **)** const
----
.. _class_Control_method_has_stylebox_override: .. _class_Control_method_has_stylebox_override:
- :ref:`bool<class_bool>` **has_stylebox_override** **(** :ref:`String<class_String>` name **)** const - :ref:`bool<class_bool>` **has_stylebox_override** **(** :ref:`String<class_String>` name **)** const
----
.. _class_Control_method_minimum_size_changed: .. _class_Control_method_minimum_size_changed:
- void **minimum_size_changed** **(** **)** - void **minimum_size_changed** **(** **)**
----
.. _class_Control_method_release_focus: .. _class_Control_method_release_focus:
- void **release_focus** **(** **)** - void **release_focus** **(** **)**
Give up the focus. No other control will be able to receive keyboard input. Give up the focus. No other control will be able to receive keyboard input.
----
.. _class_Control_method_set_anchor: .. _class_Control_method_set_anchor:
- void **set_anchor** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`float<class_float>` anchor, :ref:`bool<class_bool>` keep_margin=false, :ref:`bool<class_bool>` push_opposite_anchor=true **)** - void **set_anchor** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`float<class_float>` anchor, :ref:`bool<class_bool>` keep_margin=false, :ref:`bool<class_bool>` push_opposite_anchor=true **)**
----
.. _class_Control_method_set_anchor_and_margin: .. _class_Control_method_set_anchor_and_margin:
- void **set_anchor_and_margin** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`float<class_float>` anchor, :ref:`float<class_float>` offset, :ref:`bool<class_bool>` push_opposite_anchor=false **)** - void **set_anchor_and_margin** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`float<class_float>` anchor, :ref:`float<class_float>` offset, :ref:`bool<class_bool>` push_opposite_anchor=false **)**
----
.. _class_Control_method_set_anchors_and_margins_preset: .. _class_Control_method_set_anchors_and_margins_preset:
- void **set_anchors_and_margins_preset** **(** :ref:`LayoutPreset<enum_Control_LayoutPreset>` preset, :ref:`LayoutPresetMode<enum_Control_LayoutPresetMode>` resize_mode=0, :ref:`int<class_int>` margin=0 **)** - void **set_anchors_and_margins_preset** **(** :ref:`LayoutPreset<enum_Control_LayoutPreset>` preset, :ref:`LayoutPresetMode<enum_Control_LayoutPresetMode>` resize_mode=0, :ref:`int<class_int>` margin=0 **)**
----
.. _class_Control_method_set_anchors_preset: .. _class_Control_method_set_anchors_preset:
- void **set_anchors_preset** **(** :ref:`LayoutPreset<enum_Control_LayoutPreset>` preset, :ref:`bool<class_bool>` keep_margin=false **)** - void **set_anchors_preset** **(** :ref:`LayoutPreset<enum_Control_LayoutPreset>` preset, :ref:`bool<class_bool>` keep_margin=false **)**
----
.. _class_Control_method_set_begin: .. _class_Control_method_set_begin:
- void **set_begin** **(** :ref:`Vector2<class_Vector2>` position **)** - void **set_begin** **(** :ref:`Vector2<class_Vector2>` position **)**
Sets :ref:`margin_left<class_Control_property_margin_left>` and :ref:`margin_top<class_Control_property_margin_top>` at the same time. Sets :ref:`margin_left<class_Control_property_margin_left>` and :ref:`margin_top<class_Control_property_margin_top>` at the same time.
----
.. _class_Control_method_set_drag_forwarding: .. _class_Control_method_set_drag_forwarding:
- void **set_drag_forwarding** **(** :ref:`Control<class_Control>` target **)** - void **set_drag_forwarding** **(** :ref:`Control<class_Control>` target **)**
@@ -1316,34 +1516,46 @@ Forwarding can be implemented in the target control similar to the methods :ref:
set_drag_preview(my_preview) set_drag_preview(my_preview)
return my_data() return my_data()
----
.. _class_Control_method_set_drag_preview: .. _class_Control_method_set_drag_preview:
- void **set_drag_preview** **(** :ref:`Control<class_Control>` control **)** - void **set_drag_preview** **(** :ref:`Control<class_Control>` control **)**
Shows the given control at the mouse pointer. A good time to call this method is in :ref:`get_drag_data<class_Control_method_get_drag_data>`. Shows the given control at the mouse pointer. A good time to call this method is in :ref:`get_drag_data<class_Control_method_get_drag_data>`.
----
.. _class_Control_method_set_end: .. _class_Control_method_set_end:
- void **set_end** **(** :ref:`Vector2<class_Vector2>` position **)** - void **set_end** **(** :ref:`Vector2<class_Vector2>` position **)**
Sets :ref:`margin_right<class_Control_property_margin_right>` and :ref:`margin_bottom<class_Control_property_margin_bottom>` at the same time. Sets :ref:`margin_right<class_Control_property_margin_right>` and :ref:`margin_bottom<class_Control_property_margin_bottom>` at the same time.
----
.. _class_Control_method_set_margins_preset: .. _class_Control_method_set_margins_preset:
- void **set_margins_preset** **(** :ref:`LayoutPreset<enum_Control_LayoutPreset>` preset, :ref:`LayoutPresetMode<enum_Control_LayoutPresetMode>` resize_mode=0, :ref:`int<class_int>` margin=0 **)** - void **set_margins_preset** **(** :ref:`LayoutPreset<enum_Control_LayoutPreset>` preset, :ref:`LayoutPresetMode<enum_Control_LayoutPresetMode>` resize_mode=0, :ref:`int<class_int>` margin=0 **)**
----
.. _class_Control_method_set_rotation: .. _class_Control_method_set_rotation:
- void **set_rotation** **(** :ref:`float<class_float>` radians **)** - void **set_rotation** **(** :ref:`float<class_float>` radians **)**
Sets the rotation (in radians). Sets the rotation (in radians).
----
.. _class_Control_method_show_modal: .. _class_Control_method_show_modal:
- void **show_modal** **(** :ref:`bool<class_bool>` exclusive=false **)** - void **show_modal** **(** :ref:`bool<class_bool>` exclusive=false **)**
Displays a control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus. Displays a control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus.
----
.. _class_Control_method_warp_mouse: .. _class_Control_method_warp_mouse:
- void **warp_mouse** **(** :ref:`Vector2<class_Vector2>` to_position **)** - void **warp_mouse** **(** :ref:`Vector2<class_Vector2>` to_position **)**

124
classes/class_cpuparticles.rst
View File

@@ -169,6 +169,8 @@ enum **DrawOrder**:
- **DRAW_ORDER_VIEW_DEPTH** = **2** --- Particles are drawn in order of depth. - **DRAW_ORDER_VIEW_DEPTH** = **2** --- Particles are drawn in order of depth.
----
.. _enum_CPUParticles_Parameter: .. _enum_CPUParticles_Parameter:
.. _class_CPUParticles_constant_PARAM_INITIAL_LINEAR_VELOCITY: .. _class_CPUParticles_constant_PARAM_INITIAL_LINEAR_VELOCITY:
@@ -221,6 +223,8 @@ enum **Parameter**:
- **PARAM_MAX** = **11** --- Represents the size of the :ref:`Parameter<enum_CPUParticles_Parameter>` enum. - **PARAM_MAX** = **11** --- Represents the size of the :ref:`Parameter<enum_CPUParticles_Parameter>` enum.
----
.. _enum_CPUParticles_Flags: .. _enum_CPUParticles_Flags:
.. _class_CPUParticles_constant_FLAG_ALIGN_Y_TO_VELOCITY: .. _class_CPUParticles_constant_FLAG_ALIGN_Y_TO_VELOCITY:
@@ -237,6 +241,8 @@ enum **Flags**:
- **FLAG_MAX** = **3** --- Represents the size of the :ref:`Flags<enum_CPUParticles_Flags>` enum. - **FLAG_MAX** = **3** --- Represents the size of the :ref:`Flags<enum_CPUParticles_Flags>` enum.
----
.. _enum_CPUParticles_EmissionShape: .. _enum_CPUParticles_EmissionShape:
.. _class_CPUParticles_constant_EMISSION_SHAPE_POINT: .. _class_CPUParticles_constant_EMISSION_SHAPE_POINT:
@@ -283,6 +289,8 @@ Property Descriptions
Number of particles emitted in one emission cycle. Number of particles emitted in one emission cycle.
----
.. _class_CPUParticles_property_angle: .. _class_CPUParticles_property_angle:
- :ref:`float<class_float>` **angle** - :ref:`float<class_float>` **angle**
@@ -295,6 +303,8 @@ Number of particles emitted in one emission cycle.
Initial rotation applied to each particle, in degrees. Initial rotation applied to each particle, in degrees.
----
.. _class_CPUParticles_property_angle_curve: .. _class_CPUParticles_property_angle_curve:
- :ref:`Curve<class_Curve>` **angle_curve** - :ref:`Curve<class_Curve>` **angle_curve**
@@ -307,6 +317,8 @@ Initial rotation applied to each particle, in degrees.
Each particle's rotation will be animated along this :ref:`Curve<class_Curve>`. Each particle's rotation will be animated along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles_property_angle_random: .. _class_CPUParticles_property_angle_random:
- :ref:`float<class_float>` **angle_random** - :ref:`float<class_float>` **angle_random**
@@ -319,6 +331,8 @@ Each particle's rotation will be animated along this :ref:`Curve<class_Curve>`.
Rotation randomness ratio. Default value: ``0``. Rotation randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles_property_angular_velocity: .. _class_CPUParticles_property_angular_velocity:
- :ref:`float<class_float>` **angular_velocity** - :ref:`float<class_float>` **angular_velocity**
@@ -331,6 +345,8 @@ Rotation randomness ratio. Default value: ``0``.
Initial angular velocity applied to each particle. Sets the speed of rotation of the particle. Initial angular velocity applied to each particle. Sets the speed of rotation of the particle.
----
.. _class_CPUParticles_property_angular_velocity_curve: .. _class_CPUParticles_property_angular_velocity_curve:
- :ref:`Curve<class_Curve>` **angular_velocity_curve** - :ref:`Curve<class_Curve>` **angular_velocity_curve**
@@ -343,6 +359,8 @@ Initial angular velocity applied to each particle. Sets the speed of rotation of
Each particle's angular velocity will vary along this :ref:`Curve<class_Curve>`. Each particle's angular velocity will vary along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles_property_angular_velocity_random: .. _class_CPUParticles_property_angular_velocity_random:
- :ref:`float<class_float>` **angular_velocity_random** - :ref:`float<class_float>` **angular_velocity_random**
@@ -355,6 +373,8 @@ Each particle's angular velocity will vary along this :ref:`Curve<class_Curve>`.
Angular velocity randomness ratio. Default value: ``0``. Angular velocity randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles_property_anim_offset: .. _class_CPUParticles_property_anim_offset:
- :ref:`float<class_float>` **anim_offset** - :ref:`float<class_float>` **anim_offset**
@@ -367,6 +387,8 @@ Angular velocity randomness ratio. Default value: ``0``.
Particle animation offset. Particle animation offset.
----
.. _class_CPUParticles_property_anim_offset_curve: .. _class_CPUParticles_property_anim_offset_curve:
- :ref:`Curve<class_Curve>` **anim_offset_curve** - :ref:`Curve<class_Curve>` **anim_offset_curve**
@@ -379,6 +401,8 @@ Particle animation offset.
Each particle's animation offset will vary along this :ref:`Curve<class_Curve>`. Each particle's animation offset will vary along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles_property_anim_offset_random: .. _class_CPUParticles_property_anim_offset_random:
- :ref:`float<class_float>` **anim_offset_random** - :ref:`float<class_float>` **anim_offset_random**
@@ -391,6 +415,8 @@ Each particle's animation offset will vary along this :ref:`Curve<class_Curve>`.
Animation offset randomness ratio. Default value: ``0``. Animation offset randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles_property_anim_speed: .. _class_CPUParticles_property_anim_speed:
- :ref:`float<class_float>` **anim_speed** - :ref:`float<class_float>` **anim_speed**
@@ -403,6 +429,8 @@ Animation offset randomness ratio. Default value: ``0``.
Particle animation speed. Particle animation speed.
----
.. _class_CPUParticles_property_anim_speed_curve: .. _class_CPUParticles_property_anim_speed_curve:
- :ref:`Curve<class_Curve>` **anim_speed_curve** - :ref:`Curve<class_Curve>` **anim_speed_curve**
@@ -415,6 +443,8 @@ Particle animation speed.
Each particle's animation speed will vary along this :ref:`Curve<class_Curve>`. Each particle's animation speed will vary along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles_property_anim_speed_random: .. _class_CPUParticles_property_anim_speed_random:
- :ref:`float<class_float>` **anim_speed_random** - :ref:`float<class_float>` **anim_speed_random**
@@ -427,6 +457,8 @@ Each particle's animation speed will vary along this :ref:`Curve<class_Curve>`.
Animation speed randomness ratio. Default value: ``0``. Animation speed randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles_property_color: .. _class_CPUParticles_property_color:
- :ref:`Color<class_Color>` **color** - :ref:`Color<class_Color>` **color**
@@ -439,6 +471,8 @@ Animation speed randomness ratio. Default value: ``0``.
Unused for 3D particles. Unused for 3D particles.
----
.. _class_CPUParticles_property_color_ramp: .. _class_CPUParticles_property_color_ramp:
- :ref:`Gradient<class_Gradient>` **color_ramp** - :ref:`Gradient<class_Gradient>` **color_ramp**
@@ -451,6 +485,8 @@ Unused for 3D particles.
Unused for 3D particles. Unused for 3D particles.
----
.. _class_CPUParticles_property_damping: .. _class_CPUParticles_property_damping:
- :ref:`float<class_float>` **damping** - :ref:`float<class_float>` **damping**
@@ -463,6 +499,8 @@ Unused for 3D particles.
The rate at which particles lose velocity. The rate at which particles lose velocity.
----
.. _class_CPUParticles_property_damping_curve: .. _class_CPUParticles_property_damping_curve:
- :ref:`Curve<class_Curve>` **damping_curve** - :ref:`Curve<class_Curve>` **damping_curve**
@@ -475,6 +513,8 @@ The rate at which particles lose velocity.
Damping will vary along this :ref:`Curve<class_Curve>`. Damping will vary along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles_property_damping_random: .. _class_CPUParticles_property_damping_random:
- :ref:`float<class_float>` **damping_random** - :ref:`float<class_float>` **damping_random**
@@ -487,6 +527,8 @@ Damping will vary along this :ref:`Curve<class_Curve>`.
Damping randomness ratio. Default value: ``0``. Damping randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles_property_draw_order: .. _class_CPUParticles_property_draw_order:
- :ref:`DrawOrder<enum_CPUParticles_DrawOrder>` **draw_order** - :ref:`DrawOrder<enum_CPUParticles_DrawOrder>` **draw_order**
@@ -499,6 +541,8 @@ Damping randomness ratio. Default value: ``0``.
Particle draw order. Uses :ref:`DrawOrder<enum_CPUParticles_DrawOrder>` values. Default value: :ref:`DRAW_ORDER_INDEX<class_CPUParticles_constant_DRAW_ORDER_INDEX>`. Particle draw order. Uses :ref:`DrawOrder<enum_CPUParticles_DrawOrder>` values. Default value: :ref:`DRAW_ORDER_INDEX<class_CPUParticles_constant_DRAW_ORDER_INDEX>`.
----
.. _class_CPUParticles_property_emission_box_extents: .. _class_CPUParticles_property_emission_box_extents:
- :ref:`Vector3<class_Vector3>` **emission_box_extents** - :ref:`Vector3<class_Vector3>` **emission_box_extents**
@@ -511,6 +555,8 @@ Particle draw order. Uses :ref:`DrawOrder<enum_CPUParticles_DrawOrder>` values.
The rectangle's extents if :ref:`emission_shape<class_CPUParticles_property_emission_shape>` is set to :ref:`EMISSION_SHAPE_BOX<class_CPUParticles_constant_EMISSION_SHAPE_BOX>`. The rectangle's extents if :ref:`emission_shape<class_CPUParticles_property_emission_shape>` is set to :ref:`EMISSION_SHAPE_BOX<class_CPUParticles_constant_EMISSION_SHAPE_BOX>`.
----
.. _class_CPUParticles_property_emission_colors: .. _class_CPUParticles_property_emission_colors:
- :ref:`PoolColorArray<class_PoolColorArray>` **emission_colors** - :ref:`PoolColorArray<class_PoolColorArray>` **emission_colors**
@@ -521,6 +567,8 @@ The rectangle's extents if :ref:`emission_shape<class_CPUParticles_property_emis
| *Getter* | get_emission_colors() | | *Getter* | get_emission_colors() |
+----------+----------------------------+ +----------+----------------------------+
----
.. _class_CPUParticles_property_emission_normals: .. _class_CPUParticles_property_emission_normals:
- :ref:`PoolVector3Array<class_PoolVector3Array>` **emission_normals** - :ref:`PoolVector3Array<class_PoolVector3Array>` **emission_normals**
@@ -531,6 +579,8 @@ The rectangle's extents if :ref:`emission_shape<class_CPUParticles_property_emis
| *Getter* | get_emission_normals() | | *Getter* | get_emission_normals() |
+----------+-----------------------------+ +----------+-----------------------------+
----
.. _class_CPUParticles_property_emission_points: .. _class_CPUParticles_property_emission_points:
- :ref:`PoolVector3Array<class_PoolVector3Array>` **emission_points** - :ref:`PoolVector3Array<class_PoolVector3Array>` **emission_points**
@@ -541,6 +591,8 @@ The rectangle's extents if :ref:`emission_shape<class_CPUParticles_property_emis
| *Getter* | get_emission_points() | | *Getter* | get_emission_points() |
+----------+----------------------------+ +----------+----------------------------+
----
.. _class_CPUParticles_property_emission_shape: .. _class_CPUParticles_property_emission_shape:
- :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` **emission_shape** - :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` **emission_shape**
@@ -553,6 +605,8 @@ The rectangle's extents if :ref:`emission_shape<class_CPUParticles_property_emis
Particles will be emitted inside this region. Use :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` for values. Default value: :ref:`EMISSION_SHAPE_POINT<class_CPUParticles_constant_EMISSION_SHAPE_POINT>`. Particles will be emitted inside this region. Use :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` for values. Default value: :ref:`EMISSION_SHAPE_POINT<class_CPUParticles_constant_EMISSION_SHAPE_POINT>`.
----
.. _class_CPUParticles_property_emission_sphere_radius: .. _class_CPUParticles_property_emission_sphere_radius:
- :ref:`float<class_float>` **emission_sphere_radius** - :ref:`float<class_float>` **emission_sphere_radius**
@@ -565,6 +619,8 @@ Particles will be emitted inside this region. Use :ref:`EmissionShape<enum_CPUPa
The sphere's radius if :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` is set to :ref:`EMISSION_SHAPE_SPHERE<class_CPUParticles_constant_EMISSION_SHAPE_SPHERE>`. The sphere's radius if :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` is set to :ref:`EMISSION_SHAPE_SPHERE<class_CPUParticles_constant_EMISSION_SHAPE_SPHERE>`.
----
.. _class_CPUParticles_property_emitting: .. _class_CPUParticles_property_emitting:
- :ref:`bool<class_bool>` **emitting** - :ref:`bool<class_bool>` **emitting**
@@ -577,6 +633,8 @@ The sphere's radius if :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` is
If ``true``, particles are being emitted. Default value: ``true``. If ``true``, particles are being emitted. Default value: ``true``.
----
.. _class_CPUParticles_property_explosiveness: .. _class_CPUParticles_property_explosiveness:
- :ref:`float<class_float>` **explosiveness** - :ref:`float<class_float>` **explosiveness**
@@ -589,6 +647,8 @@ If ``true``, particles are being emitted. Default value: ``true``.
How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. Default value: ``0``. How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. Default value: ``0``.
----
.. _class_CPUParticles_property_fixed_fps: .. _class_CPUParticles_property_fixed_fps:
- :ref:`int<class_int>` **fixed_fps** - :ref:`int<class_int>` **fixed_fps**
@@ -601,6 +661,8 @@ How rapidly particles in an emission cycle are emitted. If greater than ``0``, t
The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the particle system itself. The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the particle system itself.
----
.. _class_CPUParticles_property_flag_align_y: .. _class_CPUParticles_property_flag_align_y:
- :ref:`bool<class_bool>` **flag_align_y** - :ref:`bool<class_bool>` **flag_align_y**
@@ -613,6 +675,8 @@ The particle system's frame rate is fixed to a value. For instance, changing the
Align y-axis of particle with the direction of its velocity. Align y-axis of particle with the direction of its velocity.
----
.. _class_CPUParticles_property_flag_disable_z: .. _class_CPUParticles_property_flag_disable_z:
- :ref:`bool<class_bool>` **flag_disable_z** - :ref:`bool<class_bool>` **flag_disable_z**
@@ -625,6 +689,8 @@ Align y-axis of particle with the direction of its velocity.
If ``true``, particles will not move on the z axis. Default value: ``false``. If ``true``, particles will not move on the z axis. Default value: ``false``.
----
.. _class_CPUParticles_property_flag_rotate_y: .. _class_CPUParticles_property_flag_rotate_y:
- :ref:`bool<class_bool>` **flag_rotate_y** - :ref:`bool<class_bool>` **flag_rotate_y**
@@ -637,6 +703,8 @@ If ``true``, particles will not move on the z axis. Default value: ``false``.
If ``true``, particles rotate around y-axis by :ref:`angle<class_CPUParticles_property_angle>`. If ``true``, particles rotate around y-axis by :ref:`angle<class_CPUParticles_property_angle>`.
----
.. _class_CPUParticles_property_flatness: .. _class_CPUParticles_property_flatness:
- :ref:`float<class_float>` **flatness** - :ref:`float<class_float>` **flatness**
@@ -649,6 +717,8 @@ If ``true``, particles rotate around y-axis by :ref:`angle<class_CPUParticles_pr
Amount of :ref:`spread<class_CPUParticles_property_spread>` in Y/Z plane. A value of ``1`` restricts particles to X/Z plane. Default ``0``. Amount of :ref:`spread<class_CPUParticles_property_spread>` in Y/Z plane. A value of ``1`` restricts particles to X/Z plane. Default ``0``.
----
.. _class_CPUParticles_property_fract_delta: .. _class_CPUParticles_property_fract_delta:
- :ref:`bool<class_bool>` **fract_delta** - :ref:`bool<class_bool>` **fract_delta**
@@ -661,6 +731,8 @@ Amount of :ref:`spread<class_CPUParticles_property_spread>` in Y/Z plane. A valu
If ``true``, results in fractional delta calculation which has a smoother particles display effect. Default value: ``true`` If ``true``, results in fractional delta calculation which has a smoother particles display effect. Default value: ``true``
----
.. _class_CPUParticles_property_gravity: .. _class_CPUParticles_property_gravity:
- :ref:`Vector3<class_Vector3>` **gravity** - :ref:`Vector3<class_Vector3>` **gravity**
@@ -673,6 +745,8 @@ If ``true``, results in fractional delta calculation which has a smoother partic
Gravity applied to every particle. Default value: ``(0, -9.8, 0)``. Gravity applied to every particle. Default value: ``(0, -9.8, 0)``.
----
.. _class_CPUParticles_property_hue_variation: .. _class_CPUParticles_property_hue_variation:
- :ref:`float<class_float>` **hue_variation** - :ref:`float<class_float>` **hue_variation**
@@ -685,6 +759,8 @@ Gravity applied to every particle. Default value: ``(0, -9.8, 0)``.
Initial hue variation applied to each particle. Initial hue variation applied to each particle.
----
.. _class_CPUParticles_property_hue_variation_curve: .. _class_CPUParticles_property_hue_variation_curve:
- :ref:`Curve<class_Curve>` **hue_variation_curve** - :ref:`Curve<class_Curve>` **hue_variation_curve**
@@ -697,6 +773,8 @@ Initial hue variation applied to each particle.
Each particle's hue will vary along this :ref:`Curve<class_Curve>`. Each particle's hue will vary along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles_property_hue_variation_random: .. _class_CPUParticles_property_hue_variation_random:
- :ref:`float<class_float>` **hue_variation_random** - :ref:`float<class_float>` **hue_variation_random**
@@ -709,6 +787,8 @@ Each particle's hue will vary along this :ref:`Curve<class_Curve>`.
Hue variation randomness ratio. Default value: ``0``. Hue variation randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles_property_initial_velocity: .. _class_CPUParticles_property_initial_velocity:
- :ref:`float<class_float>` **initial_velocity** - :ref:`float<class_float>` **initial_velocity**
@@ -721,6 +801,8 @@ Hue variation randomness ratio. Default value: ``0``.
Initial velocity magnitude for each particle. Direction comes from :ref:`spread<class_CPUParticles_property_spread>` and the node's orientation. Initial velocity magnitude for each particle. Direction comes from :ref:`spread<class_CPUParticles_property_spread>` and the node's orientation.
----
.. _class_CPUParticles_property_initial_velocity_random: .. _class_CPUParticles_property_initial_velocity_random:
- :ref:`float<class_float>` **initial_velocity_random** - :ref:`float<class_float>` **initial_velocity_random**
@@ -733,6 +815,8 @@ Initial velocity magnitude for each particle. Direction comes from :ref:`spread<
Initial velocity randomness ratio. Default value: ``0``. Initial velocity randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles_property_lifetime: .. _class_CPUParticles_property_lifetime:
- :ref:`float<class_float>` **lifetime** - :ref:`float<class_float>` **lifetime**
@@ -745,6 +829,8 @@ Initial velocity randomness ratio. Default value: ``0``.
Amount of time each particle will exist. Default value: ``1``. Amount of time each particle will exist. Default value: ``1``.
----
.. _class_CPUParticles_property_linear_accel: .. _class_CPUParticles_property_linear_accel:
- :ref:`float<class_float>` **linear_accel** - :ref:`float<class_float>` **linear_accel**
@@ -757,6 +843,8 @@ Amount of time each particle will exist. Default value: ``1``.
Linear acceleration applied to each particle in the direction of motion. Linear acceleration applied to each particle in the direction of motion.
----
.. _class_CPUParticles_property_linear_accel_curve: .. _class_CPUParticles_property_linear_accel_curve:
- :ref:`Curve<class_Curve>` **linear_accel_curve** - :ref:`Curve<class_Curve>` **linear_accel_curve**
@@ -769,6 +857,8 @@ Linear acceleration applied to each particle in the direction of motion.
Each particle's linear acceleration will vary along this :ref:`Curve<class_Curve>`. Each particle's linear acceleration will vary along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles_property_linear_accel_random: .. _class_CPUParticles_property_linear_accel_random:
- :ref:`float<class_float>` **linear_accel_random** - :ref:`float<class_float>` **linear_accel_random**
@@ -781,6 +871,8 @@ Each particle's linear acceleration will vary along this :ref:`Curve<class_Curve
Linear acceleration randomness ratio. Default value: ``0``. Linear acceleration randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles_property_local_coords: .. _class_CPUParticles_property_local_coords:
- :ref:`bool<class_bool>` **local_coords** - :ref:`bool<class_bool>` **local_coords**
@@ -793,6 +885,8 @@ Linear acceleration randomness ratio. Default value: ``0``.
If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. Default value: ``true``. If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. Default value: ``true``.
----
.. _class_CPUParticles_property_mesh: .. _class_CPUParticles_property_mesh:
- :ref:`Mesh<class_Mesh>` **mesh** - :ref:`Mesh<class_Mesh>` **mesh**
@@ -805,6 +899,8 @@ If ``true``, particles use the parent node's coordinate space. If ``false``, the
The :ref:`Mesh<class_Mesh>` used for each particle. If ``null``, particles will be spheres. The :ref:`Mesh<class_Mesh>` used for each particle. If ``null``, particles will be spheres.
----
.. _class_CPUParticles_property_one_shot: .. _class_CPUParticles_property_one_shot:
- :ref:`bool<class_bool>` **one_shot** - :ref:`bool<class_bool>` **one_shot**
@@ -817,6 +913,8 @@ The :ref:`Mesh<class_Mesh>` used for each particle. If ``null``, particles will
If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. Default value: ``false``. If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. Default value: ``false``.
----
.. _class_CPUParticles_property_preprocess: .. _class_CPUParticles_property_preprocess:
- :ref:`float<class_float>` **preprocess** - :ref:`float<class_float>` **preprocess**
@@ -829,6 +927,8 @@ If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emi
Particle system starts as if it had already run for this many seconds. Particle system starts as if it had already run for this many seconds.
----
.. _class_CPUParticles_property_radial_accel: .. _class_CPUParticles_property_radial_accel:
- :ref:`float<class_float>` **radial_accel** - :ref:`float<class_float>` **radial_accel**
@@ -841,6 +941,8 @@ Particle system starts as if it had already run for this many seconds.
Radial acceleration applied to each particle. Makes particle accelerate away from origin. Radial acceleration applied to each particle. Makes particle accelerate away from origin.
----
.. _class_CPUParticles_property_radial_accel_curve: .. _class_CPUParticles_property_radial_accel_curve:
- :ref:`Curve<class_Curve>` **radial_accel_curve** - :ref:`Curve<class_Curve>` **radial_accel_curve**
@@ -853,6 +955,8 @@ Radial acceleration applied to each particle. Makes particle accelerate away fro
Each particle's radial acceleration will vary along this :ref:`Curve<class_Curve>`. Each particle's radial acceleration will vary along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles_property_radial_accel_random: .. _class_CPUParticles_property_radial_accel_random:
- :ref:`float<class_float>` **radial_accel_random** - :ref:`float<class_float>` **radial_accel_random**
@@ -865,6 +969,8 @@ Each particle's radial acceleration will vary along this :ref:`Curve<class_Curve
Radial acceleration randomness ratio. Default value: ``0``. Radial acceleration randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles_property_randomness: .. _class_CPUParticles_property_randomness:
- :ref:`float<class_float>` **randomness** - :ref:`float<class_float>` **randomness**
@@ -877,6 +983,8 @@ Radial acceleration randomness ratio. Default value: ``0``.
Emission lifetime randomness ratio. Default value: ``0``. Emission lifetime randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles_property_scale_amount: .. _class_CPUParticles_property_scale_amount:
- :ref:`float<class_float>` **scale_amount** - :ref:`float<class_float>` **scale_amount**
@@ -889,6 +997,8 @@ Emission lifetime randomness ratio. Default value: ``0``.
Initial scale applied to each particle. Initial scale applied to each particle.
----
.. _class_CPUParticles_property_scale_amount_curve: .. _class_CPUParticles_property_scale_amount_curve:
- :ref:`Curve<class_Curve>` **scale_amount_curve** - :ref:`Curve<class_Curve>` **scale_amount_curve**
@@ -901,6 +1011,8 @@ Initial scale applied to each particle.
Each particle's scale will vary along this :ref:`Curve<class_Curve>`. Each particle's scale will vary along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles_property_scale_amount_random: .. _class_CPUParticles_property_scale_amount_random:
- :ref:`float<class_float>` **scale_amount_random** - :ref:`float<class_float>` **scale_amount_random**
@@ -913,6 +1025,8 @@ Each particle's scale will vary along this :ref:`Curve<class_Curve>`.
Scale randomness ratio. Default value: ``0``. Scale randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles_property_speed_scale: .. _class_CPUParticles_property_speed_scale:
- :ref:`float<class_float>` **speed_scale** - :ref:`float<class_float>` **speed_scale**
@@ -925,6 +1039,8 @@ Scale randomness ratio. Default value: ``0``.
Particle system's running speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. Particle system's running speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles.
----
.. _class_CPUParticles_property_spread: .. _class_CPUParticles_property_spread:
- :ref:`float<class_float>` **spread** - :ref:`float<class_float>` **spread**
@@ -937,6 +1053,8 @@ Particle system's running speed scaling ratio. Default value: ``1``. A value of
Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``. Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``.
----
.. _class_CPUParticles_property_tangential_accel: .. _class_CPUParticles_property_tangential_accel:
- :ref:`float<class_float>` **tangential_accel** - :ref:`float<class_float>` **tangential_accel**
@@ -949,6 +1067,8 @@ Each particle's initial direction range from ``+spread`` to ``-spread`` degrees.
Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.
----
.. _class_CPUParticles_property_tangential_accel_curve: .. _class_CPUParticles_property_tangential_accel_curve:
- :ref:`Curve<class_Curve>` **tangential_accel_curve** - :ref:`Curve<class_Curve>` **tangential_accel_curve**
@@ -961,6 +1081,8 @@ Tangential acceleration applied to each particle. Tangential acceleration is per
Each particle's tangential acceleration will vary along this :ref:`Curve<class_Curve>`. Each particle's tangential acceleration will vary along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles_property_tangential_accel_random: .. _class_CPUParticles_property_tangential_accel_random:
- :ref:`float<class_float>` **tangential_accel_random** - :ref:`float<class_float>` **tangential_accel_random**
@@ -982,6 +1104,8 @@ Method Descriptions
Sets this node's properties to match a given :ref:`Particles<class_Particles>` node with an assigned :ref:`ParticlesMaterial<class_ParticlesMaterial>`. Sets this node's properties to match a given :ref:`Particles<class_Particles>` node with an assigned :ref:`ParticlesMaterial<class_ParticlesMaterial>`.
----
.. _class_CPUParticles_method_restart: .. _class_CPUParticles_method_restart:
- void **restart** **(** **)** - void **restart** **(** **)**

122
classes/class_cpuparticles2d.rst
View File

@@ -163,6 +163,8 @@ enum **DrawOrder**:
- **DRAW_ORDER_LIFETIME** = **1** --- Particles are drawn in order of remaining lifetime. - **DRAW_ORDER_LIFETIME** = **1** --- Particles are drawn in order of remaining lifetime.
----
.. _enum_CPUParticles2D_Parameter: .. _enum_CPUParticles2D_Parameter:
.. _class_CPUParticles2D_constant_PARAM_INITIAL_LINEAR_VELOCITY: .. _class_CPUParticles2D_constant_PARAM_INITIAL_LINEAR_VELOCITY:
@@ -219,6 +221,8 @@ enum **Parameter**:
- **PARAM_MAX** = **12** --- Represents the size of the :ref:`Parameter<enum_CPUParticles2D_Parameter>` enum. - **PARAM_MAX** = **12** --- Represents the size of the :ref:`Parameter<enum_CPUParticles2D_Parameter>` enum.
----
.. _enum_CPUParticles2D_Flags: .. _enum_CPUParticles2D_Flags:
.. _class_CPUParticles2D_constant_FLAG_ALIGN_Y_TO_VELOCITY: .. _class_CPUParticles2D_constant_FLAG_ALIGN_Y_TO_VELOCITY:
@@ -231,6 +235,8 @@ enum **Flags**:
- **FLAG_MAX** = **1** - **FLAG_MAX** = **1**
----
.. _enum_CPUParticles2D_EmissionShape: .. _enum_CPUParticles2D_EmissionShape:
.. _class_CPUParticles2D_constant_EMISSION_SHAPE_POINT: .. _class_CPUParticles2D_constant_EMISSION_SHAPE_POINT:
@@ -282,6 +288,8 @@ Property Descriptions
Number of particles emitted in one emission cycle. Number of particles emitted in one emission cycle.
----
.. _class_CPUParticles2D_property_angle: .. _class_CPUParticles2D_property_angle:
- :ref:`float<class_float>` **angle** - :ref:`float<class_float>` **angle**
@@ -294,6 +302,8 @@ Number of particles emitted in one emission cycle.
Initial rotation applied to each particle, in degrees. Initial rotation applied to each particle, in degrees.
----
.. _class_CPUParticles2D_property_angle_curve: .. _class_CPUParticles2D_property_angle_curve:
- :ref:`Curve<class_Curve>` **angle_curve** - :ref:`Curve<class_Curve>` **angle_curve**
@@ -306,6 +316,8 @@ Initial rotation applied to each particle, in degrees.
Each particle's rotation will be animated along this :ref:`Curve<class_Curve>`. Each particle's rotation will be animated along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles2D_property_angle_random: .. _class_CPUParticles2D_property_angle_random:
- :ref:`float<class_float>` **angle_random** - :ref:`float<class_float>` **angle_random**
@@ -318,6 +330,8 @@ Each particle's rotation will be animated along this :ref:`Curve<class_Curve>`.
Rotation randomness ratio. Default value: ``0``. Rotation randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles2D_property_angular_velocity: .. _class_CPUParticles2D_property_angular_velocity:
- :ref:`float<class_float>` **angular_velocity** - :ref:`float<class_float>` **angular_velocity**
@@ -330,6 +344,8 @@ Rotation randomness ratio. Default value: ``0``.
Initial angular velocity applied to each particle. Sets the speed of rotation of the particle. Initial angular velocity applied to each particle. Sets the speed of rotation of the particle.
----
.. _class_CPUParticles2D_property_angular_velocity_curve: .. _class_CPUParticles2D_property_angular_velocity_curve:
- :ref:`Curve<class_Curve>` **angular_velocity_curve** - :ref:`Curve<class_Curve>` **angular_velocity_curve**
@@ -342,6 +358,8 @@ Initial angular velocity applied to each particle. Sets the speed of rotation of
Each particle's angular velocity will vary along this :ref:`Curve<class_Curve>`. Each particle's angular velocity will vary along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles2D_property_angular_velocity_random: .. _class_CPUParticles2D_property_angular_velocity_random:
- :ref:`float<class_float>` **angular_velocity_random** - :ref:`float<class_float>` **angular_velocity_random**
@@ -354,6 +372,8 @@ Each particle's angular velocity will vary along this :ref:`Curve<class_Curve>`.
Angular velocity randomness ratio. Default value: ``0``. Angular velocity randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles2D_property_anim_offset: .. _class_CPUParticles2D_property_anim_offset:
- :ref:`float<class_float>` **anim_offset** - :ref:`float<class_float>` **anim_offset**
@@ -366,6 +386,8 @@ Angular velocity randomness ratio. Default value: ``0``.
Particle animation offset. Particle animation offset.
----
.. _class_CPUParticles2D_property_anim_offset_curve: .. _class_CPUParticles2D_property_anim_offset_curve:
- :ref:`Curve<class_Curve>` **anim_offset_curve** - :ref:`Curve<class_Curve>` **anim_offset_curve**
@@ -378,6 +400,8 @@ Particle animation offset.
Each particle's animation offset will vary along this :ref:`Curve<class_Curve>`. Each particle's animation offset will vary along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles2D_property_anim_offset_random: .. _class_CPUParticles2D_property_anim_offset_random:
- :ref:`float<class_float>` **anim_offset_random** - :ref:`float<class_float>` **anim_offset_random**
@@ -390,6 +414,8 @@ Each particle's animation offset will vary along this :ref:`Curve<class_Curve>`.
Animation offset randomness ratio. Default value: ``0``. Animation offset randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles2D_property_anim_speed: .. _class_CPUParticles2D_property_anim_speed:
- :ref:`float<class_float>` **anim_speed** - :ref:`float<class_float>` **anim_speed**
@@ -402,6 +428,8 @@ Animation offset randomness ratio. Default value: ``0``.
Particle animation speed. Particle animation speed.
----
.. _class_CPUParticles2D_property_anim_speed_curve: .. _class_CPUParticles2D_property_anim_speed_curve:
- :ref:`Curve<class_Curve>` **anim_speed_curve** - :ref:`Curve<class_Curve>` **anim_speed_curve**
@@ -414,6 +442,8 @@ Particle animation speed.
Each particle's animation speed will vary along this :ref:`Curve<class_Curve>`. Each particle's animation speed will vary along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles2D_property_anim_speed_random: .. _class_CPUParticles2D_property_anim_speed_random:
- :ref:`float<class_float>` **anim_speed_random** - :ref:`float<class_float>` **anim_speed_random**
@@ -426,6 +456,8 @@ Each particle's animation speed will vary along this :ref:`Curve<class_Curve>`.
Animation speed randomness ratio. Default value: ``0``. Animation speed randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles2D_property_color: .. _class_CPUParticles2D_property_color:
- :ref:`Color<class_Color>` **color** - :ref:`Color<class_Color>` **color**
@@ -438,6 +470,8 @@ Animation speed randomness ratio. Default value: ``0``.
Each particle's initial color. If :ref:`texture<class_CPUParticles2D_property_texture>` is defined, it will be multiplied by this color. Each particle's initial color. If :ref:`texture<class_CPUParticles2D_property_texture>` is defined, it will be multiplied by this color.
----
.. _class_CPUParticles2D_property_color_ramp: .. _class_CPUParticles2D_property_color_ramp:
- :ref:`Gradient<class_Gradient>` **color_ramp** - :ref:`Gradient<class_Gradient>` **color_ramp**
@@ -450,6 +484,8 @@ Each particle's initial color. If :ref:`texture<class_CPUParticles2D_property_te
Each particle's color will vary along this :ref:`Gradient<class_Gradient>`. Each particle's color will vary along this :ref:`Gradient<class_Gradient>`.
----
.. _class_CPUParticles2D_property_damping: .. _class_CPUParticles2D_property_damping:
- :ref:`float<class_float>` **damping** - :ref:`float<class_float>` **damping**
@@ -462,6 +498,8 @@ Each particle's color will vary along this :ref:`Gradient<class_Gradient>`.
The rate at which particles lose velocity. The rate at which particles lose velocity.
----
.. _class_CPUParticles2D_property_damping_curve: .. _class_CPUParticles2D_property_damping_curve:
- :ref:`Curve<class_Curve>` **damping_curve** - :ref:`Curve<class_Curve>` **damping_curve**
@@ -474,6 +512,8 @@ The rate at which particles lose velocity.
Damping will vary along this :ref:`Curve<class_Curve>`. Damping will vary along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles2D_property_damping_random: .. _class_CPUParticles2D_property_damping_random:
- :ref:`float<class_float>` **damping_random** - :ref:`float<class_float>` **damping_random**
@@ -486,6 +526,8 @@ Damping will vary along this :ref:`Curve<class_Curve>`.
Damping randomness ratio. Default value: ``0``. Damping randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles2D_property_draw_order: .. _class_CPUParticles2D_property_draw_order:
- :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` **draw_order** - :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` **draw_order**
@@ -498,6 +540,8 @@ Damping randomness ratio. Default value: ``0``.
Particle draw order. Uses :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` values. Default value: :ref:`DRAW_ORDER_INDEX<class_CPUParticles2D_constant_DRAW_ORDER_INDEX>`. Particle draw order. Uses :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` values. Default value: :ref:`DRAW_ORDER_INDEX<class_CPUParticles2D_constant_DRAW_ORDER_INDEX>`.
----
.. _class_CPUParticles2D_property_emission_colors: .. _class_CPUParticles2D_property_emission_colors:
- :ref:`PoolColorArray<class_PoolColorArray>` **emission_colors** - :ref:`PoolColorArray<class_PoolColorArray>` **emission_colors**
@@ -508,6 +552,8 @@ Particle draw order. Uses :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` values
| *Getter* | get_emission_colors() | | *Getter* | get_emission_colors() |
+----------+----------------------------+ +----------+----------------------------+
----
.. _class_CPUParticles2D_property_emission_normals: .. _class_CPUParticles2D_property_emission_normals:
- :ref:`PoolVector2Array<class_PoolVector2Array>` **emission_normals** - :ref:`PoolVector2Array<class_PoolVector2Array>` **emission_normals**
@@ -518,6 +564,8 @@ Particle draw order. Uses :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` values
| *Getter* | get_emission_normals() | | *Getter* | get_emission_normals() |
+----------+-----------------------------+ +----------+-----------------------------+
----
.. _class_CPUParticles2D_property_emission_points: .. _class_CPUParticles2D_property_emission_points:
- :ref:`PoolVector2Array<class_PoolVector2Array>` **emission_points** - :ref:`PoolVector2Array<class_PoolVector2Array>` **emission_points**
@@ -528,6 +576,8 @@ Particle draw order. Uses :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` values
| *Getter* | get_emission_points() | | *Getter* | get_emission_points() |
+----------+----------------------------+ +----------+----------------------------+
----
.. _class_CPUParticles2D_property_emission_rect_extents: .. _class_CPUParticles2D_property_emission_rect_extents:
- :ref:`Vector2<class_Vector2>` **emission_rect_extents** - :ref:`Vector2<class_Vector2>` **emission_rect_extents**
@@ -540,6 +590,8 @@ Particle draw order. Uses :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` values
The rectangle's extents if :ref:`emission_shape<class_CPUParticles2D_property_emission_shape>` is set to :ref:`EMISSION_SHAPE_RECTANGLE<class_CPUParticles2D_constant_EMISSION_SHAPE_RECTANGLE>`. The rectangle's extents if :ref:`emission_shape<class_CPUParticles2D_property_emission_shape>` is set to :ref:`EMISSION_SHAPE_RECTANGLE<class_CPUParticles2D_constant_EMISSION_SHAPE_RECTANGLE>`.
----
.. _class_CPUParticles2D_property_emission_shape: .. _class_CPUParticles2D_property_emission_shape:
- :ref:`EmissionShape<enum_CPUParticles2D_EmissionShape>` **emission_shape** - :ref:`EmissionShape<enum_CPUParticles2D_EmissionShape>` **emission_shape**
@@ -552,6 +604,8 @@ The rectangle's extents if :ref:`emission_shape<class_CPUParticles2D_property_em
Particles will be emitted inside this region. Use :ref:`EmissionShape<enum_CPUParticles2D_EmissionShape>` for values. Default value: :ref:`EMISSION_SHAPE_POINT<class_CPUParticles2D_constant_EMISSION_SHAPE_POINT>`. Particles will be emitted inside this region. Use :ref:`EmissionShape<enum_CPUParticles2D_EmissionShape>` for values. Default value: :ref:`EMISSION_SHAPE_POINT<class_CPUParticles2D_constant_EMISSION_SHAPE_POINT>`.
----
.. _class_CPUParticles2D_property_emission_sphere_radius: .. _class_CPUParticles2D_property_emission_sphere_radius:
- :ref:`float<class_float>` **emission_sphere_radius** - :ref:`float<class_float>` **emission_sphere_radius**
@@ -564,6 +618,8 @@ Particles will be emitted inside this region. Use :ref:`EmissionShape<enum_CPUPa
The circle's radius if :ref:`emission_shape<class_CPUParticles2D_property_emission_shape>` is set to :ref:`EMISSION_SHAPE_CIRCLE<class_CPUParticles2D_constant_EMISSION_SHAPE_CIRCLE>`. The circle's radius if :ref:`emission_shape<class_CPUParticles2D_property_emission_shape>` is set to :ref:`EMISSION_SHAPE_CIRCLE<class_CPUParticles2D_constant_EMISSION_SHAPE_CIRCLE>`.
----
.. _class_CPUParticles2D_property_emitting: .. _class_CPUParticles2D_property_emitting:
- :ref:`bool<class_bool>` **emitting** - :ref:`bool<class_bool>` **emitting**
@@ -576,6 +632,8 @@ The circle's radius if :ref:`emission_shape<class_CPUParticles2D_property_emissi
If ``true``, particles are being emitted. Default value: ``true``. If ``true``, particles are being emitted. Default value: ``true``.
----
.. _class_CPUParticles2D_property_explosiveness: .. _class_CPUParticles2D_property_explosiveness:
- :ref:`float<class_float>` **explosiveness** - :ref:`float<class_float>` **explosiveness**
@@ -588,6 +646,8 @@ If ``true``, particles are being emitted. Default value: ``true``.
How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. Default value: ``0``. How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. Default value: ``0``.
----
.. _class_CPUParticles2D_property_fixed_fps: .. _class_CPUParticles2D_property_fixed_fps:
- :ref:`int<class_int>` **fixed_fps** - :ref:`int<class_int>` **fixed_fps**
@@ -600,6 +660,8 @@ How rapidly particles in an emission cycle are emitted. If greater than ``0``, t
The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself.
----
.. _class_CPUParticles2D_property_flag_align_y: .. _class_CPUParticles2D_property_flag_align_y:
- :ref:`bool<class_bool>` **flag_align_y** - :ref:`bool<class_bool>` **flag_align_y**
@@ -612,6 +674,8 @@ The particle system's frame rate is fixed to a value. For instance, changing the
Align y-axis of particle with the direction of its velocity. Align y-axis of particle with the direction of its velocity.
----
.. _class_CPUParticles2D_property_flatness: .. _class_CPUParticles2D_property_flatness:
- :ref:`float<class_float>` **flatness** - :ref:`float<class_float>` **flatness**
@@ -622,6 +686,8 @@ Align y-axis of particle with the direction of its velocity.
| *Getter* | get_flatness() | | *Getter* | get_flatness() |
+----------+---------------------+ +----------+---------------------+
----
.. _class_CPUParticles2D_property_fract_delta: .. _class_CPUParticles2D_property_fract_delta:
- :ref:`bool<class_bool>` **fract_delta** - :ref:`bool<class_bool>` **fract_delta**
@@ -634,6 +700,8 @@ Align y-axis of particle with the direction of its velocity.
If ``true``, results in fractional delta calculation which has a smoother particles display effect. Default value: ``true`` If ``true``, results in fractional delta calculation which has a smoother particles display effect. Default value: ``true``
----
.. _class_CPUParticles2D_property_gravity: .. _class_CPUParticles2D_property_gravity:
- :ref:`Vector2<class_Vector2>` **gravity** - :ref:`Vector2<class_Vector2>` **gravity**
@@ -646,6 +714,8 @@ If ``true``, results in fractional delta calculation which has a smoother partic
Gravity applied to every particle. Default value: ``(0, 98)``. Gravity applied to every particle. Default value: ``(0, 98)``.
----
.. _class_CPUParticles2D_property_hue_variation: .. _class_CPUParticles2D_property_hue_variation:
- :ref:`float<class_float>` **hue_variation** - :ref:`float<class_float>` **hue_variation**
@@ -658,6 +728,8 @@ Gravity applied to every particle. Default value: ``(0, 98)``.
Initial hue variation applied to each particle. Initial hue variation applied to each particle.
----
.. _class_CPUParticles2D_property_hue_variation_curve: .. _class_CPUParticles2D_property_hue_variation_curve:
- :ref:`Curve<class_Curve>` **hue_variation_curve** - :ref:`Curve<class_Curve>` **hue_variation_curve**
@@ -670,6 +742,8 @@ Initial hue variation applied to each particle.
Each particle's hue will vary along this :ref:`Curve<class_Curve>`. Each particle's hue will vary along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles2D_property_hue_variation_random: .. _class_CPUParticles2D_property_hue_variation_random:
- :ref:`float<class_float>` **hue_variation_random** - :ref:`float<class_float>` **hue_variation_random**
@@ -682,6 +756,8 @@ Each particle's hue will vary along this :ref:`Curve<class_Curve>`.
Hue variation randomness ratio. Default value: ``0``. Hue variation randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles2D_property_initial_velocity: .. _class_CPUParticles2D_property_initial_velocity:
- :ref:`float<class_float>` **initial_velocity** - :ref:`float<class_float>` **initial_velocity**
@@ -694,6 +770,8 @@ Hue variation randomness ratio. Default value: ``0``.
Initial velocity magnitude for each particle. Direction comes from :ref:`spread<class_CPUParticles2D_property_spread>` and the node's orientation. Initial velocity magnitude for each particle. Direction comes from :ref:`spread<class_CPUParticles2D_property_spread>` and the node's orientation.
----
.. _class_CPUParticles2D_property_initial_velocity_random: .. _class_CPUParticles2D_property_initial_velocity_random:
- :ref:`float<class_float>` **initial_velocity_random** - :ref:`float<class_float>` **initial_velocity_random**
@@ -706,6 +784,8 @@ Initial velocity magnitude for each particle. Direction comes from :ref:`spread<
Initial velocity randomness ratio. Default value: ``0``. Initial velocity randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles2D_property_lifetime: .. _class_CPUParticles2D_property_lifetime:
- :ref:`float<class_float>` **lifetime** - :ref:`float<class_float>` **lifetime**
@@ -718,6 +798,8 @@ Initial velocity randomness ratio. Default value: ``0``.
Amount of time each particle will exist. Default value: ``1``. Amount of time each particle will exist. Default value: ``1``.
----
.. _class_CPUParticles2D_property_linear_accel: .. _class_CPUParticles2D_property_linear_accel:
- :ref:`float<class_float>` **linear_accel** - :ref:`float<class_float>` **linear_accel**
@@ -730,6 +812,8 @@ Amount of time each particle will exist. Default value: ``1``.
Linear acceleration applied to each particle in the direction of motion. Linear acceleration applied to each particle in the direction of motion.
----
.. _class_CPUParticles2D_property_linear_accel_curve: .. _class_CPUParticles2D_property_linear_accel_curve:
- :ref:`Curve<class_Curve>` **linear_accel_curve** - :ref:`Curve<class_Curve>` **linear_accel_curve**
@@ -742,6 +826,8 @@ Linear acceleration applied to each particle in the direction of motion.
Each particle's linear acceleration will vary along this :ref:`Curve<class_Curve>`. Each particle's linear acceleration will vary along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles2D_property_linear_accel_random: .. _class_CPUParticles2D_property_linear_accel_random:
- :ref:`float<class_float>` **linear_accel_random** - :ref:`float<class_float>` **linear_accel_random**
@@ -754,6 +840,8 @@ Each particle's linear acceleration will vary along this :ref:`Curve<class_Curve
Linear acceleration randomness ratio. Default value: ``0``. Linear acceleration randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles2D_property_local_coords: .. _class_CPUParticles2D_property_local_coords:
- :ref:`bool<class_bool>` **local_coords** - :ref:`bool<class_bool>` **local_coords**
@@ -766,6 +854,8 @@ Linear acceleration randomness ratio. Default value: ``0``.
If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. Default value: ``true``. If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. Default value: ``true``.
----
.. _class_CPUParticles2D_property_normalmap: .. _class_CPUParticles2D_property_normalmap:
- :ref:`Texture<class_Texture>` **normalmap** - :ref:`Texture<class_Texture>` **normalmap**
@@ -778,6 +868,8 @@ If ``true``, particles use the parent node's coordinate space. If ``false``, the
Normal map to be used for the :ref:`texture<class_CPUParticles2D_property_texture>` property. Normal map to be used for the :ref:`texture<class_CPUParticles2D_property_texture>` property.
----
.. _class_CPUParticles2D_property_one_shot: .. _class_CPUParticles2D_property_one_shot:
- :ref:`bool<class_bool>` **one_shot** - :ref:`bool<class_bool>` **one_shot**
@@ -790,6 +882,8 @@ Normal map to be used for the :ref:`texture<class_CPUParticles2D_property_textur
If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. Default value: ``false``. If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. Default value: ``false``.
----
.. _class_CPUParticles2D_property_preprocess: .. _class_CPUParticles2D_property_preprocess:
- :ref:`float<class_float>` **preprocess** - :ref:`float<class_float>` **preprocess**
@@ -802,6 +896,8 @@ If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emi
Particle system starts as if it had already run for this many seconds. Particle system starts as if it had already run for this many seconds.
----
.. _class_CPUParticles2D_property_radial_accel: .. _class_CPUParticles2D_property_radial_accel:
- :ref:`float<class_float>` **radial_accel** - :ref:`float<class_float>` **radial_accel**
@@ -814,6 +910,8 @@ Particle system starts as if it had already run for this many seconds.
Radial acceleration applied to each particle. Makes particle accelerate away from origin. Radial acceleration applied to each particle. Makes particle accelerate away from origin.
----
.. _class_CPUParticles2D_property_radial_accel_curve: .. _class_CPUParticles2D_property_radial_accel_curve:
- :ref:`Curve<class_Curve>` **radial_accel_curve** - :ref:`Curve<class_Curve>` **radial_accel_curve**
@@ -826,6 +924,8 @@ Radial acceleration applied to each particle. Makes particle accelerate away fro
Each particle's radial acceleration will vary along this :ref:`Curve<class_Curve>`. Each particle's radial acceleration will vary along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles2D_property_radial_accel_random: .. _class_CPUParticles2D_property_radial_accel_random:
- :ref:`float<class_float>` **radial_accel_random** - :ref:`float<class_float>` **radial_accel_random**
@@ -838,6 +938,8 @@ Each particle's radial acceleration will vary along this :ref:`Curve<class_Curve
Radial acceleration randomness ratio. Default value: ``0``. Radial acceleration randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles2D_property_randomness: .. _class_CPUParticles2D_property_randomness:
- :ref:`float<class_float>` **randomness** - :ref:`float<class_float>` **randomness**
@@ -850,6 +952,8 @@ Radial acceleration randomness ratio. Default value: ``0``.
Emission lifetime randomness ratio. Default value: ``0``. Emission lifetime randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles2D_property_scale_amount: .. _class_CPUParticles2D_property_scale_amount:
- :ref:`float<class_float>` **scale_amount** - :ref:`float<class_float>` **scale_amount**
@@ -862,6 +966,8 @@ Emission lifetime randomness ratio. Default value: ``0``.
Initial scale applied to each particle. Initial scale applied to each particle.
----
.. _class_CPUParticles2D_property_scale_amount_curve: .. _class_CPUParticles2D_property_scale_amount_curve:
- :ref:`Curve<class_Curve>` **scale_amount_curve** - :ref:`Curve<class_Curve>` **scale_amount_curve**
@@ -874,6 +980,8 @@ Initial scale applied to each particle.
Each particle's scale will vary along this :ref:`Curve<class_Curve>`. Each particle's scale will vary along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles2D_property_scale_amount_random: .. _class_CPUParticles2D_property_scale_amount_random:
- :ref:`float<class_float>` **scale_amount_random** - :ref:`float<class_float>` **scale_amount_random**
@@ -886,6 +994,8 @@ Each particle's scale will vary along this :ref:`Curve<class_Curve>`.
Scale randomness ratio. Default value: ``0``. Scale randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles2D_property_speed_scale: .. _class_CPUParticles2D_property_speed_scale:
- :ref:`float<class_float>` **speed_scale** - :ref:`float<class_float>` **speed_scale**
@@ -898,6 +1008,8 @@ Scale randomness ratio. Default value: ``0``.
Particle system's running speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. Particle system's running speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles.
----
.. _class_CPUParticles2D_property_spread: .. _class_CPUParticles2D_property_spread:
- :ref:`float<class_float>` **spread** - :ref:`float<class_float>` **spread**
@@ -910,6 +1022,8 @@ Particle system's running speed scaling ratio. Default value: ``1``. A value of
Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``. Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``.
----
.. _class_CPUParticles2D_property_tangential_accel: .. _class_CPUParticles2D_property_tangential_accel:
- :ref:`float<class_float>` **tangential_accel** - :ref:`float<class_float>` **tangential_accel**
@@ -922,6 +1036,8 @@ Each particle's initial direction range from ``+spread`` to ``-spread`` degrees.
Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.
----
.. _class_CPUParticles2D_property_tangential_accel_curve: .. _class_CPUParticles2D_property_tangential_accel_curve:
- :ref:`Curve<class_Curve>` **tangential_accel_curve** - :ref:`Curve<class_Curve>` **tangential_accel_curve**
@@ -934,6 +1050,8 @@ Tangential acceleration applied to each particle. Tangential acceleration is per
Each particle's tangential acceleration will vary along this :ref:`Curve<class_Curve>`. Each particle's tangential acceleration will vary along this :ref:`Curve<class_Curve>`.
----
.. _class_CPUParticles2D_property_tangential_accel_random: .. _class_CPUParticles2D_property_tangential_accel_random:
- :ref:`float<class_float>` **tangential_accel_random** - :ref:`float<class_float>` **tangential_accel_random**
@@ -946,6 +1064,8 @@ Each particle's tangential acceleration will vary along this :ref:`Curve<class_C
Tangential acceleration randomness ratio. Default value: ``0``. Tangential acceleration randomness ratio. Default value: ``0``.
----
.. _class_CPUParticles2D_property_texture: .. _class_CPUParticles2D_property_texture:
- :ref:`Texture<class_Texture>` **texture** - :ref:`Texture<class_Texture>` **texture**
@@ -967,6 +1087,8 @@ Method Descriptions
Sets this node's properties to match a given :ref:`Particles2D<class_Particles2D>` node with an assigned :ref:`ParticlesMaterial<class_ParticlesMaterial>`. Sets this node's properties to match a given :ref:`Particles2D<class_Particles2D>` node with an assigned :ref:`ParticlesMaterial<class_ParticlesMaterial>`.
----
.. _class_CPUParticles2D_method_restart: .. _class_CPUParticles2D_method_restart:
- void **restart** **(** **)** - void **restart** **(** **)**

6
classes/class_csgbox.rst
View File

@@ -51,6 +51,8 @@ Property Descriptions
Depth of the box measured from the center of the box. Depth of the box measured from the center of the box.
----
.. _class_CSGBox_property_height: .. _class_CSGBox_property_height:
- :ref:`float<class_float>` **height** - :ref:`float<class_float>` **height**
@@ -63,6 +65,8 @@ Depth of the box measured from the center of the box.
Height of the box measured from the center of the box. Height of the box measured from the center of the box.
----
.. _class_CSGBox_property_material: .. _class_CSGBox_property_material:
- :ref:`Material<class_Material>` **material** - :ref:`Material<class_Material>` **material**
@@ -75,6 +79,8 @@ Height of the box measured from the center of the box.
The material used to render the box. The material used to render the box.
----
.. _class_CSGBox_property_width: .. _class_CSGBox_property_width:
- :ref:`float<class_float>` **width** - :ref:`float<class_float>` **width**

10
classes/class_csgcylinder.rst
View File

@@ -55,6 +55,8 @@ Property Descriptions
If ``true`` a cone is created, the :ref:`radius<class_CSGCylinder_property_radius>` will only apply to one side. If ``true`` a cone is created, the :ref:`radius<class_CSGCylinder_property_radius>` will only apply to one side.
----
.. _class_CSGCylinder_property_height: .. _class_CSGCylinder_property_height:
- :ref:`float<class_float>` **height** - :ref:`float<class_float>` **height**
@@ -67,6 +69,8 @@ If ``true`` a cone is created, the :ref:`radius<class_CSGCylinder_property_radiu
The height of the cylinder. The height of the cylinder.
----
.. _class_CSGCylinder_property_material: .. _class_CSGCylinder_property_material:
- :ref:`Material<class_Material>` **material** - :ref:`Material<class_Material>` **material**
@@ -79,6 +83,8 @@ The height of the cylinder.
The material used to render the cylinder. The material used to render the cylinder.
----
.. _class_CSGCylinder_property_radius: .. _class_CSGCylinder_property_radius:
- :ref:`float<class_float>` **radius** - :ref:`float<class_float>` **radius**
@@ -91,6 +97,8 @@ The material used to render the cylinder.
The radius of the cylinder. The radius of the cylinder.
----
.. _class_CSGCylinder_property_sides: .. _class_CSGCylinder_property_sides:
- :ref:`int<class_int>` **sides** - :ref:`int<class_int>` **sides**
@@ -103,6 +111,8 @@ The radius of the cylinder.
The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder. The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder.
----
.. _class_CSGCylinder_property_smooth_faces: .. _class_CSGCylinder_property_smooth_faces:
- :ref:`bool<class_bool>` **smooth_faces** - :ref:`bool<class_bool>` **smooth_faces**

26
classes/class_csgpolygon.rst
View File

@@ -68,6 +68,8 @@ enum **Mode**:
- **MODE_PATH** = **2** --- Shape is extruded along a path set by a :ref:`Shape<class_Shape>` set in :ref:`path_node<class_CSGPolygon_property_path_node>`. - **MODE_PATH** = **2** --- Shape is extruded along a path set by a :ref:`Shape<class_Shape>` set in :ref:`path_node<class_CSGPolygon_property_path_node>`.
----
.. _enum_CSGPolygon_PathRotation: .. _enum_CSGPolygon_PathRotation:
.. _class_CSGPolygon_constant_PATH_ROTATION_POLYGON: .. _class_CSGPolygon_constant_PATH_ROTATION_POLYGON:
@@ -104,6 +106,8 @@ Property Descriptions
Extrusion depth when :ref:`mode<class_CSGPolygon_property_mode>` is :ref:`MODE_DEPTH<class_CSGPolygon_constant_MODE_DEPTH>`. Extrusion depth when :ref:`mode<class_CSGPolygon_property_mode>` is :ref:`MODE_DEPTH<class_CSGPolygon_constant_MODE_DEPTH>`.
----
.. _class_CSGPolygon_property_material: .. _class_CSGPolygon_property_material:
- :ref:`Material<class_Material>` **material** - :ref:`Material<class_Material>` **material**
@@ -116,6 +120,8 @@ Extrusion depth when :ref:`mode<class_CSGPolygon_property_mode>` is :ref:`MODE_D
Material to use for the resulting mesh. Material to use for the resulting mesh.
----
.. _class_CSGPolygon_property_mode: .. _class_CSGPolygon_property_mode:
- :ref:`Mode<enum_CSGPolygon_Mode>` **mode** - :ref:`Mode<enum_CSGPolygon_Mode>` **mode**
@@ -128,6 +134,8 @@ Material to use for the resulting mesh.
Extrusion mode. Extrusion mode.
----
.. _class_CSGPolygon_property_path_continuous_u: .. _class_CSGPolygon_property_path_continuous_u:
- :ref:`bool<class_bool>` **path_continuous_u** - :ref:`bool<class_bool>` **path_continuous_u**
@@ -140,6 +148,8 @@ Extrusion mode.
If ``true`` the u component of our uv will continuously increase in unison with the distance traveled along our path when :ref:`mode<class_CSGPolygon_property_mode>` is :ref:`MODE_PATH<class_CSGPolygon_constant_MODE_PATH>`. If ``true`` the u component of our uv will continuously increase in unison with the distance traveled along our path when :ref:`mode<class_CSGPolygon_property_mode>` is :ref:`MODE_PATH<class_CSGPolygon_constant_MODE_PATH>`.
----
.. _class_CSGPolygon_property_path_interval: .. _class_CSGPolygon_property_path_interval:
- :ref:`float<class_float>` **path_interval** - :ref:`float<class_float>` **path_interval**
@@ -152,6 +162,8 @@ If ``true`` the u component of our uv will continuously increase in unison with
Interval at which a new extrusion slice is added along the path when :ref:`mode<class_CSGPolygon_property_mode>` is :ref:`MODE_PATH<class_CSGPolygon_constant_MODE_PATH>`. Interval at which a new extrusion slice is added along the path when :ref:`mode<class_CSGPolygon_property_mode>` is :ref:`MODE_PATH<class_CSGPolygon_constant_MODE_PATH>`.
----
.. _class_CSGPolygon_property_path_joined: .. _class_CSGPolygon_property_path_joined:
- :ref:`bool<class_bool>` **path_joined** - :ref:`bool<class_bool>` **path_joined**
@@ -164,6 +176,8 @@ Interval at which a new extrusion slice is added along the path when :ref:`mode<
If ``true`` the start and end of our path are joined together ensuring there is no seam when :ref:`mode<class_CSGPolygon_property_mode>` is :ref:`MODE_PATH<class_CSGPolygon_constant_MODE_PATH>`. If ``true`` the start and end of our path are joined together ensuring there is no seam when :ref:`mode<class_CSGPolygon_property_mode>` is :ref:`MODE_PATH<class_CSGPolygon_constant_MODE_PATH>`.
----
.. _class_CSGPolygon_property_path_local: .. _class_CSGPolygon_property_path_local:
- :ref:`bool<class_bool>` **path_local** - :ref:`bool<class_bool>` **path_local**
@@ -176,6 +190,8 @@ If ``true`` the start and end of our path are joined together ensuring there is
If ``false`` we extrude centered on our path, if ``true`` we extrude in relation to the position of our CSGPolygon when :ref:`mode<class_CSGPolygon_property_mode>` is :ref:`MODE_PATH<class_CSGPolygon_constant_MODE_PATH>`. If ``false`` we extrude centered on our path, if ``true`` we extrude in relation to the position of our CSGPolygon when :ref:`mode<class_CSGPolygon_property_mode>` is :ref:`MODE_PATH<class_CSGPolygon_constant_MODE_PATH>`.
----
.. _class_CSGPolygon_property_path_node: .. _class_CSGPolygon_property_path_node:
- :ref:`NodePath<class_NodePath>` **path_node** - :ref:`NodePath<class_NodePath>` **path_node**
@@ -188,6 +204,8 @@ If ``false`` we extrude centered on our path, if ``true`` we extrude in relation
The :ref:`Shape<class_Shape>` object containing the path along which we extrude when :ref:`mode<class_CSGPolygon_property_mode>` is :ref:`MODE_PATH<class_CSGPolygon_constant_MODE_PATH>`. The :ref:`Shape<class_Shape>` object containing the path along which we extrude when :ref:`mode<class_CSGPolygon_property_mode>` is :ref:`MODE_PATH<class_CSGPolygon_constant_MODE_PATH>`.
----
.. _class_CSGPolygon_property_path_rotation: .. _class_CSGPolygon_property_path_rotation:
- :ref:`PathRotation<enum_CSGPolygon_PathRotation>` **path_rotation** - :ref:`PathRotation<enum_CSGPolygon_PathRotation>` **path_rotation**
@@ -200,6 +218,8 @@ The :ref:`Shape<class_Shape>` object containing the path along which we extrude
The method by which each slice is rotated along the path when :ref:`mode<class_CSGPolygon_property_mode>` is :ref:`MODE_PATH<class_CSGPolygon_constant_MODE_PATH>`. The method by which each slice is rotated along the path when :ref:`mode<class_CSGPolygon_property_mode>` is :ref:`MODE_PATH<class_CSGPolygon_constant_MODE_PATH>`.
----
.. _class_CSGPolygon_property_polygon: .. _class_CSGPolygon_property_polygon:
- :ref:`PoolVector2Array<class_PoolVector2Array>` **polygon** - :ref:`PoolVector2Array<class_PoolVector2Array>` **polygon**
@@ -212,6 +232,8 @@ The method by which each slice is rotated along the path when :ref:`mode<class_C
Point array that defines the shape that we'll extrude. Point array that defines the shape that we'll extrude.
----
.. _class_CSGPolygon_property_smooth_faces: .. _class_CSGPolygon_property_smooth_faces:
- :ref:`bool<class_bool>` **smooth_faces** - :ref:`bool<class_bool>` **smooth_faces**
@@ -224,6 +246,8 @@ Point array that defines the shape that we'll extrude.
Generates smooth normals so smooth shading is applied to our mesh. Generates smooth normals so smooth shading is applied to our mesh.
----
.. _class_CSGPolygon_property_spin_degrees: .. _class_CSGPolygon_property_spin_degrees:
- :ref:`float<class_float>` **spin_degrees** - :ref:`float<class_float>` **spin_degrees**
@@ -236,6 +260,8 @@ Generates smooth normals so smooth shading is applied to our mesh.
Degrees to rotate our extrusion for each slice when :ref:`mode<class_CSGPolygon_property_mode>` is :ref:`MODE_SPIN<class_CSGPolygon_constant_MODE_SPIN>`. Degrees to rotate our extrusion for each slice when :ref:`mode<class_CSGPolygon_property_mode>` is :ref:`MODE_SPIN<class_CSGPolygon_constant_MODE_SPIN>`.
----
.. _class_CSGPolygon_property_spin_sides: .. _class_CSGPolygon_property_spin_sides:
- :ref:`int<class_int>` **spin_sides** - :ref:`int<class_int>` **spin_sides**

20
classes/class_csgshape.rst
View File

@@ -93,6 +93,8 @@ Property Descriptions
Calculate tangents for the CSG shape which allows the use of normal maps. This is only applied on the root shape, this setting is ignored on any child. Calculate tangents for the CSG shape which allows the use of normal maps. This is only applied on the root shape, this setting is ignored on any child.
----
.. _class_CSGShape_property_collision_layer: .. _class_CSGShape_property_collision_layer:
- :ref:`int<class_int>` **collision_layer** - :ref:`int<class_int>` **collision_layer**
@@ -109,6 +111,8 @@ Collidable objects can exist in any of 32 different layers. These layers work li
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. 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_CSGShape_property_collision_mask: .. _class_CSGShape_property_collision_mask:
- :ref:`int<class_int>` **collision_mask** - :ref:`int<class_int>` **collision_mask**
@@ -121,6 +125,8 @@ A contact is detected if object A is in any of the layers that object B scans, o
The physics layers this CSG shape scans for collisions. The physics layers this CSG shape scans for collisions.
----
.. _class_CSGShape_property_operation: .. _class_CSGShape_property_operation:
- :ref:`Operation<enum_CSGShape_Operation>` **operation** - :ref:`Operation<enum_CSGShape_Operation>` **operation**
@@ -133,6 +139,8 @@ The physics layers this CSG shape scans for collisions.
The operation that is performed on this shape. This is ignored for the first CSG child node as the operation is between this node and the previous child of this nodes parent. The operation that is performed on this shape. This is ignored for the first CSG child node as the operation is between this node and the previous child of this nodes parent.
----
.. _class_CSGShape_property_snap: .. _class_CSGShape_property_snap:
- :ref:`float<class_float>` **snap** - :ref:`float<class_float>` **snap**
@@ -143,6 +151,8 @@ The operation that is performed on this shape. This is ignored for the first CSG
| *Getter* | get_snap() | | *Getter* | get_snap() |
+----------+-----------------+ +----------+-----------------+
----
.. _class_CSGShape_property_use_collision: .. _class_CSGShape_property_use_collision:
- :ref:`bool<class_bool>` **use_collision** - :ref:`bool<class_bool>` **use_collision**
@@ -164,28 +174,38 @@ Method Descriptions
Returns an individual bit on the collision mask. Returns an individual bit on the collision mask.
----
.. _class_CSGShape_method_get_collision_mask_bit: .. _class_CSGShape_method_get_collision_mask_bit:
- :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const - :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const
Returns an individual bit on the collision mask. Returns an individual bit on the collision mask.
----
.. _class_CSGShape_method_get_meshes: .. _class_CSGShape_method_get_meshes:
- :ref:`Array<class_Array>` **get_meshes** **(** **)** const - :ref:`Array<class_Array>` **get_meshes** **(** **)** const
----
.. _class_CSGShape_method_is_root_shape: .. _class_CSGShape_method_is_root_shape:
- :ref:`bool<class_bool>` **is_root_shape** **(** **)** const - :ref:`bool<class_bool>` **is_root_shape** **(** **)** const
Returns ``true`` if this is a root shape and is thus the object that is rendered. Returns ``true`` if this is a root shape and is thus the object that is rendered.
----
.. _class_CSGShape_method_set_collision_layer_bit: .. _class_CSGShape_method_set_collision_layer_bit:
- void **set_collision_layer_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** - void **set_collision_layer_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
Sets individual bits on the layer mask. Use this if you only need to change one layer's value. Sets individual bits on the layer mask. Use this if you only need to change one layer's value.
----
.. _class_CSGShape_method_set_collision_mask_bit: .. _class_CSGShape_method_set_collision_mask_bit:
- void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** - void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**

8
classes/class_csgsphere.rst
View File

@@ -53,6 +53,8 @@ Property Descriptions
The material used to render the sphere. The material used to render the sphere.
----
.. _class_CSGSphere_property_radial_segments: .. _class_CSGSphere_property_radial_segments:
- :ref:`int<class_int>` **radial_segments** - :ref:`int<class_int>` **radial_segments**
@@ -65,6 +67,8 @@ The material used to render the sphere.
Number of vertical slices for the sphere. Number of vertical slices for the sphere.
----
.. _class_CSGSphere_property_radius: .. _class_CSGSphere_property_radius:
- :ref:`float<class_float>` **radius** - :ref:`float<class_float>` **radius**
@@ -77,6 +81,8 @@ Number of vertical slices for the sphere.
Radius of the sphere. Radius of the sphere.
----
.. _class_CSGSphere_property_rings: .. _class_CSGSphere_property_rings:
- :ref:`int<class_int>` **rings** - :ref:`int<class_int>` **rings**
@@ -89,6 +95,8 @@ Radius of the sphere.
Number of horizontal slices for the sphere. Number of horizontal slices for the sphere.
----
.. _class_CSGSphere_property_smooth_faces: .. _class_CSGSphere_property_smooth_faces:
- :ref:`bool<class_bool>` **smooth_faces** - :ref:`bool<class_bool>` **smooth_faces**

10
classes/class_csgtorus.rst
View File

@@ -55,6 +55,8 @@ Property Descriptions
The inner radius of the torus. The inner radius of the torus.
----
.. _class_CSGTorus_property_material: .. _class_CSGTorus_property_material:
- :ref:`Material<class_Material>` **material** - :ref:`Material<class_Material>` **material**
@@ -67,6 +69,8 @@ The inner radius of the torus.
The material used to render the torus. The material used to render the torus.
----
.. _class_CSGTorus_property_outer_radius: .. _class_CSGTorus_property_outer_radius:
- :ref:`float<class_float>` **outer_radius** - :ref:`float<class_float>` **outer_radius**
@@ -79,6 +83,8 @@ The material used to render the torus.
The outer radius of the torus. The outer radius of the torus.
----
.. _class_CSGTorus_property_ring_sides: .. _class_CSGTorus_property_ring_sides:
- :ref:`int<class_int>` **ring_sides** - :ref:`int<class_int>` **ring_sides**
@@ -91,6 +97,8 @@ The outer radius of the torus.
The number of edges each ring of the torus is constructed of. The number of edges each ring of the torus is constructed of.
----
.. _class_CSGTorus_property_sides: .. _class_CSGTorus_property_sides:
- :ref:`int<class_int>` **sides** - :ref:`int<class_int>` **sides**
@@ -103,6 +111,8 @@ The number of edges each ring of the torus is constructed of.
The number of slices the torus is constructed of. The number of slices the torus is constructed of.
----
.. _class_CSGTorus_property_smooth_faces: .. _class_CSGTorus_property_smooth_faces:
- :ref:`bool<class_bool>` **smooth_faces** - :ref:`bool<class_bool>` **smooth_faces**

14
classes/class_cubemap.rst
View File

@@ -61,6 +61,8 @@ enum **Storage**:
- **STORAGE_COMPRESS_LOSSLESS** = **2** --- Store the ``CubeMap`` with moderate compression that doesn't reduce image quality. - **STORAGE_COMPRESS_LOSSLESS** = **2** --- Store the ``CubeMap`` with moderate compression that doesn't reduce image quality.
----
.. _enum_CubeMap_Side: .. _enum_CubeMap_Side:
.. _class_CubeMap_constant_SIDE_LEFT: .. _class_CubeMap_constant_SIDE_LEFT:
@@ -89,6 +91,8 @@ enum **Side**:
- **SIDE_BACK** = **5** --- Identifier for the back face of the ``CubeMap``. - **SIDE_BACK** = **5** --- Identifier for the back face of the ``CubeMap``.
----
.. _enum_CubeMap_Flags: .. _enum_CubeMap_Flags:
.. _class_CubeMap_constant_FLAG_MIPMAPS: .. _class_CubeMap_constant_FLAG_MIPMAPS:
@@ -129,6 +133,8 @@ Property Descriptions
The render flags for the ``CubeMap``. See the ``FLAG_*`` constants for details. The render flags for the ``CubeMap``. See the ``FLAG_*`` constants for details.
----
.. _class_CubeMap_property_lossy_storage_quality: .. _class_CubeMap_property_lossy_storage_quality:
- :ref:`float<class_float>` **lossy_storage_quality** - :ref:`float<class_float>` **lossy_storage_quality**
@@ -141,6 +147,8 @@ The render flags for the ``CubeMap``. See the ``FLAG_*`` constants for details.
The lossy storage quality of the ``CubeMap`` if the storage mode is set to STORAGE_COMPRESS_LOSSY. The lossy storage quality of the ``CubeMap`` if the storage mode is set to STORAGE_COMPRESS_LOSSY.
----
.. _class_CubeMap_property_storage_mode: .. _class_CubeMap_property_storage_mode:
- :ref:`Storage<enum_CubeMap_Storage>` **storage_mode** - :ref:`Storage<enum_CubeMap_Storage>` **storage_mode**
@@ -162,18 +170,24 @@ Method Descriptions
Returns the ``CubeMap``'s height. Returns the ``CubeMap``'s height.
----
.. _class_CubeMap_method_get_side: .. _class_CubeMap_method_get_side:
- :ref:`Image<class_Image>` **get_side** **(** :ref:`Side<enum_CubeMap_Side>` side **)** const - :ref:`Image<class_Image>` **get_side** **(** :ref:`Side<enum_CubeMap_Side>` side **)** const
Returns an :ref:`Image<class_Image>` for a side of the ``CubeMap`` using one of the ``SIDE_*`` constants or an integer 0-5. Returns an :ref:`Image<class_Image>` for a side of the ``CubeMap`` using one of the ``SIDE_*`` constants or an integer 0-5.
----
.. _class_CubeMap_method_get_width: .. _class_CubeMap_method_get_width:
- :ref:`int<class_int>` **get_width** **(** **)** const - :ref:`int<class_int>` **get_width** **(** **)** const
Returns the ``CubeMap``'s width. Returns the ``CubeMap``'s width.
----
.. _class_CubeMap_method_set_side: .. _class_CubeMap_method_set_side:
- void **set_side** **(** :ref:`Side<enum_CubeMap_Side>` side, :ref:`Image<class_Image>` image **)** - void **set_side** **(** :ref:`Side<enum_CubeMap_Side>` side, :ref:`Image<class_Image>` image **)**

6
classes/class_cubemesh.rst
View File

@@ -53,6 +53,8 @@ Property Descriptions
Size of the cuboid mesh. Defaults to (2, 2, 2). Size of the cuboid mesh. Defaults to (2, 2, 2).
----
.. _class_CubeMesh_property_subdivide_depth: .. _class_CubeMesh_property_subdivide_depth:
- :ref:`int<class_int>` **subdivide_depth** - :ref:`int<class_int>` **subdivide_depth**
@@ -65,6 +67,8 @@ Size of the cuboid mesh. Defaults to (2, 2, 2).
Number of extra edge loops inserted along the z-axis. Defaults to 0. Number of extra edge loops inserted along the z-axis. Defaults to 0.
----
.. _class_CubeMesh_property_subdivide_height: .. _class_CubeMesh_property_subdivide_height:
- :ref:`int<class_int>` **subdivide_height** - :ref:`int<class_int>` **subdivide_height**
@@ -77,6 +81,8 @@ Number of extra edge loops inserted along the z-axis. Defaults to 0.
Number of extra edge loops inserted along the y-axis. Defaults to 0. Number of extra edge loops inserted along the y-axis. Defaults to 0.
----
.. _class_CubeMesh_property_subdivide_width: .. _class_CubeMesh_property_subdivide_width:
- :ref:`int<class_int>` **subdivide_width** - :ref:`int<class_int>` **subdivide_width**

40
classes/class_curve.rst
View File

@@ -120,6 +120,8 @@ Property Descriptions
The number of points to include in the baked (i.e. cached) curve data. The number of points to include in the baked (i.e. cached) curve data.
----
.. _class_Curve_property_max_value: .. _class_Curve_property_max_value:
- :ref:`float<class_float>` **max_value** - :ref:`float<class_float>` **max_value**
@@ -132,6 +134,8 @@ The number of points to include in the baked (i.e. cached) curve data.
The maximum value the curve can reach. Default value: ``1``. The maximum value the curve can reach. Default value: ``1``.
----
.. _class_Curve_property_min_value: .. _class_Curve_property_min_value:
- :ref:`float<class_float>` **min_value** - :ref:`float<class_float>` **min_value**
@@ -153,108 +157,144 @@ Method Descriptions
Adds a point to the curve. For each side, if the ``*_mode`` is :ref:`TANGENT_LINEAR<class_Curve_constant_TANGENT_LINEAR>`, the ``*_tangent`` angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the ``*_tangent`` angle if ``*_mode`` is set to :ref:`TANGENT_FREE<class_Curve_constant_TANGENT_FREE>`. Adds a point to the curve. For each side, if the ``*_mode`` is :ref:`TANGENT_LINEAR<class_Curve_constant_TANGENT_LINEAR>`, the ``*_tangent`` angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the ``*_tangent`` angle if ``*_mode`` is set to :ref:`TANGENT_FREE<class_Curve_constant_TANGENT_FREE>`.
----
.. _class_Curve_method_bake: .. _class_Curve_method_bake:
- void **bake** **(** **)** - void **bake** **(** **)**
Recomputes the baked cache of points for the curve. Recomputes the baked cache of points for the curve.
----
.. _class_Curve_method_clean_dupes: .. _class_Curve_method_clean_dupes:
- void **clean_dupes** **(** **)** - void **clean_dupes** **(** **)**
Removes points that are closer than ``CMP_EPSILON`` (0.00001) units to their neighbor on the curve. Removes points that are closer than ``CMP_EPSILON`` (0.00001) units to their neighbor on the curve.
----
.. _class_Curve_method_clear_points: .. _class_Curve_method_clear_points:
- void **clear_points** **(** **)** - void **clear_points** **(** **)**
Removes all points from the curve. Removes all points from the curve.
----
.. _class_Curve_method_get_point_count: .. _class_Curve_method_get_point_count:
- :ref:`int<class_int>` **get_point_count** **(** **)** const - :ref:`int<class_int>` **get_point_count** **(** **)** const
Returns the number of points describing the curve. Returns the number of points describing the curve.
----
.. _class_Curve_method_get_point_left_mode: .. _class_Curve_method_get_point_left_mode:
- :ref:`TangentMode<enum_Curve_TangentMode>` **get_point_left_mode** **(** :ref:`int<class_int>` index **)** const - :ref:`TangentMode<enum_Curve_TangentMode>` **get_point_left_mode** **(** :ref:`int<class_int>` index **)** const
Returns the left ``TangentMode`` for the point at ``index``. Returns the left ``TangentMode`` for the point at ``index``.
----
.. _class_Curve_method_get_point_left_tangent: .. _class_Curve_method_get_point_left_tangent:
- :ref:`float<class_float>` **get_point_left_tangent** **(** :ref:`int<class_int>` index **)** const - :ref:`float<class_float>` **get_point_left_tangent** **(** :ref:`int<class_int>` index **)** const
Returns the left tangent angle (in degrees) for the point at ``index``. Returns the left tangent angle (in degrees) for the point at ``index``.
----
.. _class_Curve_method_get_point_position: .. _class_Curve_method_get_point_position:
- :ref:`Vector2<class_Vector2>` **get_point_position** **(** :ref:`int<class_int>` index **)** const - :ref:`Vector2<class_Vector2>` **get_point_position** **(** :ref:`int<class_int>` index **)** const
Returns the curve coordinates for the point at ``index``. Returns the curve coordinates for the point at ``index``.
----
.. _class_Curve_method_get_point_right_mode: .. _class_Curve_method_get_point_right_mode:
- :ref:`TangentMode<enum_Curve_TangentMode>` **get_point_right_mode** **(** :ref:`int<class_int>` index **)** const - :ref:`TangentMode<enum_Curve_TangentMode>` **get_point_right_mode** **(** :ref:`int<class_int>` index **)** const
Returns the right ``TangentMode`` for the point at ``index``. Returns the right ``TangentMode`` for the point at ``index``.
----
.. _class_Curve_method_get_point_right_tangent: .. _class_Curve_method_get_point_right_tangent:
- :ref:`float<class_float>` **get_point_right_tangent** **(** :ref:`int<class_int>` index **)** const - :ref:`float<class_float>` **get_point_right_tangent** **(** :ref:`int<class_int>` index **)** const
Returns the right tangent angle (in degrees) for the point at ``index``. Returns the right tangent angle (in degrees) for the point at ``index``.
----
.. _class_Curve_method_interpolate: .. _class_Curve_method_interpolate:
- :ref:`float<class_float>` **interpolate** **(** :ref:`float<class_float>` offset **)** const - :ref:`float<class_float>` **interpolate** **(** :ref:`float<class_float>` offset **)** const
Returns the y value for the point that would exist at x-position ``offset`` along the curve. Returns the y value for the point that would exist at x-position ``offset`` along the curve.
----
.. _class_Curve_method_interpolate_baked: .. _class_Curve_method_interpolate_baked:
- :ref:`float<class_float>` **interpolate_baked** **(** :ref:`float<class_float>` offset **)** - :ref:`float<class_float>` **interpolate_baked** **(** :ref:`float<class_float>` offset **)**
Returns the y value for the point that would exist at x-position ``offset`` along the curve using the baked cache. Bakes the curve's points if not already baked. Returns the y value for the point that would exist at x-position ``offset`` along the curve using the baked cache. Bakes the curve's points if not already baked.
----
.. _class_Curve_method_remove_point: .. _class_Curve_method_remove_point:
- void **remove_point** **(** :ref:`int<class_int>` index **)** - void **remove_point** **(** :ref:`int<class_int>` index **)**
Removes the point at ``index`` from the curve. Removes the point at ``index`` from the curve.
----
.. _class_Curve_method_set_point_left_mode: .. _class_Curve_method_set_point_left_mode:
- void **set_point_left_mode** **(** :ref:`int<class_int>` index, :ref:`TangentMode<enum_Curve_TangentMode>` mode **)** - void **set_point_left_mode** **(** :ref:`int<class_int>` index, :ref:`TangentMode<enum_Curve_TangentMode>` mode **)**
Sets the left ``TangentMode`` for the point at ``index`` to ``mode``. Sets the left ``TangentMode`` for the point at ``index`` to ``mode``.
----
.. _class_Curve_method_set_point_left_tangent: .. _class_Curve_method_set_point_left_tangent:
- void **set_point_left_tangent** **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent **)** - void **set_point_left_tangent** **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent **)**
Sets the left tangent angle for the point at ``index`` to ``tangent``. Sets the left tangent angle for the point at ``index`` to ``tangent``.
----
.. _class_Curve_method_set_point_offset: .. _class_Curve_method_set_point_offset:
- :ref:`int<class_int>` **set_point_offset** **(** :ref:`int<class_int>` index, :ref:`float<class_float>` offset **)** - :ref:`int<class_int>` **set_point_offset** **(** :ref:`int<class_int>` index, :ref:`float<class_float>` offset **)**
Sets the offset from ``0.5`` Sets the offset from ``0.5``
----
.. _class_Curve_method_set_point_right_mode: .. _class_Curve_method_set_point_right_mode:
- void **set_point_right_mode** **(** :ref:`int<class_int>` index, :ref:`TangentMode<enum_Curve_TangentMode>` mode **)** - void **set_point_right_mode** **(** :ref:`int<class_int>` index, :ref:`TangentMode<enum_Curve_TangentMode>` mode **)**
Sets the right ``TangentMode`` for the point at ``index`` to ``mode``. Sets the right ``TangentMode`` for the point at ``index`` to ``mode``.
----
.. _class_Curve_method_set_point_right_tangent: .. _class_Curve_method_set_point_right_tangent:
- void **set_point_right_tangent** **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent **)** - void **set_point_right_tangent** **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent **)**
Sets the right tangent angle for the point at ``index`` to ``tangent``. Sets the right tangent angle for the point at ``index`` to ``tangent``.
----
.. _class_Curve_method_set_point_value: .. _class_Curve_method_set_point_value:
- void **set_point_value** **(** :ref:`int<class_int>` index, :ref:`float<class_float>` y **)** - void **set_point_value** **(** :ref:`int<class_int>` index, :ref:`float<class_float>` y **)**

34
classes/class_curve2d.rst
View File

@@ -99,24 +99,32 @@ Adds a point to a curve, at ``position``, with control points ``in`` and ``out``
If ``at_position`` is given, the point is inserted before the point number ``at_position``, moving that point (and every point after) after the inserted point. If ``at_position`` is not given, or is an illegal value (``at_position <0`` or ``at_position >= [method get_point_count]``), the point will be appended at the end of the point list. If ``at_position`` is given, the point is inserted before the point number ``at_position``, moving that point (and every point after) after the inserted point. If ``at_position`` is not given, or is an illegal value (``at_position <0`` or ``at_position >= [method get_point_count]``), the point will be appended at the end of the point list.
----
.. _class_Curve2D_method_clear_points: .. _class_Curve2D_method_clear_points:
- void **clear_points** **(** **)** - void **clear_points** **(** **)**
Removes all points from the curve. Removes all points from the curve.
----
.. _class_Curve2D_method_get_baked_length: .. _class_Curve2D_method_get_baked_length:
- :ref:`float<class_float>` **get_baked_length** **(** **)** const - :ref:`float<class_float>` **get_baked_length** **(** **)** const
Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`bake_interval<class_Curve2D_property_bake_interval>`), it should be approximate enough. Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`bake_interval<class_Curve2D_property_bake_interval>`), it should be approximate enough.
----
.. _class_Curve2D_method_get_baked_points: .. _class_Curve2D_method_get_baked_points:
- :ref:`PoolVector2Array<class_PoolVector2Array>` **get_baked_points** **(** **)** const - :ref:`PoolVector2Array<class_PoolVector2Array>` **get_baked_points** **(** **)** const
Returns the cache of points as a :ref:`PoolVector2Array<class_PoolVector2Array>`. Returns the cache of points as a :ref:`PoolVector2Array<class_PoolVector2Array>`.
----
.. _class_Curve2D_method_get_closest_offset: .. _class_Curve2D_method_get_closest_offset:
- :ref:`float<class_float>` **get_closest_offset** **(** :ref:`Vector2<class_Vector2>` to_point **)** const - :ref:`float<class_float>` **get_closest_offset** **(** :ref:`Vector2<class_Vector2>` to_point **)** const
@@ -125,6 +133,8 @@ Returns the closest offset to ``to_point``. This offset is meant to be used in :
``to_point`` must be in this curve's local space. ``to_point`` must be in this curve's local space.
----
.. _class_Curve2D_method_get_closest_point: .. _class_Curve2D_method_get_closest_point:
- :ref:`Vector2<class_Vector2>` **get_closest_point** **(** :ref:`Vector2<class_Vector2>` to_point **)** const - :ref:`Vector2<class_Vector2>` **get_closest_point** **(** :ref:`Vector2<class_Vector2>` to_point **)** const
@@ -133,30 +143,40 @@ Returns the closest point (in curve's local space) to ``to_point``.
``to_point`` must be in this curve's local space. ``to_point`` must be in this curve's local space.
----
.. _class_Curve2D_method_get_point_count: .. _class_Curve2D_method_get_point_count:
- :ref:`int<class_int>` **get_point_count** **(** **)** const - :ref:`int<class_int>` **get_point_count** **(** **)** const
Returns the number of points describing the curve. Returns the number of points describing the curve.
----
.. _class_Curve2D_method_get_point_in: .. _class_Curve2D_method_get_point_in:
- :ref:`Vector2<class_Vector2>` **get_point_in** **(** :ref:`int<class_int>` idx **)** const - :ref:`Vector2<class_Vector2>` **get_point_in** **(** :ref:`int<class_int>` idx **)** const
Returns the position of the control point leading to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0)``. Returns the position of the control point leading to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0)``.
----
.. _class_Curve2D_method_get_point_out: .. _class_Curve2D_method_get_point_out:
- :ref:`Vector2<class_Vector2>` **get_point_out** **(** :ref:`int<class_int>` idx **)** const - :ref:`Vector2<class_Vector2>` **get_point_out** **(** :ref:`int<class_int>` idx **)** const
Returns the position of the control point leading out of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0)``. Returns the position of the control point leading out of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0)``.
----
.. _class_Curve2D_method_get_point_position: .. _class_Curve2D_method_get_point_position:
- :ref:`Vector2<class_Vector2>` **get_point_position** **(** :ref:`int<class_int>` idx **)** const - :ref:`Vector2<class_Vector2>` **get_point_position** **(** :ref:`int<class_int>` idx **)** const
Returns the position of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0)``. Returns the position of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0)``.
----
.. _class_Curve2D_method_interpolate: .. _class_Curve2D_method_interpolate:
- :ref:`Vector2<class_Vector2>` **interpolate** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const - :ref:`Vector2<class_Vector2>` **interpolate** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const
@@ -165,6 +185,8 @@ Returns the position between the vertex ``idx`` and the vertex ``idx + 1``, wher
If ``idx`` is out of bounds it is truncated to the first or last vertex, and ``t`` is ignored. If the curve has no points, the function sends an error to the console, and returns ``(0, 0)``. If ``idx`` is out of bounds it is truncated to the first or last vertex, and ``t`` is ignored. If the curve has no points, the function sends an error to the console, and returns ``(0, 0)``.
----
.. _class_Curve2D_method_interpolate_baked: .. _class_Curve2D_method_interpolate_baked:
- :ref:`Vector2<class_Vector2>` **interpolate_baked** **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const - :ref:`Vector2<class_Vector2>` **interpolate_baked** **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const
@@ -175,36 +197,48 @@ To do that, it finds the two cached points where the ``offset`` lies between, th
Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough).
----
.. _class_Curve2D_method_interpolatef: .. _class_Curve2D_method_interpolatef:
- :ref:`Vector2<class_Vector2>` **interpolatef** **(** :ref:`float<class_float>` fofs **)** const - :ref:`Vector2<class_Vector2>` **interpolatef** **(** :ref:`float<class_float>` fofs **)** const
Returns the position at the vertex ``fofs``. It calls :ref:`interpolate<class_Curve2D_method_interpolate>` using the integer part of ``fofs`` as ``idx``, and its fractional part as ``t``. Returns the position at the vertex ``fofs``. It calls :ref:`interpolate<class_Curve2D_method_interpolate>` using the integer part of ``fofs`` as ``idx``, and its fractional part as ``t``.
----
.. _class_Curve2D_method_remove_point: .. _class_Curve2D_method_remove_point:
- void **remove_point** **(** :ref:`int<class_int>` idx **)** - void **remove_point** **(** :ref:`int<class_int>` idx **)**
Deletes the point ``idx`` from the curve. Sends an error to the console if ``idx`` is out of bounds. Deletes the point ``idx`` from the curve. Sends an error to the console if ``idx`` is out of bounds.
----
.. _class_Curve2D_method_set_point_in: .. _class_Curve2D_method_set_point_in:
- void **set_point_in** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` position **)** - void **set_point_in** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` position **)**
Sets the position of the control point leading to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. Sets the position of the control point leading to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console.
----
.. _class_Curve2D_method_set_point_out: .. _class_Curve2D_method_set_point_out:
- void **set_point_out** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` position **)** - void **set_point_out** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` position **)**
Sets the position of the control point leading out of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. Sets the position of the control point leading out of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console.
----
.. _class_Curve2D_method_set_point_position: .. _class_Curve2D_method_set_point_position:
- void **set_point_position** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` position **)** - void **set_point_position** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` position **)**
Sets the position for the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. Sets the position for the vertex ``idx``. If the index is out of bounds, the function sends an error to the console.
----
.. _class_Curve2D_method_tessellate: .. _class_Curve2D_method_tessellate:
- :ref:`PoolVector2Array<class_PoolVector2Array>` **tessellate** **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const - :ref:`PoolVector2Array<class_PoolVector2Array>` **tessellate** **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const

46
classes/class_curve3d.rst
View File

@@ -100,6 +100,8 @@ Property Descriptions
The distance in meters between two adjacent cached points. Changing it forces the cache to be recomputed the next time the :ref:`get_baked_points<class_Curve3D_method_get_baked_points>` or :ref:`get_baked_length<class_Curve3D_method_get_baked_length>` function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. The distance in meters between two adjacent cached points. Changing it forces the cache to be recomputed the next time the :ref:`get_baked_points<class_Curve3D_method_get_baked_points>` or :ref:`get_baked_length<class_Curve3D_method_get_baked_length>` function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care.
----
.. _class_Curve3D_property_up_vector_enabled: .. _class_Curve3D_property_up_vector_enabled:
- :ref:`bool<class_bool>` **up_vector_enabled** - :ref:`bool<class_bool>` **up_vector_enabled**
@@ -123,30 +125,40 @@ Adds a point to a curve, at ``position``, with control points ``in`` and ``out``
If ``at_position`` is given, the point is inserted before the point number ``at_position``, moving that point (and every point after) after the inserted point. If ``at_position`` is not given, or is an illegal value (``at_position <0`` or ``at_position >= [method get_point_count]``), the point will be appended at the end of the point list. If ``at_position`` is given, the point is inserted before the point number ``at_position``, moving that point (and every point after) after the inserted point. If ``at_position`` is not given, or is an illegal value (``at_position <0`` or ``at_position >= [method get_point_count]``), the point will be appended at the end of the point list.
----
.. _class_Curve3D_method_clear_points: .. _class_Curve3D_method_clear_points:
- void **clear_points** **(** **)** - void **clear_points** **(** **)**
Removes all points from the curve. Removes all points from the curve.
----
.. _class_Curve3D_method_get_baked_length: .. _class_Curve3D_method_get_baked_length:
- :ref:`float<class_float>` **get_baked_length** **(** **)** const - :ref:`float<class_float>` **get_baked_length** **(** **)** const
Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`bake_interval<class_Curve3D_property_bake_interval>`), it should be approximate enough. Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`bake_interval<class_Curve3D_property_bake_interval>`), it should be approximate enough.
----
.. _class_Curve3D_method_get_baked_points: .. _class_Curve3D_method_get_baked_points:
- :ref:`PoolVector3Array<class_PoolVector3Array>` **get_baked_points** **(** **)** const - :ref:`PoolVector3Array<class_PoolVector3Array>` **get_baked_points** **(** **)** const
Returns the cache of points as a :ref:`PoolVector3Array<class_PoolVector3Array>`. Returns the cache of points as a :ref:`PoolVector3Array<class_PoolVector3Array>`.
----
.. _class_Curve3D_method_get_baked_tilts: .. _class_Curve3D_method_get_baked_tilts:
- :ref:`PoolRealArray<class_PoolRealArray>` **get_baked_tilts** **(** **)** const - :ref:`PoolRealArray<class_PoolRealArray>` **get_baked_tilts** **(** **)** const
Returns the cache of tilts as a :ref:`PoolRealArray<class_PoolRealArray>`. Returns the cache of tilts as a :ref:`PoolRealArray<class_PoolRealArray>`.
----
.. _class_Curve3D_method_get_baked_up_vectors: .. _class_Curve3D_method_get_baked_up_vectors:
- :ref:`PoolVector3Array<class_PoolVector3Array>` **get_baked_up_vectors** **(** **)** const - :ref:`PoolVector3Array<class_PoolVector3Array>` **get_baked_up_vectors** **(** **)** const
@@ -155,6 +167,8 @@ Returns the cache of up vectors as a :ref:`PoolVector3Array<class_PoolVector3Arr
If :ref:`up_vector_enabled<class_Curve3D_property_up_vector_enabled>` is ``false``, the cache will be empty. If :ref:`up_vector_enabled<class_Curve3D_property_up_vector_enabled>` is ``false``, the cache will be empty.
----
.. _class_Curve3D_method_get_closest_offset: .. _class_Curve3D_method_get_closest_offset:
- :ref:`float<class_float>` **get_closest_offset** **(** :ref:`Vector3<class_Vector3>` to_point **)** const - :ref:`float<class_float>` **get_closest_offset** **(** :ref:`Vector3<class_Vector3>` to_point **)** const
@@ -163,6 +177,8 @@ Returns the closest offset to ``to_point``. This offset is meant to be used in :
``to_point`` must be in this curve's local space. ``to_point`` must be in this curve's local space.
----
.. _class_Curve3D_method_get_closest_point: .. _class_Curve3D_method_get_closest_point:
- :ref:`Vector3<class_Vector3>` **get_closest_point** **(** :ref:`Vector3<class_Vector3>` to_point **)** const - :ref:`Vector3<class_Vector3>` **get_closest_point** **(** :ref:`Vector3<class_Vector3>` to_point **)** const
@@ -171,36 +187,48 @@ Returns the closest point (in curve's local space) to ``to_point``.
``to_point`` must be in this curve's local space. ``to_point`` must be in this curve's local space.
----
.. _class_Curve3D_method_get_point_count: .. _class_Curve3D_method_get_point_count:
- :ref:`int<class_int>` **get_point_count** **(** **)** const - :ref:`int<class_int>` **get_point_count** **(** **)** const
Returns the number of points describing the curve. Returns the number of points describing the curve.
----
.. _class_Curve3D_method_get_point_in: .. _class_Curve3D_method_get_point_in:
- :ref:`Vector3<class_Vector3>` **get_point_in** **(** :ref:`int<class_int>` idx **)** const - :ref:`Vector3<class_Vector3>` **get_point_in** **(** :ref:`int<class_int>` idx **)** const
Returns the position of the control point leading to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0, 0)``. Returns the position of the control point leading to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0, 0)``.
----
.. _class_Curve3D_method_get_point_out: .. _class_Curve3D_method_get_point_out:
- :ref:`Vector3<class_Vector3>` **get_point_out** **(** :ref:`int<class_int>` idx **)** const - :ref:`Vector3<class_Vector3>` **get_point_out** **(** :ref:`int<class_int>` idx **)** const
Returns the position of the control point leading out of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0, 0)``. Returns the position of the control point leading out of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0, 0)``.
----
.. _class_Curve3D_method_get_point_position: .. _class_Curve3D_method_get_point_position:
- :ref:`Vector3<class_Vector3>` **get_point_position** **(** :ref:`int<class_int>` idx **)** const - :ref:`Vector3<class_Vector3>` **get_point_position** **(** :ref:`int<class_int>` idx **)** const
Returns the position of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0, 0)``. Returns the position of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0, 0)``.
----
.. _class_Curve3D_method_get_point_tilt: .. _class_Curve3D_method_get_point_tilt:
- :ref:`float<class_float>` **get_point_tilt** **(** :ref:`int<class_int>` idx **)** const - :ref:`float<class_float>` **get_point_tilt** **(** :ref:`int<class_int>` idx **)** const
Returns the tilt angle in radians for the point ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``0``. Returns the tilt angle in radians for the point ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``0``.
----
.. _class_Curve3D_method_interpolate: .. _class_Curve3D_method_interpolate:
- :ref:`Vector3<class_Vector3>` **interpolate** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const - :ref:`Vector3<class_Vector3>` **interpolate** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const
@@ -209,6 +237,8 @@ Returns the position between the vertex ``idx`` and the vertex ``idx + 1``, wher
If ``idx`` is out of bounds it is truncated to the first or last vertex, and ``t`` is ignored. If the curve has no points, the function sends an error to the console, and returns ``(0, 0, 0)``. If ``idx`` is out of bounds it is truncated to the first or last vertex, and ``t`` is ignored. If the curve has no points, the function sends an error to the console, and returns ``(0, 0, 0)``.
----
.. _class_Curve3D_method_interpolate_baked: .. _class_Curve3D_method_interpolate_baked:
- :ref:`Vector3<class_Vector3>` **interpolate_baked** **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const - :ref:`Vector3<class_Vector3>` **interpolate_baked** **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const
@@ -219,6 +249,8 @@ To do that, it finds the two cached points where the ``offset`` lies between, th
Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough).
----
.. _class_Curve3D_method_interpolate_baked_up_vector: .. _class_Curve3D_method_interpolate_baked_up_vector:
- :ref:`Vector3<class_Vector3>` **interpolate_baked_up_vector** **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` apply_tilt=false **)** const - :ref:`Vector3<class_Vector3>` **interpolate_baked_up_vector** **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` apply_tilt=false **)** const
@@ -229,36 +261,48 @@ To do that, it finds the two cached up vectors where the ``offset`` lies between
If the curve has no up vectors, the function sends an error to the console, and returns ``(0, 1, 0)``. If the curve has no up vectors, the function sends an error to the console, and returns ``(0, 1, 0)``.
----
.. _class_Curve3D_method_interpolatef: .. _class_Curve3D_method_interpolatef:
- :ref:`Vector3<class_Vector3>` **interpolatef** **(** :ref:`float<class_float>` fofs **)** const - :ref:`Vector3<class_Vector3>` **interpolatef** **(** :ref:`float<class_float>` fofs **)** const
Returns the position at the vertex ``fofs``. It calls :ref:`interpolate<class_Curve3D_method_interpolate>` using the integer part of ``fofs`` as ``idx``, and its fractional part as ``t``. Returns the position at the vertex ``fofs``. It calls :ref:`interpolate<class_Curve3D_method_interpolate>` using the integer part of ``fofs`` as ``idx``, and its fractional part as ``t``.
----
.. _class_Curve3D_method_remove_point: .. _class_Curve3D_method_remove_point:
- void **remove_point** **(** :ref:`int<class_int>` idx **)** - void **remove_point** **(** :ref:`int<class_int>` idx **)**
Deletes the point ``idx`` from the curve. Sends an error to the console if ``idx`` is out of bounds. Deletes the point ``idx`` from the curve. Sends an error to the console if ``idx`` is out of bounds.
----
.. _class_Curve3D_method_set_point_in: .. _class_Curve3D_method_set_point_in:
- void **set_point_in** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` position **)** - void **set_point_in** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` position **)**
Sets the position of the control point leading to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. Sets the position of the control point leading to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console.
----
.. _class_Curve3D_method_set_point_out: .. _class_Curve3D_method_set_point_out:
- void **set_point_out** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` position **)** - void **set_point_out** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` position **)**
Sets the position of the control point leading out of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. Sets the position of the control point leading out of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console.
----
.. _class_Curve3D_method_set_point_position: .. _class_Curve3D_method_set_point_position:
- void **set_point_position** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` position **)** - void **set_point_position** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` position **)**
Sets the position for the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. Sets the position for the vertex ``idx``. If the index is out of bounds, the function sends an error to the console.
----
.. _class_Curve3D_method_set_point_tilt: .. _class_Curve3D_method_set_point_tilt:
- void **set_point_tilt** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` tilt **)** - void **set_point_tilt** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` tilt **)**
@@ -267,6 +311,8 @@ Sets the tilt angle in radians for the point ``idx``. If the index is out of bou
The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a :ref:`PathFollow<class_PathFollow>`, this tilt is an offset over the natural tilt the :ref:`PathFollow<class_PathFollow>` calculates. The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a :ref:`PathFollow<class_PathFollow>`, this tilt is an offset over the natural tilt the :ref:`PathFollow<class_PathFollow>` calculates.
----
.. _class_Curve3D_method_tessellate: .. _class_Curve3D_method_tessellate:
- :ref:`PoolVector3Array<class_PoolVector3Array>` **tessellate** **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const - :ref:`PoolVector3Array<class_PoolVector3Array>` **tessellate** **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const

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