diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index 5f7e9950998..067d73034bd 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -8,58 +8,37 @@
This contains the list of built-in gdscript functions. Mostly math functions and other utilities. Everything else is expanded by objects.
-
-
+
+
-
+
+
+
+
+
+
+
- Standard sine function.
+ Make a color from red, green, blue and alpha. Arguments can range from 0 to 255.
-
+
- Standard cosine function.
+ Remove sign (works for integer and float).
-
+
- Standard tangent function.
-
-
-
-
-
-
-
-
- Hyperbolic sine.
-
-
-
-
-
-
-
-
- Hyperbolic cosine.
-
-
-
-
-
-
-
-
- Hyperbolic tangent.
+ Arc-cosine.
@@ -71,13 +50,13 @@
Arc-sine.
-
-
+
+
-
+
- Arc-cosine.
+ Assert that the condition is true. If the condition is false, generates an error.
@@ -100,13 +79,142 @@
Arc-tangent that takes a 2D vector as argument, returns the full -pi to +pi range.
-
+
+
+
+
+
+
+ Decode a byte array back to a value.
+
+
+
- Square root.
+ Ceiling (rounds up to nearest integer).
+
+
+
+
+
+
+
+
+
+
+
+
+ Clamp both values to a range.
+
+
+
+
+
+
+
+
+
+
+ Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE_* in [@Global Scope].
+
+
+
+
+
+
+
+
+ Standard cosine function.
+
+
+
+
+
+
+
+
+ Hyperbolic cosine.
+
+
+
+
+
+
+
+
+ Convert from decibels to linear energy (audio).
+
+
+
+
+
+
+
+
+ Return the amount of decimals in the floating point value.
+
+
+
+
+
+
+
+
+
+
+
+
+ Decreases time by a specified amount.
+
+
+
+
+
+
+
+
+ Convert from degrees to radians.
+
+
+
+
+
+
+
+
+ Convert a previously converted instances to dictionary back into an instance. Useful for deserializing.
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
+
+
+ Exponential logarithm.
+
+
+
+
+
+
+
+
+ Floor (rounds down to nearest integer).
@@ -131,86 +239,42 @@
Module (remainder of x/y) that wraps equally in positive and negative.
-
-
+
+
-
+
+
+
- Floor (rounds down to nearest integer).
+ Return a reference to the specified function.
-
-
+
+
-
+
- Ceiling (rounds up to nearest integer).
+ Hash the variable passed and return an integer.
-
-
+
+
-
+
- Round to nearest integer.
+ Convert a script class instance to a dictionary (useful for serializing).
-
-
+
+
-
-
-
- Remove sign (works for integer and float).
-
-
-
-
-
-
-
-
- Return sign (-1 or +1).
-
-
-
-
-
-
-
-
-
-
- Power function, x elevate to y.
-
-
-
-
-
-
-
-
- Natural logarithm.
-
-
-
-
-
-
-
-
- Exponential logarithm.
-
-
-
-
-
-
+
+ Get an object by its ID.
@@ -221,35 +285,12 @@
-
+
-
-
- 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.
-
-
-
-
-
-
-
-
- Return the amount of decimals in the floating point value.
-
-
-
-
-
-
-
-
-
-
- Snap float value to a given step.
@@ -265,87 +306,6 @@
Linear interpolates between two values by a normalized value.
-
-
-
-
-
-
-
-
-
-
- Decreases time by a specified amount.
-
-
-
-
-
-
- Reset the seed of the random number generator with a new, different one.
-
-
-
-
-
-
- Random 32 bits value (integer). To obtain a value from 0 to N, you can use remainder, like (for random from 0 to 19): randi() % 20.
-
-
-
-
-
-
- Random value (0 to 1 float).
-
-
-
-
-
-
-
-
-
-
- Random range, any floating point value between 'from' and 'to'
-
-
-
-
-
-
-
-
- Set seed for the random number generator.
-
-
-
-
-
-
-
-
- Random from seed, pass a seed and an array with both number and new seed is returned.
-
-
-
-
-
-
-
-
- Convert from degrees to radians.
-
-
-
-
-
-
-
-
- Convert from radians to degrees.
-
-
@@ -355,13 +315,22 @@
Convert from linear energy to decibels (audio).
-
-
+
+
-
+
- Convert from decibels to linear energy (audio).
+ Load a resource from the filesystem, pass a valid path as argument.
+
+
+
+
+
+
+
+
+ Natural logarithm.
@@ -386,19 +355,6 @@
Return the minimum of two values.
-
-
-
-
-
-
-
-
-
-
- Clamp both values to a range.
-
-
@@ -408,55 +364,24 @@
Return the nearest larger power of 2 for an integer.
-
-
+
+
-
+
+
+
- Return a weak reference to an object.
+ Power function, x elevate to y.
-
-
+
+
-
-
-
+
- Return a reference to the specified function.
-
-
-
-
-
-
-
-
-
-
- Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE_* in [@Global Scope].
-
-
-
-
-
-
-
-
- Return the internal type of the given Variant object, using the TYPE_* enum in [@Global Scope].
-
-
-
-
-
-
-
-
-
-
- Convert one or more arguments to strings in the best way possible.
+ Preload a resource from the filesystem. The resource is loaded during script parsing.
@@ -470,26 +395,11 @@
Print one or more arguments to strings in the best way possible to a console line.
-
+
-
-
-
-
- Print one or more arguments to the console with a tab between each argument.
-
-
-
-
-
-
-
-
-
-
- Print one or more arguments to the console with a space between each argument.
+ Print a stack track at code location, only works when running with debugger turned on.
@@ -514,40 +424,76 @@
Print one or more arguments to strings in the best way possible to console. No newline is added at the end.
-
-
+
+
-
+
+
+
- Convert a value to a formatted string that can later be parsed using [method str2var].
+ Print one or more arguments to the console with a space between each argument.
-
-
+
+
-
+
+
+
- Convert a formatted string that was returned by [method var2str] to the original value.
+ Print one or more arguments to the console with a tab between each argument.
-
-
+
+
-
+
- Encode a variable value to a byte array.
+ Convert from radians to degrees.
-
-
+
+
-
+
+
+
- Decode a byte array back to a value.
+ Random range, any floating point value between 'from' and 'to'
+
+
+
+
+
+
+
+
+ Random from seed, pass a seed and an array with both number and new seed is returned.
+
+
+
+
+
+
+ Random value (0 to 1 float).
+
+
+
+
+
+
+ Random 32 bits value (integer). To obtain a value from 0 to N, you can use remainder, like (for random from 0 to 19): randi() % 20.
+
+
+
+
+
+
+ Reset the seed of the random number generator with a new, different one.
@@ -559,80 +505,151 @@
Return an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial, final-1, increment).
-
-
+
+
-
+
- Load a resource from the filesystem, pass a valid path as argument.
+ Round to nearest integer.
-
-
-
-
-
-
- Convert a script class instance to a dictionary (useful for serializing).
-
-
-
-
-
-
-
-
- Convert a previously converted instances to dictionary back into an instance. Useful for deserializing.
-
-
-
-
-
-
-
-
- Hash the variable passed and return an integer.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Make a color from red, green, blue and alpha. Arguments can range from 0 to 255.
-
-
-
+
-
- Print a stack track at code location, only works when running with debugger turned on.
-
-
-
-
-
-
+
- Get an object by its ID.
+ Set seed for the random number generator.
-
-
+
+
-
+
- Preload a resource from the filesystem. The resource is loaded during script parsing.
+ Return sign (-1 or +1).
+
+
+
+
+
+
+
+
+ Standard sine function.
+
+
+
+
+
+
+
+
+ Hyperbolic sine.
+
+
+
+
+
+
+
+
+ Square root.
+
+
+
+
+
+
+
+
+
+
+ Snap float value to a given step.
+
+
+
+
+
+
+
+
+
+
+ Convert one or more arguments to strings in the best way possible.
+
+
+
+
+
+
+
+
+ Convert a formatted string that was returned by [method var2str] to the original value.
+
+
+
+
+
+
+
+
+ Standard tangent function.
+
+
+
+
+
+
+
+
+ Hyperbolic tangent.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return the internal type of the given Variant object, using the TYPE_* enum in [@Global Scope].
+
+
+
+
+
+
+
+
+ Encode a variable value to a byte array.
+
+
+
+
+
+
+
+
+ Convert a value to a formatted string that can later be parsed using [method str2var].
+
+
+
+
+
+
+
+
+ Return a weak reference to an object.
@@ -648,15 +665,6 @@
If passed an object and a signal, the execution is resumed when the object's signal is emmited.
-
-
-
-
-
-
- Assert that the condition is true. If the condition is false, generates an error.
-
-
@@ -675,8 +683,14 @@
-
- [Performance] singleton
+
+ [AudioServer] singleton
+
+
+ [AudioServer] singleton
+
+
+ [Geometry] singleton
[Globals] singleton
@@ -684,8 +698,35 @@
[IP] singleton
-
- [Geometry] singleton
+
+ [Input] singleton
+
+
+ [InputMap] singleton
+
+
+ [Marshalls] singleton
+
+
+ [OS] singleton
+
+
+ [PhysicsServer] singleton
+
+
+ [Physics2DServer] singleton
+
+
+ [PathRemap] singleton
+
+
+ [Performance] singleton
+
+
+ [Physics2DServer] singleton
+
+
+ [PhysicsServer] singleton
[ResourceLoader] singleton
@@ -693,82 +734,141 @@
[ResourceSaver] singleton
-
- [PathRemap] singleton
-
-
- [OS] singleton
-
-
- [Marshalls] singleton
-
-
- [TranslationServer] singleton
-
-
- [TranslationServer] singleton
-
-
- [Input] singleton
-
-
- [InputMap] singleton
-
-
- [VisualServer] singleton
-
-
- [VisualServer] singleton
-
-
- [AudioServer] singleton
-
-
- [AudioServer] singleton
-
-
- [PhysicsServer] singleton
-
-
- [PhysicsServer] singleton
-
-
- [Physics2DServer] singleton
-
-
- [Physics2DServer] singleton
-
-
- [SpatialSoundServer] singleton
-
[SpatialSoundServer] singleton
-
- [SpatialSound2DServer] singleton
-
[SpatialSound2DServer] singleton
+
+ [SpatialSound2DServer] singleton
+
+
+ [SpatialSoundServer] singleton
+
+
+ [TranslationServer] singleton
+
+
+ [TranslationServer] singleton
+
+
+ [VisualServer] singleton
+
+
+ [VisualServer] singleton
+
-
- Left margin, used usually for [Control] or [StyleBox] derived classes.
+
+ Left Mouse Button
-
- Top margin, used usually for [Control] or [StyleBox] derived classes.
+
-
- Right margin, used usually for [Control] or [StyleBox] derived classes.
+
-
- Bottom margin, used usually for [Control] or [StyleBox] derived classes.
+
+ Right Mouse Button
-
- General vertical alignment, used usually for [Separator], [ScrollBar], [Slider], etc.
+
+ Middle Mouse Button
-
- General horizontal alignment, used usually for [Separator], [ScrollBar], [Slider], etc.
+
+
+
+ Mouse wheel up
+
+
+ Mouse wheel down
+
+
+ Mouse wheel left button
+
+
+ Mouse wheel right button
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Generic fail return error.
Horizontal left alignment, usually for text-derived classes.
@@ -779,17 +879,232 @@
Horizontal right alignment, usually for text-derived classes.
-
- Vertical top alignment, usually for text-derived classes.
+
+ General horizontal alignment, used usually for [Separator], [ScrollBar], [Slider], etc.
-
- Vertical center alignment, usually for text-derived classes.
+
+ Joystick Left Stick Horizontal Axis
-
- Vertical bottom alignment, usually for text-derived classes.
+
+ Joystick Left Stick Horizontal Axis
-
- Scancodes with this bit applied are non printable.
+
+ Joystick Button 0
+
+
+
+
+ SEGA controller A button
+
+
+ Super Nintendo Entertaiment System controller B button
+
+
+ DUALSHOCK X button
+
+
+ XBOX controller A button
+
+
+ Joystick Left Stick Vertical Axis
+
+
+ Joystick Left Stick Vertical Axis
+
+
+ Joystick Button 1
+
+
+
+
+ SEGA controller B button
+
+
+ Super Nintendo Entertaiment System controller A button
+
+
+ DUALSHOCK circle button
+
+
+ XBOX controller B button
+
+
+ Joystick Button 10
+
+
+ Joystick Button Select
+
+
+ Joystick Button 11
+
+
+ Joystick Button Start
+
+
+ Joystick Button 12
+
+
+ Joystick DPad Up
+
+
+ Joystick Button 13
+
+
+ Joystick DPad Down
+
+
+ Joystick Button 14
+
+
+ Joystick DPad Left
+
+
+ Joystick Button 15
+
+
+ Joystick DPad Right
+
+
+ Joystick Button 16
+
+
+ Joystick Right Stick Horizontal Axis
+
+
+ Joystick Right Stick Horizontal Axis
+
+
+ Joystick Button 2
+
+
+
+
+ SEGA controller X button
+
+
+ Super Nintendo Entertaiment System controller Y button
+
+
+ DUALSHOCK square button
+
+
+ XBOX controller X button
+
+
+ Joystick Right Stick Vertical Axis
+
+
+ Joystick Right Stick Vertical Axis
+
+
+ Joystick Button 3
+
+
+
+
+ SEGA controller Y button
+
+
+ Super Nintendo Entertaiment System controller X button
+
+
+ DUALSHOCK triangle button
+
+
+ XBOX controller Y button
+
+
+
+
+
+
+ Joystick Button 4
+
+
+ Joystick Left Shoulder Button
+
+
+
+
+
+
+ Joystick Button 5
+
+
+ Joystick Right Shoulder Button
+
+
+
+
+ Joystick Left Trigger Analog Axis
+
+
+ Joystick Button 6
+
+
+ Joystick Left Trigger
+
+
+
+
+ Joystick Right Trigger Analog Axis
+
+
+ Joystick Button 7
+
+
+ Joystick Right Trigger
+
+
+
+
+ Joystick Button 8
+
+
+ Joystick Left Stick Click
+
+
+ Joystick Button 9
+
+
+ Joystick Right Stick Click
+
+
+
+
+
+
+ { key
+
+
+ | key
+
+
+ } key
+
+
+ ~ key
+
+
+
+
+
+
+
+
+ ¢ key
+
+
+
+
+
+
+
+
+ ¦ key
+
+
+ § key
Escape Key
@@ -917,54 +1232,6 @@
F16 Key
-
- Enter Key on Numpad
-
-
- Multiply Key on Numpad
-
-
- Divide Key on Numpad
-
-
- Subtract Key on Numpad
-
-
- Period Key on Numpad
-
-
- Add Key on Numpad
-
-
- Number 0 on Numpad
-
-
- Number 1 on Numpad
-
-
- Number 2 on Numpad
-
-
- Number 3 on Numpad
-
-
- Number 4 on Numpad
-
-
- Number 5 on Numpad
-
-
- Number 6 on Numpad
-
-
- Number 7 on Numpad
-
-
- Number 8 on Numpad
-
-
- Number 9 on Numpad
-
Super Left key (windows key)
@@ -1080,232 +1347,53 @@
-
+
+ Enter Key on Numpad
-
- Space Key
+
+ Multiply Key on Numpad
-
- ! key
+
+ Divide Key on Numpad
-
- " key
+
+ Subtract Key on Numpad
-
- # key
+
+ Period Key on Numpad
-
- $ key
+
+ Add Key on Numpad
-
- % key
+
+ Number 0 on Numpad
-
- & key
+
+ Number 1 on Numpad
-
- ' key
+
+ Number 2 on Numpad
-
- ( key
+
+ Number 3 on Numpad
-
- ) key
+
+ Number 4 on Numpad
-
- * key
+
+ Number 5 on Numpad
-
- + key
+
+ Number 6 on Numpad
-
- , key
+
+ Number 7 on Numpad
-
- - key
+
+ Number 8 on Numpad
-
- . key
-
-
- / key
-
-
- Number 0
-
-
- Number 1
-
-
- Number 2
-
-
- Number 3
-
-
- Number 4
-
-
- Number 5
-
-
- Number 6
-
-
- Number 7
-
-
- Number 8
-
-
- Number 9
-
-
- : key
-
-
- ; key
-
-
- Lower than key
-
-
- = key
-
-
- Greater than key
-
-
- ? key
-
-
- @ key
-
-
- A Key
-
-
- B Key
-
-
- C Key
-
-
- D Key
-
-
- E Key
-
-
- F Key
-
-
- G Key
-
-
- H Key
-
-
- I Key
-
-
- J Key
-
-
- K Key
-
-
- L Key
-
-
- M Key
-
-
- N Key
-
-
- O Key
-
-
- P Key
-
-
- Q Key
-
-
- R Key
-
-
- S Key
-
-
- T Key
-
-
- U Key
-
-
- V Key
-
-
- W Key
-
-
- X Key
-
-
- Y Key
-
-
- Z Key
-
-
- [ key
-
-
- \ key
-
-
- ] key
-
-
- ^ key
-
-
- _ key
-
-
-
-
- { key
-
-
- | key
-
-
- } key
-
-
- ~ key
-
-
-
-
-
-
- ¢ key
-
-
-
-
-
-
-
-
- ¦ key
-
-
- § key
+
+ Number 9 on Numpad
¨ key
@@ -1438,356 +1526,266 @@
-
-
-
-
-
-
-
-
-
+
-
+
+ Space Key
+
+
+ ! key
+
+
+
+
+
+
+
+
+ " key
+
+
+ # key
+
+
+ $ key
+
+
+ % key
+
+
+ & key
+
+
+ ' key
+
+
+ ( key
+
+
+ ) key
+
+
+ * key
+
+
+ + key
+
+
+ , key
+
+
+ - key
+
+
+ . key
+
+
+ / key
+
+
+ Number 0
+
+
+ Number 1
+
+
+ Number 2
+
+
+ Number 3
+
+
+ Number 4
+
+
+ Number 5
-
+
+ Number 6
-
- Left Mouse Button
+
+ Number 7
-
- Right Mouse Button
+
+ Number 8
-
- Middle Mouse Button
+
+ Number 9
-
- Mouse wheel up
+
+ : key
-
- Mouse wheel down
+
+ ; key
-
- Mouse wheel left button
+
+ Lower than key
-
- Mouse wheel right button
+
+ = key
-
+
+ Greater than key
-
+
+ ? key
-
+
+ @ key
-
- Joystick Button 0
+
+ A Key
-
- Joystick Button 1
+
+ B Key
-
- Joystick Button 2
+
+ C Key
-
- Joystick Button 3
+
-
- Joystick Button 4
+
+ D Key
-
- Joystick Button 5
+
+ E Key
-
- Joystick Button 6
+
+ F Key
-
- Joystick Button 7
+
+ G Key
-
- Joystick Button 8
+
+ H Key
-
- Joystick Button 9
+
+ I Key
-
- Joystick Button 10
+
+ J Key
-
- Joystick Button 11
+
+ K Key
-
- Joystick Button 12
+
+ L Key
-
- Joystick Button 13
+
+ M Key
-
- Joystick Button 14
+
+ N Key
-
- Joystick Button 15
+
+ O Key
-
- Joystick Button 16
+
+ P Key
-
- Super Nintendo Entertaiment System controller A button
+
+ Q Key
-
- Super Nintendo Entertaiment System controller B button
+
+ R Key
-
- Super Nintendo Entertaiment System controller X button
+
+ S Key
-
- Super Nintendo Entertaiment System controller Y button
+
+ T Key
-
- DUALSHOCK circle button
+
+ U Key
-
- DUALSHOCK X button
+
+ V Key
-
- DUALSHOCK square button
+
+ W Key
-
- DUALSHOCK triangle button
+
+ X Key
-
- SEGA controller B button
+
+ Y Key
-
- SEGA controller A button
+
+ Z Key
-
- SEGA controller X button
+
+ [ key
-
- SEGA controller Y button
+
+ \ key
-
- XBOX controller B button
+
+ ] key
-
- XBOX controller A button
+
+ ^ key
-
- XBOX controller X button
+
+ _ key
-
- XBOX controller Y button
+
-
+
+ Left margin, used usually for [Control] or [StyleBox] derived classes.
-
+
+ Top margin, used usually for [Control] or [StyleBox] derived classes.
-
+
+ Right margin, used usually for [Control] or [StyleBox] derived classes.
-
+
+ Bottom margin, used usually for [Control] or [StyleBox] derived classes.
-
- Joystick Button Select
+
-
- Joystick Button Start
+
-
- Joystick DPad Up
+
-
- Joystick DPad Down
+
-
- Joystick DPad Left
+
-
- Joystick DPad Right
+
-
- Joystick Left Shoulder Button
+
-
- Joystick Left Trigger
-
-
- Joystick Left Stick Click
-
-
- Joystick Right Shoulder Button
-
-
- Joystick Right Trigger
-
-
- Joystick Right Stick Click
-
-
- Joystick Left Stick Horizontal Axis
-
-
- Joystick Left Stick Vertical Axis
-
-
- Joystick Right Stick Horizontal Axis
-
-
- Joystick Right Stick Vertical Axis
-
-
-
-
-
-
- Joystick Left Trigger Analog Axis
-
-
- Joystick Right Trigger Analog Axis
-
-
-
-
- Joystick Left Stick Horizontal Axis
-
-
- Joystick Left Stick Vertical Axis
-
-
- Joystick Right Stick Horizontal Axis
-
-
- Joystick Right Stick Vertical Axis
-
-
-
-
-
-
-
-
+
Functions that return Error return OK when everything went ok. Most functions don't return error anyway and/or just print errors to stdout.
-
- Generic fail return error.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
No hint for edited property.
Hints that the string is a range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
-
- Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
-
-
- Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties.
-
-
-
-
-
-
-
-
- Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers.
-
-
- Property hint for a bitmask description that covers all 32 bits. Valid only for integers.
+
+ Property will be used as storage (default).
String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "*.doc".
+
+
String property is a directory (so pop up a file dialog when edited).
+
+
@@ -1797,62 +1795,60 @@
+
+
-
- Property will be used as storage (default).
+
+ Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
Property will be visible in editor (default).
-
-
-
-
-
-
-
-
-
-
-
+
-
+
+ Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties.
-
+
-
+
+
+
-
+
+
+
+
+
+
+
+
+
Default usage (storage and editor).
-
+
+ Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers.
-
+
-
+
-
+
+ Property hint for a bitmask description that covers all 32 bits. Valid only for integers.
-
-
-
-
-
-
-
-
-
+
+ Scancodes with this bit applied are non printable.
Variable is of type nil (only applied for null).
@@ -1860,30 +1856,6 @@
Variable is of type [bool].
-
- Variable is of type [int].
-
-
- Variable is of type [float]/real.
-
-
- Variable is of type [String].
-
-
- Variable is of type [Vector2].
-
-
- Variable is of type [Rect2].
-
-
- Variable is of type [Vector3].
-
-
- Variable is of type [Matrix32].
-
-
- Variable is of type [Plane].
-
Variable is of type [Quat].
@@ -1914,6 +1886,9 @@
Variable is of type [InputEvent].
+
+ Variable is of type [int].
+
Variable is of type [Dictionary].
@@ -1936,6 +1911,39 @@
+
+ Variable is of type [float]/real.
+
+
+ Variable is of type [String].
+
+
+ Variable is of type [Vector2].
+
+
+ Variable is of type [Rect2].
+
+
+ Variable is of type [Vector3].
+
+
+ Variable is of type [Matrix32].
+
+
+ Variable is of type [Plane].
+
+
+ Vertical top alignment, usually for text-derived classes.
+
+
+ Vertical center alignment, usually for text-derived classes.
+
+
+ Vertical bottom alignment, usually for text-derived classes.
+
+
+ General vertical alignment, used usually for [Separator], [ScrollBar], [Slider], etc.
+
@@ -1946,6 +1954,17 @@
AABB provides an 3D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for simple (fast) overlap tests.
+
+
+
+
+
+
+
+
+ Optional constructor, accepts position and size.
+
+
@@ -2110,28 +2129,17 @@
Combine this [AABB] with another, a larger one is returned that contains both.
-
-
-
-
-
-
-
-
- Optional constructor, accepts position and size.
-
-
+
+ Ending corner.
+
Position (starting corner).
Size from position to end.
-
- Ending corner.
-
@@ -2144,34 +2152,6 @@
This dialog is useful for small notifications to the user about an event. It can only be accepted or closed, with the same result.
-
-
-
-
- Return the OK Button.
-
-
-
-
-
-
- Return the label used for built-in text.
-
-
-
-
-
-
- Set whether the dialog is hidden when accepted (default true).
-
-
-
-
-
-
- Return true if the dialog will be hidden when accepted (default true).
-
-
@@ -2195,6 +2175,34 @@
Add custom cancel button to the dialog and return the created button.
+
+
+
+
+ Return true if the dialog will be hidden when accepted (default true).
+
+
+
+
+
+
+ Return the label used for built-in text.
+
+
+
+
+
+
+ Return the OK Button.
+
+
+
+
+
+
+ Return the built-in label text.
+
+
@@ -2204,6 +2212,13 @@
Register a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted.
+
+
+
+
+ Set whether the dialog is hidden when accepted (default true).
+
+
@@ -2211,13 +2226,6 @@
Set the built-in label text.
-
-
-
-
- Return the built-in label text.
-
-
@@ -2244,11 +2252,31 @@
Sprite node that can use multiple textures for animation.
-
-
-
+
+
+
- Set the [SpriteFrames] resource, which contains all frames.
+
+
+
+
+
+
+ Return the visible frame index.
+
+
+
+
+
+
+ Return the color modulation for this sprite.
+
+
+
+
+
+
+ Return the offset of the sprite in the node origin.
@@ -2258,14 +2286,29 @@
Get the [SpriteFrames] resource, which contains all frames.
-
-
-
+
+
+
+ Return true when centered. See [method set_centered].
-
-
+
+
+
+
+ Return true if sprite is flipped horizontally.
+
+
+
+
+
+
+ Return true if sprite is flipped vertically.
+
+
+
+
@@ -2276,13 +2319,9 @@
-
-
-
-
-
-
-
+
+
+
@@ -2293,27 +2332,6 @@
When turned on, offset at (0,0) is the center of the sprite, when off, the top-left corner is.
-
-
-
-
- Return true when centered. See [method set_centered].
-
-
-
-
-
-
- Set the offset of the sprite in the node origin. Position varies depending on whether it is centered or not.
-
-
-
-
-
-
- Return the offset of the sprite in the node origin.
-
-
@@ -2321,13 +2339,6 @@
If true, sprite is flipped horizontally.
-
-
-
-
- Return true if sprite is flipped horizontally.
-
-
@@ -2335,13 +2346,6 @@
If true, sprite is flipped vertically.
-
-
-
-
- Return true if sprite is flipped vertically.
-
-
@@ -2349,13 +2353,6 @@
Set the visible sprite frame index (from the list of frames inside the [SpriteFrames] resource).
-
-
-
-
- Return the visible frame index.
-
-
@@ -2363,11 +2360,22 @@
Change the color modulation (multiplication) for this sprite.
-
-
-
+
+
+
+
+ Set the offset of the sprite in the node origin. Position varies depending on whether it is centered or not.
+
+
+
+
+
+
+ Set the [SpriteFrames] resource, which contains all frames.
+
+
+
- Return the color modulation for this sprite.
@@ -2387,9 +2395,15 @@
-
-
-
+
+
+
+
+
+
+
+
+
@@ -2399,14 +2413,8 @@
-
-
-
-
-
-
-
-
+
+
@@ -2417,13 +2425,9 @@
-
-
-
-
-
-
-
+
+
+
@@ -2433,9 +2437,13 @@
-
-
-
+
+
+
+
+
+
+
@@ -2469,45 +2477,9 @@
Add a track to the Animation. The track type must be specified as any of the values in the TYPE_* enumeration.
-
-
-
+
- Remove a track by specifying the track index.
-
-
-
-
-
-
- Return the amount of tracks in the animation.
-
-
-
-
-
-
-
-
- Get the type of a track.
-
-
-
-
-
-
-
-
- Get the path of a track. for more information on the path format, see [method track_set_path]
-
-
-
-
-
-
-
-
- Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". Example: "character/skeleton:ankle" or "character/mesh:transform/local"
+ Clear the animation (clear all tracks and reset all).
@@ -2518,201 +2490,37 @@
-
-
-
-
- Move a track up.
-
-
-
-
-
-
- Move a track down.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Insert a transform key for a transform track.
-
-
-
-
-
-
-
-
-
-
-
-
- Insert a generic key in a given track.
-
-
-
-
-
-
-
-
- Remove a key by index in a given track.
-
-
-
-
-
-
-
-
- Remove a key by position (seconds) in a given track.
-
-
-
-
-
-
-
-
-
-
- Set the value of an existing key.
-
-
-
-
-
-
-
-
-
-
- Set the transition curve (easing) for a specific key (see built-in math function "ease").
-
-
-
+
-
-
-
-
- Return the transition curve (easing) for a specific key (see built-in math function "ease").
+ Return the total length of the animation (in seconds).
-
-
-
-
-
-
- Return the amount of keys in a given track.
-
-
-
-
-
-
-
-
- Return the value of a given key in a given track.
-
-
-
+
-
-
-
-
- Return the time at which the key is located.
-
+
-
-
-
-
-
-
- Find the key index by time in a given track. Optionally, only find it if the exact time is given.
+ Return the amount of tracks in the animation.
-
-
-
-
-
-
- Set the interpolation type of a given track, from the INTERPOLATION_* enum.
-
-
-
-
-
-
-
-
- Return the interpolation type of a given track, from the INTERPOLATION_* enum.
-
-
-
-
-
-
-
-
-
-
- Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3]), rotation ([Quat]) and scale ([Vector3]).
-
-
-
-
-
-
-
-
- Enable or disable interpolation for a whole track. By default tracks are interpolated.
-
-
-
+
-
-
- Return whether interpolation is enabled or disabled for a whole track. By default tracks are interpolated.
+ Return whether the animation has the loop flag set.
-
-
+
+
-
-
-
-
-
-
- Return all the key indices of a value track, given a position and delta time.
@@ -2750,6 +2558,13 @@
Return the arguments values to be called on a method track for a given key in a given track.
+
+
+
+
+ Remove a track by specifying the track index.
+
+
@@ -2757,13 +2572,6 @@
Set 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.
-
-
-
-
- Return the total length of the animation (in seconds).
-
-
@@ -2771,11 +2579,10 @@
Set 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.
-
-
-
+
+
+
- Return whether the animation has the loop flag set.
@@ -2784,19 +2591,255 @@
-
+
+
+
+
+
+
+
+
+
+
+ Find the key index by time in a given track. Optionally, only find it if the exact time is given.
+
+
+
+
+
+
+
+
+ Return the interpolation type of a given track, from the INTERPOLATION_* enum.
+
+
+
+
+
+
+
+
+ Return the amount of keys in a given track.
+
+
+
+
+
+
+
+
+ Return the time at which the key is located.
+
+
+
+
+
+
+
+
+
+
+ Return the transition curve (easing) for a specific key (see built-in math function "ease").
+
+
+
+
+
+
+
+
+ Return the value of a given key in a given track.
+
+
+
+
+
+
+
+
+ Get the path of a track. for more information on the path format, see [method track_set_path]
+
+
+
+
+
+
+
+
+ Get the type of a track.
+
+
+
+
+
+
+
+
+
+
+
+
+ Insert a generic key in a given track.
+
+
+
+
+
+
+
-
+
+
+
+
+ Move a track down.
+
+
+
+
+
+
+ Move a track up.
+
+
+
+
+
+
+
+
+ Remove a key by index in a given track.
+
+
+
+
+
+
+
+
+ Remove a key by position (seconds) in a given track.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Set the interpolation type of a given track, from the INTERPOLATION_* enum.
+
+
+
+
+
+
+
+
+
+
+ Set the transition curve (easing) for a specific key (see built-in math function "ease").
+
+
+
+
+
+
+
+
+
+
+ Set the value of an existing key.
+
+
+
+
+
+
+
+
+ Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". Example: "character/skeleton:ankle" or "character/mesh:transform/local"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Insert a transform key for a transform track.
+
+
+
+
+
+
+
+
+
+
+ Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3]), rotation ([Quat]) and scale ([Vector3]).
+
+
+
+
+
+
+
+
+
+
+
+
+ Return all the key indices of a value track, given a position and delta time.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Clear the animation (clear all tracks and reset all).
+
+ No interpolation (nearest value).
+
+
+ Linear interpolation.
+
+
+ Cubic interpolation.
+
Value tracks set values in node properties, but only those which can be Interpolated.
@@ -2806,14 +2849,11 @@
Method tracks call functions with given arguments per key.
-
- No interpolation (nearest value).
+
-
- Linear interpolation.
+
-
- Cubic interpolation.
+
@@ -2836,29 +2876,46 @@
Add an animation resource to the player, which will be later referenced by the "name" argument.
-
-
+
+
- Remove an animation from the player (by supplying the same name used to add it).
+ Used to skip ahead or skip back in an animation. Delta is the time in seconds to skip.
-
-
-
-
-
-
- Rename an existing animation.
-
-
-
-
+
+
-
+
- Request whether an [Animation] name exist within the player.
+
+
+
+
+
+
+
+
+
+
+
+
+ The animation player creates caches for faster access to the nodes it will animate. However, if a specific node is removed, it may not notice it, so clear_caches will force the player to search for the nodes again.
+
+
+
+
+ If animations are queued to play, clear them.
+
+
+
+
+
+
+
+
+ Find an animation name by resource.
@@ -2877,31 +2934,18 @@
Get the list of names of the animations stored in the player.
-
-
-
-
-
+
+
+
+ Return the mode in which the animation player processes. See [method set_animation_process_mode].
-
+
-
-
-
-
-
-
-
-
-
-
-
-
- Specify a blend time (in seconds) between two animations, referenced by their names.
+ Return the name of the animation that will be automatically played when the scene is loaded.
@@ -2915,11 +2959,25 @@
Get the blend time between two animations, referenced by their names.
-
-
-
+
+
+
- Set the default blend time between animations.
+ Return the name of the animation being played.
+
+
+
+
+
+
+ Get the length (in seconds) of the currently being played animation.
+
+
+
+
+
+
+ Get the position (in seconds) of the currently being played animation.
@@ -2929,6 +2987,50 @@
Return the default blend time between animations.
+
+
+
+
+ Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided).
+
+
+
+
+
+
+ Return path to root node (see [method set_root]).
+
+
+
+
+
+
+ Get the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is [i]1[/i] (no scaling).
+
+
+
+
+
+
+
+
+ Request whether an [Animation] name exist within the player.
+
+
+
+
+
+
+ Return true if the player is active.
+
+
+
+
+
+
+ Return whether an animation is playing.
+
+
@@ -2951,6 +3053,99 @@
Play a given animation by the animation name in reverse.
+
+
+
+
+ Queue an animation for playback once the current one is done.
+
+
+
+
+
+
+ Remove an animation from the player (by supplying the same name used to add it).
+
+
+
+
+
+
+
+
+ Rename an existing animation.
+
+
+
+
+
+
+
+
+ Seek the animation to a given position in time (in seconds). If 'update' is true, the animation will be updated too, otherwise it will be updated at process time.
+
+
+
+
+
+
+ Set the player as active (playing). If false, it
+ will do nothing.
+
+
+
+
+
+
+ Set the mode in which the animation player processes. By default, it processes on idle time (framerate dependent), but using fixed time works well for animating static collision bodies in 2D and 3D. See enum ANIMATION_PROCESS_*.
+
+
+
+
+
+
+ Set the name of the animation that will be automatically played when the scene is loaded.
+
+
+
+
+
+
+
+
+
+
+ Specify a blend time (in seconds) between two animations, referenced by their names.
+
+
+
+
+
+
+ Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play().
+
+
+
+
+
+
+ Set the default blend time between animations.
+
+
+
+
+
+
+ AnimationPlayer resolves animation track paths from this node (which is relative to itself), by default root is "..", but it can be changed.
+
+
+
+
+
+
+ Set a speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is [i]1[/i] (no scaling).
+
+
@@ -2963,170 +3158,8 @@
Stop playback of animations (deprecated).
-
-
-
-
- Return whether an animation is playing.
-
-
-
-
-
-
- Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play().
-
-
-
-
-
-
- Return the name of the animation being played.
-
-
-
-
-
-
- Queue an animation for playback once the current one is done.
-
-
-
-
- If animations are queued to play, clear them.
-
-
-
-
-
-
- Set the player as active (playing). If false, it
- will do nothing.
-
-
-
-
-
-
- Return true if the player is active.
-
-
-
-
-
-
- Set a speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is [i]1[/i] (no scaling).
-
-
-
-
-
-
- Get the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is [i]1[/i] (no scaling).
-
-
-
-
-
-
- Set the name of the animation that will be automatically played when the scene is loaded.
-
-
-
-
-
-
- Return the name of the animation that will be automatically played when the scene is loaded.
-
-
-
-
-
-
- AnimationPlayer resolves animation track paths from this node (which is relative to itself), by default root is "..", but it can be changed.
-
-
-
-
-
-
- Return path to root node (see [method set_root]).
-
-
-
-
-
-
-
-
- Seek the animation to a given position in time (in seconds). If 'update' is true, the animation will be updated too, otherwise it will be updated at process time.
-
-
-
-
-
-
- Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided).
-
-
-
-
-
-
-
-
- Find an animation name by resource.
-
-
-
-
- The animation player creates caches for faster access to the nodes it will animate. However, if a specific node is removed, it may not notice it, so clear_caches will force the player to search for the nodes again.
-
-
-
-
-
-
- Set the mode in which the animation player processes. By default, it processes on idle time (framerate dependent), but using fixed time works well for animating static collision bodies in 2D and 3D. See enum ANIMATION_PROCESS_*.
-
-
-
-
-
-
- Return the mode in which the animation player processes. See [method set_animation_process_mode].
-
-
-
-
-
-
- Get the position (in seconds) of the currently being played animation.
-
-
-
-
-
-
- Get the length (in seconds) of the currently being played animation.
-
-
-
-
-
-
- Used to skip ahead or skip back in an animation. Delta is the time in seconds to skip.
-
-
-
-
-
-
- Notifies when an animation starts playing.
-
-
@@ -3136,6 +3169,13 @@
If the currently being played animation changes, this signal will notify of such change.
+
+
+
+
+ Notifies when an animation starts playing.
+
+
Notifies when an animation finished playing.
@@ -3168,6 +3208,191 @@
Add a node of a given type in the graph with given id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Set the animation for an animation node.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -3177,26 +3402,6 @@
Check if a node exists (by name).
-
-
-
-
-
-
-
-
- Rename a node in the graph.
-
-
-
-
-
-
-
-
- Get the node type, will return from NODE_* enum.
-
-
@@ -3217,54 +3422,55 @@
Return the input source for a given node input.
-
-
-
-
-
-
- Set the animation for an animation node.
-
-
-
-
+
+
-
+
+
+
-
+
+ Get the node type, will return from NODE_* enum.
+
+
+
+
+
+
+
+
+
+
+ Rename a node in the graph.
+
+
+
+
+
+
-
-
+
+
-
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
@@ -3276,16 +3482,24 @@
-
+
+
+
-
-
-
-
+
+
+
+
+
+
+
+
+
+
@@ -3316,27 +3530,29 @@
-
-
-
+
+
+
-
-
-
+
+
+
-
-
-
+
+
+
+
+
@@ -3352,33 +3568,45 @@
-
-
-
+
+
+
+
+
-
-
-
-
-
-
+
+
+
+
+
+
-
-
-
-
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -3386,64 +3614,6 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -3452,14 +3622,6 @@
-
-
-
-
-
-
-
-
@@ -3468,10 +3630,18 @@
-
+
-
+
+
+
+
+
+
+
+
+
@@ -3484,7 +3654,25 @@
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -3502,12 +3690,10 @@
-
-
-
+
-
+
@@ -3520,152 +3706,6 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -3698,6 +3738,242 @@
General purpose area detection for 3D physics. Areas can be used for detection of objects that enter/exit them, as well as overriding space parameters (changing gravity, damping, etc). For this, use any space override different from AREA_SPACE_OVERRIDE_DISABLE and point gravity at the center of mass.
+
+
+
+
+ Return the angular damp rate.
+
+
+
+
+
+
+ Return the physics layers this area can scan for collisions.
+
+
+
+
+
+
+
+
+ Return an individual bit on the collision mask.
+
+
+
+
+
+
+ Return the gravity intensity.
+
+
+
+
+
+
+ Return the falloff factor for point gravity.
+
+
+
+
+
+
+ Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center.
+
+
+
+
+
+
+ Return the physics layer this area is in.
+
+
+
+
+
+
+
+
+ Return an individual bit on the layer mask.
+
+
+
+
+
+
+ Return the linear damp rate.
+
+
+
+
+
+
+ Return a list of the areas that are totally or partially inside this area.
+
+
+
+
+
+
+ Return a list of the bodies ([PhysicsBody]) that are totally or partially inside this area.
+
+
+
+
+
+
+ Return the processing order of this area.
+
+
+
+
+
+
+ Return the space override mode.
+
+
+
+
+
+
+ Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction.
+
+
+
+
+
+
+ Return whether this area can be detected by other, monitoring, areas.
+
+
+
+
+
+
+ Return whether this area detects bodies/areas entering/exiting it.
+
+
+
+
+
+
+
+
+ Return whether the area passed is totally or partially inside this area.
+
+
+
+
+
+
+
+
+ Return whether the body passed is totally or partially inside this area.
+
+
+
+
+
+
+ Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
+ In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
+
+
+
+
+
+
+ Set the physics layers this area can scan for collisions.
+
+
+
+
+
+
+
+
+ Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
+
+
+
+
+
+
+ Set whether this area can detect bodies/areas entering/exiting it.
+
+
+
+
+
+
+ Set the gravity intensity. This is useful to alter the force of gravity without altering its direction.
+ This value multiplies the gravity vector, whether it is the given vector ([method set_gravity_vector]), or a calculated one (when using a center of gravity).
+
+
+
+
+
+
+ Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance.
+
+
+
+
+
+
+ When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use [method set_gravity_vector]/[method get_gravity_vector].
+
+
+
+
+
+
+ Set the gravity vector. This vector does not have to be normalized.
+ If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center.
+
+
+
+
+
+
+ Set the physics layers this area is in.
+ Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask].
+ A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
+
+
+
+
+
+
+
+
+ Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
+
+
+
+
+
+
+ Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
+ In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
+
+
+
+
+
+
+ Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so.
+
+
+
+
+
+
+ Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have an space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent.
+ Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important.
+
+
@@ -3710,264 +3986,8 @@
AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
-
-
-
-
- Return the space override mode.
-
-
-
-
-
-
- When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use [method set_gravity_vector]/[method get_gravity_vector].
-
-
-
-
-
-
- Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction.
-
-
-
-
-
-
- Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance.
-
-
-
-
-
-
- Return the falloff factor for point gravity.
-
-
-
-
-
-
- Set the gravity vector. This vector does not have to be normalized.
- If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center.
-
-
-
-
-
-
- Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center.
-
-
-
-
-
-
- Set the gravity intensity. This is useful to alter the force of gravity without altering its direction.
- This value multiplies the gravity vector, whether it is the given vector ([method set_gravity_vector]), or a calculated one (when using a center of gravity).
-
-
-
-
-
-
- Return the gravity intensity.
-
-
-
-
-
-
- Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
- In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
-
-
-
-
-
-
- Return the angular damp rate.
-
-
-
-
-
-
- Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
- In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
-
-
-
-
-
-
- Return the linear damp rate.
-
-
-
-
-
-
- Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have an space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent.
- Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important.
-
-
-
-
-
-
- Return the processing order of this area.
-
-
-
-
-
-
- Set the physics layers this area can scan for collisions.
-
-
-
-
-
-
- Return the physics layers this area can scan for collisions.
-
-
-
-
-
-
- Set the physics layers this area is in.
- Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask].
- A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
-
-
-
-
-
-
- Return the physics layer this area is in.
-
-
-
-
-
-
-
-
- Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
-
-
-
-
-
-
-
-
- Return an individual bit on the collision mask.
-
-
-
-
-
-
-
-
- Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
-
-
-
-
-
-
-
-
- Return an individual bit on the layer mask.
-
-
-
-
-
-
- Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so.
-
-
-
-
-
-
- Return whether this area can be detected by other, monitoring, areas.
-
-
-
-
-
-
- Set whether this area can detect bodies/areas entering/exiting it.
-
-
-
-
-
-
- Return whether this area detects bodies/areas entering/exiting it.
-
-
-
-
-
-
- Return a list of the bodies ([PhysicsBody]) that are totally or partially inside this area.
-
-
-
-
-
-
- Return a list of the areas that are totally or partially inside this area.
-
-
-
-
-
-
-
-
- Return whether the body passed is totally or partially inside this area.
-
-
-
-
-
-
-
-
- Return whether the area passed is totally or partially inside this area.
-
-
-
-
-
-
- This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area.
-
-
-
-
-
-
-
-
-
-
-
-
- This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that reported the entering.
-
-
@@ -3988,26 +4008,6 @@
This signal triggers only once when an area enters this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering.
-
-
-
-
- This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area.
-
-
-
-
-
-
-
-
-
-
-
-
- This signal triggers only once when a body exits this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape exiting this area, and the fourth one is the index of the shape in this area that reported the exit.
-
-
@@ -4028,6 +4028,46 @@
This signal triggers only once when an area exits this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering.
+
+
+
+
+ This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area.
+
+
+
+
+
+
+
+
+
+
+
+
+ This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that reported the entering.
+
+
+
+
+
+
+ This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area.
+
+
+
+
+
+
+
+
+
+
+
+
+ This signal triggers only once when a body exits this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape exiting this area, and the fourth one is the index of the shape in this area that reported the exit.
+
+
@@ -4040,6 +4080,242 @@
General purpose area detection for 2D physics. Areas can be used for detection of objects that enter/exit them, as well as overriding space parameters (changing gravity, damping, etc). For this, use any space override different from AREA_SPACE_OVERRIDE_DISABLE and point gravity at the center of mass.
+
+
+
+
+ Return the angular damp rate.
+
+
+
+
+
+
+ Return the physics layers this area can scan for collisions.
+
+
+
+
+
+
+
+
+ Return an individual bit on the collision mask.
+
+
+
+
+
+
+ Return the gravity intensity.
+
+
+
+
+
+
+ Return the falloff factor for point gravity.
+
+
+
+
+
+
+ Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center.
+
+
+
+
+
+
+ Return the physics layer this area is in.
+
+
+
+
+
+
+
+
+ Return an individual bit on the layer mask.
+
+
+
+
+
+
+ Return the linear damp rate.
+
+
+
+
+
+
+ Return a list of the areas that are totally or partially inside this area.
+
+
+
+
+
+
+ Return a list of the bodies ([PhysicsBody2D]) that are totally or partially inside this area.
+
+
+
+
+
+
+ Return the processing order of this area.
+
+
+
+
+
+
+ Return the space override mode.
+
+
+
+
+
+
+ Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction.
+
+
+
+
+
+
+ Return whether this area can be detected by other, monitoring, areas.
+
+
+
+
+
+
+ Return whether this area detects bodies/areas entering/exiting it.
+
+
+
+
+
+
+
+
+ Return whether the area passed is totally or partially inside this area.
+
+
+
+
+
+
+
+
+ Return whether the body passed is totally or partially inside this area.
+
+
+
+
+
+
+ Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
+ In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
+
+
+
+
+
+
+ Set the physics layers this area can scan for collisions.
+
+
+
+
+
+
+
+
+ Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
+
+
+
+
+
+
+ Set whether this area can detect bodies/areas entering/exiting it.
+
+
+
+
+
+
+ Set the gravity intensity. This is useful to alter the force of gravity without altering its direction.
+ This value multiplies the gravity vector, whether it is the given vector ([method set_gravity_vector]), or a calculated one (when using a center of gravity).
+
+
+
+
+
+
+ Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance.
+
+
+
+
+
+
+ When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use [method set_gravity_vector]/[method get_gravity_vector].
+
+
+
+
+
+
+ Set the gravity vector. This vector does not have to be normalized.
+ If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center.
+
+
+
+
+
+
+ Set the physics layers this area is in.
+ Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask].
+ A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
+
+
+
+
+
+
+
+
+ Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
+
+
+
+
+
+
+ Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
+ In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
+
+
+
+
+
+
+ Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so.
+
+
+
+
+
+
+ Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have an space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent.
+ Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important.
+
+
@@ -4052,264 +4328,8 @@
AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
-
-
-
-
- Return the space override mode.
-
-
-
-
-
-
- When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use [method set_gravity_vector]/[method get_gravity_vector].
-
-
-
-
-
-
- Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction.
-
-
-
-
-
-
- Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance.
-
-
-
-
-
-
- Return the falloff factor for point gravity.
-
-
-
-
-
-
- Set the gravity vector. This vector does not have to be normalized.
- If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center.
-
-
-
-
-
-
- Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center.
-
-
-
-
-
-
- Set the gravity intensity. This is useful to alter the force of gravity without altering its direction.
- This value multiplies the gravity vector, whether it is the given vector ([method set_gravity_vector]), or a calculated one (when using a center of gravity).
-
-
-
-
-
-
- Return the gravity intensity.
-
-
-
-
-
-
- Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
- In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
-
-
-
-
-
-
- Return the linear damp rate.
-
-
-
-
-
-
- Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
- In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
-
-
-
-
-
-
- Return the angular damp rate.
-
-
-
-
-
-
- Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have an space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent.
- Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important.
-
-
-
-
-
-
- Return the processing order of this area.
-
-
-
-
-
-
- Set the physics layers this area can scan for collisions.
-
-
-
-
-
-
- Return the physics layers this area can scan for collisions.
-
-
-
-
-
-
- Set the physics layers this area is in.
- Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask].
- A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
-
-
-
-
-
-
- Return the physics layer this area is in.
-
-
-
-
-
-
-
-
- Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
-
-
-
-
-
-
-
-
- Return an individual bit on the collision mask.
-
-
-
-
-
-
-
-
- Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
-
-
-
-
-
-
-
-
- Return an individual bit on the layer mask.
-
-
-
-
-
-
- Set whether this area can detect bodies/areas entering/exiting it.
-
-
-
-
-
-
- Return whether this area detects bodies/areas entering/exiting it.
-
-
-
-
-
-
- Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so.
-
-
-
-
-
-
- Return whether this area can be detected by other, monitoring, areas.
-
-
-
-
-
-
- Return a list of the bodies ([PhysicsBody2D]) that are totally or partially inside this area.
-
-
-
-
-
-
- Return a list of the areas that are totally or partially inside this area.
-
-
-
-
-
-
-
-
- Return whether the body passed is totally or partially inside this area.
-
-
-
-
-
-
-
-
- Return whether the area passed is totally or partially inside this area.
-
-
-
-
-
-
- This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area.
-
-
-
-
-
-
-
-
-
-
-
-
- This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that reported the entering.
-
-
@@ -4330,26 +4350,6 @@
This signal triggers only once when an area enters this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering.
-
-
-
-
- This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area.
-
-
-
-
-
-
-
-
-
-
-
-
- This signal triggers only once when a body exits this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape exiting this area, and the fourth one is the index of the shape in this area that reported the exit.
-
-
@@ -4370,6 +4370,46 @@
This signal triggers only once when an area exits this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering.
+
+
+
+
+ This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area.
+
+
+
+
+
+
+
+
+
+
+
+
+ This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that reported the entering.
+
+
+
+
+
+
+ This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area.
+
+
+
+
+
+
+
+
+
+
+
+
+ This signal triggers only once when a body exits this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape exiting this area, and the fourth one is the index of the shape in this area that reported the exit.
+
+
@@ -4382,6 +4422,69 @@
Generic array, contains several elements of any type, accessible by numerical index starting at 0. Negative indices can be used to count from the right, like in Python. Arrays are always passed by reference.
+
+
+
+
+
+
+ Construct an array from a [RawArray].
+
+
+
+
+
+
+
+
+ Construct an array from a [RawArray].
+
+
+
+
+
+
+
+
+ Construct an array from a [RawArray].
+
+
+
+
+
+
+
+
+ Construct an array from a [RawArray].
+
+
+
+
+
+
+
+
+ Construct an array from a [RawArray].
+
+
+
+
+
+
+
+
+ Construct an array from a [RawArray].
+
+
+
+
+
+
+
+
+ Construct an array from a [RawArray].
+
+
@@ -4535,69 +4638,6 @@
Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise.
-
-
-
-
-
-
- Construct an array from a [RawArray].
-
-
-
-
-
-
-
-
- Construct an array from a [RawArray].
-
-
-
-
-
-
-
-
- Construct an array from a [RawArray].
-
-
-
-
-
-
-
-
- Construct an array from a [RawArray].
-
-
-
-
-
-
-
-
- Construct an array from a [RawArray].
-
-
-
-
-
-
-
-
- Construct an array from a [RawArray].
-
-
-
-
-
-
-
-
- Construct an array from a [RawArray].
-
-
@@ -4608,21 +4648,15 @@
-
-
-
-
-
-
-
-
-
+
+
+
@@ -4632,15 +4666,21 @@
+
+
+
+
+
+
-
-
-
+
+
+
@@ -4656,6 +4696,34 @@
AudioServer is a low level server interface for audio access. It is in charge of creating sample data (playable audio) as well as its playback via a voice interface.
+
+
+
+
+ Free a [RID] resource.
+
+
+
+
+
+
+ Return the global scale for event-based stream playback.
+
+
+
+
+
+
+ Return the global scale for all voices.
+
+
+
+
+
+
+ Return the global scale for stream playback.
+
+
@@ -4670,13 +4738,13 @@
Even if a stereo sample consists of a left sample and a right sample, it still counts as one sample for length purposes.
-
+
+
+
-
-
- Set the description of an audio sample. Mainly used for organization.
+ Return the sample data as an array of bytes. The length will be the expected length in bytes.
@@ -4697,15 +4765,6 @@
Return the format of the audio sample, in the form of the SAMPLE_FORMAT_* enum.
-
-
-
-
-
-
- Return whether the sample is stereo (2 channels).
-
-
@@ -4715,15 +4774,49 @@
Return the length in samples (not bytes) of the audio sample. Even if a stereo sample consists of a left sample and a right sample, it still counts as one sample for length purposes.
-
+
+
+
-
+
+ Return the initial loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format].
+
+
+
+
+
+
- Set the sample data for a given sample as an array of floats. The length must be equal to the sample length or an error will be produced.
- For this method, a stereo sample is made from two samples. Thus, in case of a stereo sample, the array length must be twice the length returned by [method sample_get_length].
- Trying to alter a SAMPLE_FORMAT_IMA_ADPCM sample is not supported. It will throw an error to the console, but will not alter the sample data.
+ Return the final loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format].
+
+
+
+
+
+
+
+
+ Return the loop format for a sample, as a value from the SAMPLE_LOOP_* enum.
+
+
+
+
+
+
+
+
+ Return the mix rate of the given sample.
+
+
+
+
+
+
+
+
+ Return whether the sample is stereo (2 channels).
@@ -4739,49 +4832,13 @@
If the sample is stereo ([method sample_is_stereo]), multiply it by 2.
-
-
-
+
-
- Return the sample data as an array of bytes. The length will be the expected length in bytes.
-
-
-
-
-
-
+
- Change the default mix rate of a given sample.
-
-
-
-
-
-
-
-
- Return the mix rate of the given sample.
-
-
-
-
-
-
-
-
- Set the loop format for a sample from the SAMPLE_LOOP_* enum. As a warning, Ping Pong loops may not be available on some hardware-mixing platforms.
-
-
-
-
-
-
-
-
- Return the loop format for a sample, as a value from the SAMPLE_LOOP_* enum.
+ Set the description of an audio sample. Mainly used for organization.
@@ -4793,15 +4850,6 @@
Set the initial loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format].
-
-
-
-
-
-
- Return the initial loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format].
-
-
@@ -4811,13 +4859,54 @@
Set the final loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format].
-
-
-
+
+
+
- Return the final loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format].
+ Set the loop format for a sample from the SAMPLE_LOOP_* enum. As a warning, Ping Pong loops may not be available on some hardware-mixing platforms.
+
+
+
+
+
+
+
+
+ Change the default mix rate of a given sample.
+
+
+
+
+
+
+
+
+ Set the sample data for a given sample as an array of floats. The length must be equal to the sample length or an error will be produced.
+ For this method, a stereo sample is made from two samples. Thus, in case of a stereo sample, the array length must be twice the length returned by [method sample_get_length].
+ Trying to alter a SAMPLE_FORMAT_IMA_ADPCM sample is not supported. It will throw an error to the console, but will not alter the sample data.
+
+
+
+
+
+
+ Set global scale for event-based stream ([EventStream]) playback. Default is 1.0.
+
+
+
+
+
+
+ Set global scale for all voices (not including streams). Default is 1.0.
+
+
+
+
+
+
+ Set global scale for stream playback. Default is 1.0.
@@ -4827,133 +4916,13 @@
Allocate a voice for playback. Voices are persistent. A voice can play a single sample at the same time. See [method sample_create].
-
-
-
-
-
-
- Start playback of a given voice using a given sample. If the voice was already playing it will be restarted.
-
-
-
-
-
-
-
-
- Change the volume of a currently playing voice. Volume is expressed as linear gain where 0.0 is mute and 1.0 is default.
-
-
-
-
-
-
-
-
-
-
-
-
- Change the pan of a currently playing voice and, optionally, the depth and height for a positional/3D sound. Panning values are expressed within the -1 to +1 range.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Set a resonant filter post processing for the voice. Filter type is a value from the FILTER_* enum.
-
-
-
-
-
-
-
-
- Set chorus send post processing for the voice (from 0 to 1).
-
-
-
-
-
-
-
-
-
-
- Set the reverb send post processing for the voice (from 0 to 1) and the reverb type, from the REVERB_* enum.
-
-
-
-
-
-
-
-
- Set a different playback mix rate for the given voice.
-
-
-
-
-
-
-
-
- Set whether a given voice is positional. This is only interpreted as a hint and used for backends that may support binaural encoding.
-
-
-
+
- Return the current volume for a given voice.
-
-
-
-
-
-
-
-
- Return the current pan for a given voice (-1 to +1 range).
-
-
-
-
-
-
-
-
- Return the current pan height for a given voice (-1 to +1 range).
-
-
-
-
-
-
-
-
- Return the current pan depth for a given voice (-1 to +1 range).
-
-
-
-
-
-
-
-
- Return the current selected filter type for a given voice, from the FILTER_* enum.
+ Return the current chorus send for a given voice (0 to 1).
@@ -4974,31 +4943,13 @@
Return the current filter resonance for a given voice.
-
-
-
-
-
-
- Return the current chorus send for a given voice (0 to 1).
-
-
-
+
- Return the current reverb type for a given voice from the REVERB_* enum.
-
-
-
-
-
-
-
-
- Return the current reverb send for a given voice (0 to 1).
+ Return the current selected filter type for a given voice, from the FILTER_* enum.
@@ -5010,6 +4961,60 @@
Return the current mix rate for a given voice.
+
+
+
+
+
+
+ Return the current pan for a given voice (-1 to +1 range).
+
+
+
+
+
+
+
+
+ Return the current pan depth for a given voice (-1 to +1 range).
+
+
+
+
+
+
+
+
+ Return the current pan height for a given voice (-1 to +1 range).
+
+
+
+
+
+
+
+
+ Return the current reverb send for a given voice (0 to 1).
+
+
+
+
+
+
+
+
+ Return the current reverb type for a given voice from the REVERB_* enum.
+
+
+
+
+
+
+
+
+ Return the current volume for a given voice.
+
+
@@ -5019,6 +5024,90 @@
Return whether the current voice is positional. See [method voice_set_positional].
+
+
+
+
+
+
+ Start playback of a given voice using a given sample. If the voice was already playing it will be restarted.
+
+
+
+
+
+
+
+
+ Set chorus send post processing for the voice (from 0 to 1).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Set a resonant filter post processing for the voice. Filter type is a value from the FILTER_* enum.
+
+
+
+
+
+
+
+
+ Set a different playback mix rate for the given voice.
+
+
+
+
+
+
+
+
+
+
+
+
+ Change the pan of a currently playing voice and, optionally, the depth and height for a positional/3D sound. Panning values are expressed within the -1 to +1 range.
+
+
+
+
+
+
+
+
+ Set whether a given voice is positional. This is only interpreted as a hint and used for backends that may support binaural encoding.
+
+
+
+
+
+
+
+
+
+
+ Set the reverb send post processing for the voice (from 0 to 1) and the reverb type, from the REVERB_* enum.
+
+
+
+
+
+
+
+
+ Change the volume of a currently playing voice. Volume is expressed as linear gain where 0.0 is mute and 1.0 is default.
+
+
@@ -5026,75 +5115,8 @@
Stop a given voice.
-
-
-
-
- Free a [RID] resource.
-
-
-
-
-
-
- Set global scale for stream playback. Default is 1.0.
-
-
-
-
-
-
- Return the global scale for stream playback.
-
-
-
-
-
-
- Set global scale for all voices (not including streams). Default is 1.0.
-
-
-
-
-
-
- Return the global scale for all voices.
-
-
-
-
-
-
- Set global scale for event-based stream ([EventStream]) playback. Default is 1.0.
-
-
-
-
-
-
- Return the global scale for event-based stream playback.
-
-
-
- Sample format is 8 bits, signed.
-
-
- Sample format is 16 bits, little-endian, signed.
-
-
- Sample format is IMA-ADPCM compressed.
-
-
- Sample does not loop.
-
-
- Sample loops in forward mode.
-
-
- Sample loops in a bidirectional way.
-
Filter is disabled.
@@ -5125,6 +5147,24 @@
Large reverb room with long decay.
+
+ Sample format is 8 bits, signed.
+
+
+ Sample does not loop.
+
+
+ Sample format is 16 bits, little-endian, signed.
+
+
+ Sample loops in forward mode.
+
+
+ Sample format is IMA-ADPCM compressed.
+
+
+ Sample loops in a bidirectional way.
+
@@ -5194,59 +5234,25 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
@@ -5258,12 +5264,46 @@
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -5288,11 +5328,11 @@
Node for back-buffering the currently displayed screen. The region defined in the BackBufferCopy node is bufferized with the content of the screen it covers, or the entire screen according to the copy mode set. Accessing this buffer is done with the texscreen() shader instruction.
-
-
-
+
+
+
- Defines the area covered by the BackBufferCopy.
+ Return the copy mode currently applied to the BackBufferCopy (refer to constants section).
@@ -5309,11 +5349,11 @@
Set the copy mode of the BackBufferCopy (refer to constants section).
-
-
-
+
+
+
- Return the copy mode currently applied to the BackBufferCopy (refer to constants section).
+ Defines the area covered by the BackBufferCopy.
@@ -5335,54 +5375,6 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -5391,126 +5383,12 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
@@ -5521,110 +5399,12 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -5633,12 +5413,268 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
@@ -5649,6 +5685,10 @@
+
+
+
+
@@ -5657,12 +5697,6 @@
-
-
-
-
-
-
@@ -5675,6 +5709,12 @@
+
+
+
+
+
+
@@ -5691,14 +5731,6 @@
-
-
-
-
-
-
-
-
@@ -5707,15 +5739,23 @@
-
-
+
+
+
+
+
+
+
+
+
+
-
-
-
+
+
+
@@ -5753,62 +5793,6 @@
Called when button is toggled (only if toggle_mode is active).
-
-
-
-
- Set the button to pressed state (only if toggle_mode is active).
-
-
-
-
-
-
- If toggle_mode is active, return whether the button is toggled. If toggle_mode is not active, return whether the button is pressed down.
-
-
-
-
-
-
- Return true if mouse entered the button before it exit.
-
-
-
-
-
-
- Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked.
-
-
-
-
-
-
- Return the toggle_mode property (see [method set_toggle_mode]).
-
-
-
-
-
-
- Set the button into disabled state. When a button is disabled, it can't be clicked or toggled.
-
-
-
-
-
-
- Return whether the button is in disabled state (see [method set_disabled]).
-
-
-
-
-
-
- Set the button click_on_press mode. This mode generates click events when a mouse button or key is just pressed (by default events are generated when the button/keys are released and both press and release occur in the visual area of the Button).
-
-
@@ -5823,13 +5807,6 @@
Return 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.
-
-
-
-
- Sets the focus access mode to use when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]).
-
-
@@ -5837,20 +5814,88 @@
Returns focus access mode used when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]).
-
-
-
-
-
-
+
+
+
+
+ Return whether the button is in disabled state (see [method set_disabled]).
+
+
+
+
+
+
+ Return true if mouse entered the button before it exit.
+
+
+
+
+
+
+ If toggle_mode is active, return whether the button is toggled. If toggle_mode is not active, return whether the button is pressed down.
+
+
+
+
+
+
+ Return the toggle_mode property (see [method set_toggle_mode]).
+
+
+
+
+
+
+ Set the button click_on_press mode. This mode generates click events when a mouse button or key is just pressed (by default events are generated when the button/keys are released and both press and release occur in the visual area of the Button).
+
+
+
+
+
+
+ Set the button into disabled state. When a button is disabled, it can't be clicked or toggled.
+
+
+
+
+
+
+ Sets the focus access mode to use when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]).
+
+
+
+
+
+
+ Set the button to pressed state (only if toggle_mode is active).
+
+
+
+
+
+
+
+
+
+
+
+
+ Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked.
+
+
+
+
+ This signal is emitted every time the button is pressed or toggled.
+
+
This signal is emitted when the button was released.
@@ -5863,11 +5908,6 @@
This signal is emitted when the button was just toggled between pressed and normal states (only if toggle_mode is active). The new state is contained in the [i]pressed[/i] argument.
-
-
- This signal is emitted every time the button is pressed or toggled.
-
-
@@ -5902,14 +5942,6 @@
-
-
-
-
-
-
-
-
@@ -5918,11 +5950,9 @@
-
-
-
-
-
+
+
+
@@ -5932,9 +5962,19 @@
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -5948,57 +5988,6 @@
-
-
-
-
-
-
-
-
-
-
-
-
- Set the total font height (ascent plus descent) in pixels.
-
-
-
-
-
-
- Set the font ascent (number of pixels above the baseline).
-
-
-
-
-
-
-
-
-
-
- Add a kerning pair to the [BitmapFont] as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character.
-
-
-
-
-
-
-
-
-
-
- Return a kerning pair as a difference.
-
-
-
-
-
-
- Add a texture to the [BitmapFont].
-
-
@@ -6014,16 +6003,33 @@
Add a character to the font, where [i]character[/i] is the unicode value, [i]texture[/i] is the texture index, [i]rect[/i] is the region in the texture (in pixels!), [i]align[/i] is the (optional) alignment for the character and [i]advance[/i] is the (optional) advance.
-
-
-
+
+
+
+
+
+
+
+ Add a kerning pair to the [BitmapFont] as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character.
-
-
+
+
+
+
+ Add a texture to the [BitmapFont].
+
+
+
+
+ Clear all the font data.
+
+
+
+
-
+
@@ -6039,15 +6045,48 @@
Return the size of a character, optionally taking kerning into account if the next character is provided.
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return a kerning pair as a difference.
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+ Set the font ascent (number of pixels above the baseline).
+
+
+
+
+
- Clear all the font data.
@@ -6056,10 +6095,11 @@
-
-
-
+
+
+
+ Set the total font height (ascent plus descent) in pixels.
@@ -6129,13 +6169,6 @@
Box shape resource, which can be set into a [PhysicsBody] or area.
-
-
-
-
- Set the half extents for the shape.
-
-
@@ -6143,6 +6176,13 @@
Return the half extents of the shape.
+
+
+
+
+ Set the half extents for the shape.
+
+
@@ -6155,27 +6195,6 @@
Button is the standard themed button. It can contain text and an icon, and will display them according to the current [Theme].
-
-
-
-
- Set the button text, which will be displayed inside the button area.
-
-
-
-
-
-
- Return the button text.
-
-
-
-
-
-
- Set the icon that will be displayed next to the text inside the button area.
-
-
@@ -6183,20 +6202,6 @@
Return the button icon.
-
-
-
-
- Set the [i]flat[/i] property of a Button. Flat buttons don't display decoration unless hovered or pressed.
-
-
-
-
-
-
- Set the [i]clip_text[/i] property of a Button. When this property is enabled, text that is too large to fit the button is clipped, when disabled (default) the Button will always be wide enough to hold the text.
-
-
@@ -6204,11 +6209,11 @@
Return the state of the [i]clip_text[/i] property (see [method set_clip_text])
-
-
-
+
+
+
- Set the text alignment policy, using one of the ALIGN_* constants.
+ Return the button text.
@@ -6225,6 +6230,41 @@
Return the state of the [i]flat[/i] property (see [method set_flat]).
+
+
+
+
+ Set the icon that will be displayed next to the text inside the button area.
+
+
+
+
+
+
+ Set the [i]clip_text[/i] property of a Button. When this property is enabled, text that is too large to fit the button is clipped, when disabled (default) the Button will always be wide enough to hold the text.
+
+
+
+
+
+
+ Set the [i]flat[/i] property of a Button. Flat buttons don't display decoration unless hovered or pressed.
+
+
+
+
+
+
+ Set the button text, which will be displayed inside the button area.
+
+
+
+
+
+
+ Set the text alignment policy, using one of the ALIGN_* constants.
+
+
@@ -6238,28 +6278,28 @@
-
+
-
+
+
+
+
+
-
-
-
-
-
-
-
+
+
+
@@ -6287,31 +6327,23 @@
Append a new button to the array, with the specified icon and text.
-
-
-
-
-
+
- Define the text of the specified button.
+ Remove all buttons from the array.
-
+
-
-
- Set the icon of the specified button.
+ Remove the specified button in the array.
-
-
+
+
-
-
- Return the text of the specified button.
+ Return the amount of buttons in the array.
@@ -6323,18 +6355,13 @@
Return the icon of the specified button.
-
-
+
+
+
+
- Return the amount of buttons in the array.
-
-
-
-
-
-
- Return the index of the currently selected button in the array.
+ Return the text of the specified button.
@@ -6344,6 +6371,31 @@
Return the index of the currently hovered button in the array.
+
+
+
+
+ Return the index of the currently selected button in the array.
+
+
+
+
+
+
+
+
+ Set the icon of the specified button.
+
+
+
+
+
+
+
+
+ Define the text of the specified button.
+
+
@@ -6351,18 +6403,6 @@
Select a button in the array based on the given index.
-
-
-
-
- Remove the specified button in the array.
-
-
-
-
- Remove all buttons from the array.
-
-
@@ -6399,6 +6439,20 @@
Group of [Button]. All direct and indirect children buttons become radios. Only one allows being pressed.
+
+
+
+
+ Return the list of all the buttons in the group.
+
+
+
+
+
+
+ Return the focused button.
+
+
@@ -6413,20 +6467,6 @@
Return the index of the pressed button (by tree order).
-
-
-
-
- Return the focused button.
-
-
-
-
-
-
- Return the list of all the buttons in the group.
-
-
@@ -6450,95 +6490,10 @@
Camera is a special node that displays what is visible from its current location. Cameras register themselves in the nearest [Viewport] node (when ascending the tree). Only one camera can be active per viewport. If no viewport is available ascending the tree, the Camera will register in the global viewport. In other words, a Camera just provides [i]3D[/i] display capabilities to a [Viewport], and, without one, a scene registered in that [Viewport] (or higher viewports) can't be displayed.
-
-
-
-
-
-
- Return a normal vector in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Return a 3D position in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking.
-
-
-
-
-
-
-
-
- Return how a 3D point in worldspace maps to a 2D coordinate in the [Viewport] rectangle.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Set the camera projection to perspective mode, by specifying a [i]FOV[/i] Y angle in degrees (FOV means Field of View), and the [i]near[/i] and [i]far[/i] clip planes in worldspace units.
-
-
-
-
-
-
-
-
-
-
- Set the camera projection to orthogonal mode, by specifying a width and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels)
-
-
-
-
- Make this camera the current Camera for the [Viewport] (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added.
-
-
-
-
-
-
- Return whether the Camera is the current one in the [Viewport], or plans to become current (if outside the scene tree).
-
-
@@ -6546,18 +6501,42 @@
Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node] transform.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -6570,22 +6549,58 @@
-
-
+
+
+ Return whether the Camera is the current one in the [Viewport], or plans to become current (if outside the scene tree).
-
-
+
+
+
+
-
-
-
+
+ Make this camera the current Camera for the [Viewport] (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return a normal vector in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking.
+
+
+
+
+
+
+
+
+ Return a 3D position in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking.
@@ -6594,36 +6609,61 @@
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+ Set the camera projection to orthogonal mode, by specifying a width and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels)
+
+
+
+
+
+
+
+
+
+
+ Set the camera projection to perspective mode, by specifying a [i]FOV[/i] Y angle in degrees (FOV means Field of View), and the [i]near[/i] and [i]far[/i] clip planes in worldspace units.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return how a 3D point in worldspace maps to a 2D coordinate in the [Viewport] rectangle.
+
+
+
+
Perspective Projection (object's size on the screen becomes smaller when far away).
Orthogonal Projection (objects remain the same size on the screen no matter how far away they are).
-
-
-
-
@@ -6635,24 +6675,13 @@
This node is intended to be a simple helper get get things going quickly and it may happen often that more functionality is desired to change how the camera works. To make your own custom camera node, simply inherit from [Node2D] and change the transform of the canvas by calling get_viewport().set_canvas_transform(m) in [Viewport].
-
-
-
+
- Set the scroll offset. Useful for looking around or camera shake animations.
-
-
-
-
- Return the scroll offset.
-
-
-
-
-
+
+ Force the camera to update scroll immediately.
@@ -6661,118 +6690,6 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene.
-
-
-
-
-
-
-
-
-
-
- Return true of this is the current camera (see [method make_current]).
-
-
-
-
-
-
-
-
- Set the scrolling limit in pixels.
-
-
-
-
-
-
-
-
- Return the scrolling limit in pixels.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Set the margins needed to drag the camera (relative to the screen size). Margin uses the MARGIN_* enum. Drag margins of 0,0,0,0 will keep the camera at the center of the screen, while drag margins of 1,1,1,1 will only move when the camera is at the edges.
-
-
-
-
-
-
-
-
- Return the margins needed to drag the camera (see [method set_drag_margin]).
-
-
@@ -6786,10 +6703,47 @@
-
-
+
+
+
+
+ Return the margins needed to drag the camera (see [method set_drag_margin]).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return the scrolling limit in pixels.
+
+
+
+
+
+
+ Return the scroll offset.
+
+
+
+
+
+
@@ -6798,22 +6752,11 @@
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
-
+ Return true of this is the current camera (see [method make_current]).
@@ -6822,17 +6765,114 @@
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Set the margins needed to drag the camera (relative to the screen size). Margin uses the MARGIN_* enum. Drag margins of 0,0,0,0 will keep the camera at the center of the screen, while drag margins of 1,1,1,1 will only move when the camera is at the edges.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Set the scrolling limit in pixels.
+
+
+
+
+
+
+ Set the scroll offset. Useful for looking around or camera shake animations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Force the camera to update scroll immediately.
-
-
+
+
@@ -6852,165 +6892,45 @@
Called (if exists) to draw the canvas item.
-
-
-
-
- Used for editing, returns an opaque value representing the transform state.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Used for editing, handle rotation.
-
-
-
-
-
-
- Return a rect containing the editable contents of the item.
-
-
-
-
-
-
-
-
-
-
-
-
- Return the canvas item RID used by [VisualServer] for this item.
-
-
-
-
-
-
- Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden.
-
-
-
-
-
-
- Return true if this CanvasItem is hidden. Note that the CanvasItem may not be visible, but as long as it's not hidden ([method hide] called) the function will return false.
-
-
-
-
- Show the CanvasItem currently hidden.
-
-
-
-
- Hide the CanvasItem currently visible.
-
-
-
-
-
-
-
-
-
-
- Queue the CanvasItem for update. NOTIFICATION_DRAW will be called on idle time to request redraw.
-
-
-
-
-
-
- Set as toplevel. This means that it will not inherit transform from parent canvas items.
-
-
-
-
-
-
- Return if set as toplevel. See [method set_as_toplevel].
-
-
-
-
-
-
- Set the blending mode from enum BLEND_MODE_*.
-
-
-
-
-
-
- Return the current blending mode from enum BLEND_MODE_*.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Set canvas item opacity. This will affect the canvas item and all the children.
-
-
-
+
-
- Return the canvas item opacity. This affects the canvas item and all the children.
-
-
-
-
+
+
+
+
+
+
+
+
+
- Set canvas item self-opacity. This does not affect the opacity of children items.
+ Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char.
-
-
-
-
- Return the canvas item self-opacity.
-
-
-
-
+
+
+
+
+
+
- Sets whether the canvas item is drawn behind its parent.
+ Draw a colored circle.
-
-
-
+
+
+
+
+
+
+
+
+
- Return whether the item is drawn behind its parent.
+ Draw a colored polygon of any amount of points, convex or concave.
@@ -7026,6 +6946,34 @@
Draw a line from a 2D point to another, with a given color and width.
+
+
+
+
+
+
+
+
+
+
+ Draw a polygon of any amount of points, convex or concave.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Draw a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.
+
+
@@ -7035,15 +6983,39 @@
Draw a colored rectangle.
-
+
-
+
-
+
- Draw a colored circle.
+ Set a custom transform for drawing. Anything drawn afterwards will be transformed by this.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Draw a string using a custom font.
+
+
+
+
+
+
+
+
+ Draw a styled rectangle.
@@ -7087,105 +7059,62 @@
Draw a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
-
-
-
-
-
+
- Draw a styled rectangle.
-
-
-
-
-
-
-
-
-
-
+
+
- Draw a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.
+ Used for editing, handle rotation.
-
-
-
-
-
-
-
-
+
+
- Draw a polygon of any amount of points, convex or concave.
-
-
-
-
-
-
-
-
+
+
- Draw a colored polygon of any amount of points, convex or concave.
+ Used for editing, returns an opaque value representing the transform state.
-
-
-
-
-
-
-
-
-
-
-
-
- Draw a string using a custom font.
-
-
-
-
+
+
-
-
-
-
-
-
-
-
-
-
- Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char.
+ Return the current blending mode from enum BLEND_MODE_*.
-
-
-
-
-
-
-
+
+
+
- Set a custom transform for drawing. Anything drawn afterwards will be transformed by this.
-
+
+
+
+
+ Return the canvas item RID used by [VisualServer] for this item.
+
+
+
+
+
+
+
+
+
@@ -7198,20 +7127,21 @@
-
-
-
-
-
-
-
+
-
-
+
+
+
+
+ Return a rect containing the editable contents of the item.
+
+
+
+
@@ -7222,14 +7152,46 @@
-
-
+
+
-
-
+
+
+
+
+ Return the canvas item opacity. This affects the canvas item and all the children.
+
+
+
+
+
+
+ Return the canvas item self-opacity.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -7240,28 +7202,37 @@
-
-
-
+
+ Hide the CanvasItem currently visible.
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ Return whether the item is drawn behind its parent.
+
+
+
+
+
+
+ Return true if this CanvasItem is hidden. Note that the CanvasItem may not be visible, but as long as it's not hidden ([method hide] called) the function will return false.
+
+
+
+
+
+
+ Return if set as toplevel. See [method set_as_toplevel].
+
+
+
+
+
+
+ Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden.
@@ -7272,28 +7243,97 @@
+
+
+
+
+ Set as toplevel. This means that it will not inherit transform from parent canvas items.
+
+
+
+
+
+
+ Set the blending mode from enum BLEND_MODE_*.
+
+
+
+
+
+
+ Sets whether the canvas item is drawn behind its parent.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Set canvas item opacity. This will affect the canvas item and all the children.
+
+
+
+
+
+
+ Set canvas item self-opacity. This does not affect the opacity of children items.
+
+
+
+
+
+
+
+
+
+
+ Show the CanvasItem currently hidden.
+
+
+
+
+ Queue the CanvasItem for update. NOTIFICATION_DRAW will be called on idle time to request redraw.
+
+
-
-
- Emitted when the item rect has changed.
-
-
Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing.
-
-
- Emitted when the visibility (hidden/visible) changes.
-
-
Emitted when becoming hidden.
+
+
+ Emitted when the item rect has changed.
+
+
+
+
+ Emitted when the visibility (hidden/visible) changes.
+
+
@@ -7311,6 +7351,9 @@
Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value.
+
+ Canvas item transform has changed. Only received if requested.
+
CanvasItem is requested to draw.
@@ -7323,9 +7366,6 @@
Canvas item has exited the canvas.
-
- Canvas item transform has changed. Only received if requested.
-
@@ -7334,18 +7374,30 @@
-
-
+
+
+
+
+
+
+
+
-
-
+
+
+
+
+
+
+
+
@@ -7354,24 +7406,12 @@
-
-
-
-
-
-
-
-
-
-
-
-
@@ -7410,13 +7450,6 @@
Canvas Item layer. [CanvasItem] nodes that are direct or indirect children of a [CanvasLayer] will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a [CanvasLayer] with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below).
-
-
-
-
- Set the layer index, determines the draw order, a lower value will be below a higher one.
-
-
@@ -7424,27 +7457,6 @@
Return the layer index, determines the draw order, a lower value will be below a higher one.
-
-
-
-
- Set the base transform for this layer.
-
-
-
-
-
-
- Return the base transform for this layer.
-
-
-
-
-
-
- Set the base offset for this layer (helper).
-
-
@@ -7452,13 +7464,6 @@
Return the base offset for this layer (helper).
-
-
-
-
- Set the base rotation for this layer (helper).
-
-
@@ -7466,13 +7471,6 @@
Return the base rotation for this layer (helper).
-
-
-
-
- Set rotation of the layer in degree.
-
-
@@ -7480,13 +7478,6 @@
Get rotation of the layer in degree.
-
-
-
-
- Set the base scale for this layer (helper).
-
-
@@ -7494,6 +7485,20 @@
Return the base scale for this layer (helper).
+
+
+
+
+ Return the base transform for this layer.
+
+
+
+
+
+
+ Return the viewport RID for this layer.
+
+
@@ -7501,11 +7506,46 @@
Return the [World2D] used by this layer.
-
-
-
+
+
+
- Return the viewport RID for this layer.
+ Set the layer index, determines the draw order, a lower value will be below a higher one.
+
+
+
+
+
+
+ Set the base offset for this layer (helper).
+
+
+
+
+
+
+ Set the base rotation for this layer (helper).
+
+
+
+
+
+
+ Set rotation of the layer in degree.
+
+
+
+
+
+
+ Set the base scale for this layer (helper).
+
+
+
+
+
+
+ Set the base transform for this layer.
@@ -7520,13 +7560,6 @@
CanvasModulate tints the canvas elements using its asigned color
-
-
-
-
- Sets the canvas tint color
-
-
@@ -7534,6 +7567,13 @@
Gets the canvas tint color
+
+
+
+
+ Sets the canvas tint color
+
+
@@ -7546,11 +7586,11 @@
Capsule shape resource, which can be set into a [PhysicsBody] or area.
-
-
-
+
+
+
- Set the capsule radius.
+ Return the capsule height.
@@ -7567,11 +7607,11 @@
Set the capsule height.
-
-
-
+
+
+
- Return the capsule height.
+ Set the capsule radius.
@@ -7586,11 +7626,11 @@
Capsule 2D shape resource for physics. A capsule (or sometimes called "pill") is like a line grown in all directions. It has a radius and a height, and is often useful for modeling biped characters.
-
-
-
+
+
+
- Set the radius of the [CapsuleShape2D].
+ Return the height of the [CapsuleShape2D].
@@ -7607,11 +7647,11 @@
Set the height of the [CapsuleShape2D].
-
-
-
+
+
+
- Return the height of the [CapsuleShape2D].
+ Set the radius of the [CapsuleShape2D].
@@ -7626,13 +7666,6 @@
CenterContainer Keeps children controls centered. This container keeps all children to their minimum size, in the center.
-
-
-
-
- This function will anchor the container children to the top left corner of the the container boundaries, moving all its children to that position, (the children new center will be the top left corner of the container).
-
-
@@ -7640,6 +7673,13 @@
Should put children to the top left corner instead of center of the container.
+
+
+
+
+ This function will anchor the container children to the top left corner of the the container boundaries, moving all its children to that position, (the children new center will be the top left corner of the container).
+
+
@@ -7658,36 +7698,36 @@
-
+
-
+
+
+
+
+
+
+
-
+
-
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
@@ -7704,32 +7744,32 @@
-
+
-
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
@@ -7740,13 +7780,6 @@
Circular Shape for 2D Physics. This shape is useful for modeling balls or small characters and it's collision detection with everything else is very fast.
-
-
-
-
- Set the radius of the circle shape.
-
-
@@ -7754,6 +7787,13 @@
Return the radius of the circle shape.
+
+
+
+
+ Set the radius of the circle shape.
+
+
@@ -7786,88 +7826,10 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -7880,12 +7842,86 @@
-
-
-
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -7900,6 +7936,10 @@
+
+
+
+
@@ -7936,38 +7976,16 @@
Add a [Shape2D] to the collision body, with a given custom transform.
-
-
+
+
+ Remove all shapes.
+
+
+
+
- Return the amount of shapes in the collision body. Because a [CollisionPolygon2D] can generate more than one [Shape2D], the amount returned does not have to match the sum of [CollisionShape2D] and [CollisionPolygon2D].
-
-
-
-
-
-
-
-
- Change a shape in the collision body.
-
-
-
-
-
-
-
-
- Change the shape transform in the collision body.
-
-
-
-
-
-
-
-
- Set whether a shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked).
+ Return the RID of this object.
@@ -7979,6 +7997,13 @@
Return the shape in the given index.
+
+
+
+
+ Return the amount of shapes in the collision body. Because a [CollisionPolygon2D] can generate more than one [Shape2D], the amount returned does not have to match the sum of [CollisionShape2D] and [CollisionPolygon2D].
+
+
@@ -7988,6 +8013,13 @@
Return the shape transform in the given index.
+
+
+
+
+ Return whether this object is pickable.
+
+
@@ -8004,18 +8036,6 @@
Remove the shape in the given index.
-
-
- Remove all shapes.
-
-
-
-
-
-
- Return the RID of this object.
-
-
@@ -8023,20 +8043,35 @@
Set whether this object is pickable. A pickable object can detect the mouse pointer enter/leave it and, if the mouse is inside it, report input events.
-
-
-
+
+
+
+
+
- Return whether this object is pickable.
+ Change a shape in the collision body.
+
+
+
+
+
+
+
+
+ Set whether a shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked).
+
+
+
+
+
+
+
+
+ Change the shape transform in the collision body.
-
-
- This event fires only once when the mouse pointer enters any shape of this object.
-
-
@@ -8048,6 +8083,11 @@
This signal triggers when an input event fires over a shape. The first parameter is the viewport where the event took place. The second holds the input event received, and the third the shape of this object where it happened.
+
+
+ This event fires only once when the mouse pointer enters any shape of this object.
+
+
This event fires only once when the mouse pointer exits all shapes of this object.
@@ -8063,42 +8103,12 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -8111,6 +8121,36 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -8123,28 +8163,6 @@
Editor-only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [CollisionObject2D]. This is not accessible from regular code. This class is for editing custom shape polygons.
-
-
-
-
- Set the array of points forming the polygon.
- When editing the point list via the editor, depending on [method get_build_mode], it has to be a list of points (for [code]build_mode==0[/code]), or a list of lines (for [code]build_mode==1[/code]). In the second case, the even elements of the array define the start point of the line, and the odd elements the end point.
-
-
-
-
-
-
- Return the list of points that define the polygon.
-
-
-
-
-
-
- Set whether the polygon is to be a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]).
-
-
@@ -8152,20 +8170,6 @@
Return whether the polygon is a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]).
-
-
-
-
- Set whether this polygon is a trigger. A trigger polygon detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked).
-
-
-
-
-
-
- Return whether this polygon is a trigger.
-
-
@@ -8182,6 +8186,42 @@
Return the index of the last shape generated by the editor.
+
+
+
+
+ Return the list of points that define the polygon.
+
+
+
+
+
+
+ Return whether this polygon is a trigger.
+
+
+
+
+
+
+ Set whether the polygon is to be a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]).
+
+
+
+
+
+
+ Set the array of points forming the polygon.
+ When editing the point list via the editor, depending on [method get_build_mode], it has to be a list of points (for [code]build_mode==0[/code]), or a list of lines (for [code]build_mode==1[/code]). In the second case, the even elements of the array define the start point of the line, and the odd elements the end point.
+
+
+
+
+
+
+ Set whether this polygon is a trigger. A trigger polygon detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked).
+
+
@@ -8192,15 +8232,9 @@
-
-
-
-
-
-
-
-
-
+
+
+
@@ -8210,12 +8244,6 @@
-
-
-
-
-
-
@@ -8226,9 +8254,21 @@
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -8244,11 +8284,11 @@
Editor-only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [CollisionObject2D]. This is not accessible from regular code.
-
-
-
+
+
+
- Set this shape's [Shape2D]. This will not appear as a node, but can be directly edited as a property.
+ Return the index of this shape inside its container [CollisionObject2D]. This can be used to directly access the underlying [Shape2D].
@@ -8258,13 +8298,6 @@
Return this shape's [Shape2D].
-
-
-
-
- Set whether this shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. will not block movement of colliding objects).
-
-
@@ -8272,11 +8305,18 @@
Return whether this shape is a trigger.
-
-
-
+
+
+
- Return the index of this shape inside its container [CollisionObject2D]. This can be used to directly access the underlying [Shape2D].
+ Set this shape's [Shape2D]. This will not appear as a node, but can be directly edited as a property.
+
+
+
+
+
+
+ Set whether this shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. will not block movement of colliding objects).
@@ -8291,6 +8331,52 @@
A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some methods (such as set_modulate() ) may accept values > 1.
+
+
+
+
+
+
+
+
+
+
+
+
+ Construct the color from an RGBA profile.
+
+
+
+
+
+
+
+
+
+
+
+
+ Construct the color from an RGBA profile.
+
+
+
+
+
+
+
+
+ Construct the color from an RGBA profile.
+
+
+
+
+
+
+
+
+ Construct the color from an RGBA profile.
+
+
@@ -8355,87 +8441,41 @@
Return the HTML hexadecimal color string.
-
-
-
-
-
-
-
-
-
-
-
-
- Construct the color from an RGBA profile.
-
-
-
-
-
-
-
-
-
-
-
-
- Construct the color from an RGBA profile.
-
-
-
-
-
-
-
-
- Construct the color from an RGBA profile.
-
-
-
-
-
-
-
-
- Construct the color from an RGBA profile.
-
-
-
- Red (0 to 1)
+
+ Alpha (0 to 1)
-
- Green (0 to 1)
+
+ Alpha (0 to 255)
Blue (0 to 1)
-
- Alpha (0 to 1)
+
+ Blue (0 to 255)
+
+
+ Green (0 to 1)
+
+
+ Green (0 to 255)
Hue (0 to 1)
+
+ Red (0 to 1)
+
+
+ Red (0 to 255)
+
Saturation (0 to 1)
Value (0 to 1)
-
- Red (0 to 255)
-
-
- Green (0 to 255)
-
-
- Blue (0 to 255)
-
-
- Alpha (0 to 255)
-
@@ -8448,6 +8488,15 @@
Array of Color, can only contains colors. Optimized for memory usage, can't fragment the memory.
+
+
+
+
+
+
+ Create from a generic array.
+
+
@@ -8478,15 +8527,6 @@
Return the array size.
-
-
-
-
-
-
- Create from a generic array.
-
-
@@ -8499,11 +8539,11 @@
This is a simple color picker [Control]. It's useful for selecting a color from an RGB/RGBA colorspace.
-
-
+
+
- Select the current color.
+ Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker.
@@ -8513,11 +8553,11 @@
Return the current (edited) color.
-
-
-
+
+
+
- When set to true, every color channel will be represented as a value from 0 to 1, insetead of 0, 255.
+ Returns whether the color has transparency or not.
@@ -8527,6 +8567,13 @@
Returns whether this color picker is in raw mode or not
+
+
+
+
+ Select the current color.
+
+
@@ -8534,18 +8581,11 @@
Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color.
-
-
-
-
- Returns whether the color has transparency or not.
-
-
-
-
+
+
- Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker.
+ When set to true, every color channel will be represented as a value from 0 to 1, insetead of 0, 255.
@@ -8561,20 +8601,20 @@
-
-
-
+
-
-
-
+
+
+
+
+
@@ -8585,13 +8625,6 @@
Encapsulates a [ColorPicker] making it accesible by pressing a button, pressing the button will toggle the [ColorPicker] visibility
-
-
-
-
- Sets the current color
-
-
@@ -8599,11 +8632,10 @@
Gets the current color
-
-
-
+
+
+
- See [method ColorPicker.set_edit_alpha]
@@ -8613,6 +8645,20 @@
See [method ColorPicker.is_edit_alpha]
+
+
+
+
+ Sets the current color
+
+
+
+
+
+
+ See [method ColorPicker.set_edit_alpha]
+
+
@@ -8626,28 +8672,28 @@
-
+
-
+
+
+
+
+
-
-
-
-
-
-
-
+
+
+
@@ -8667,20 +8713,20 @@
Adds the specified color to the end of the ramp, with the specified offset
-
-
-
-
- Removes the color at the index [i]offset[/i]
-
-
-
+
+
+
-
-
- Sets the offset for the ramp color at index [i]point[/i]
+ Returns the color of the ramp color at index [i]point[/i]
+
+
+
+
+
+
+ Returns the colors in the ramp
@@ -8692,22 +8738,18 @@
Returns the offset of the ramp color at index [i]point[/i]
-
-
-
-
-
+
+
+
- Sets the color of the ramp color at index [i]point[/i]
+ Returns the offsets for the colors in this ramp
-
-
+
+
-
-
- Returns the color of the ramp color at index [i]point[/i]
+ Returns the number of colors in the ramp
@@ -8719,25 +8761,20 @@
Returns the interpolated color specified by [i]offset[/i]
-
-
-
-
- Returns the number of colors in the ramp
-
-
-
-
+
+
- Sets the offset for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accomodate the new elements, all new colors will be black by default.
+ Removes the color at the index [i]offset[/i]
-
-
-
+
+
+
+
+
- Returns the offsets for the colors in this ramp
+ Sets the color of the ramp color at index [i]point[/i]
@@ -8747,11 +8784,20 @@
Sets the colors for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accomodate the new elements.
-
-
-
+
+
+
+
+
- Returns the colors in the ramp
+ Sets the offset for the ramp color at index [i]point[/i]
+
+
+
+
+
+
+ Sets the offset for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accomodate the new elements, all new colors will be black by default.
@@ -8766,13 +8812,6 @@
Concave polygon shape resource, which can be set into a [PhysicsBody] or area. This shape is created by feeding a list of triangles.
-
-
-
-
- Set the faces (an array of triangles).
-
-
@@ -8780,6 +8819,13 @@
Return the faces (an array of triangles).
+
+
+
+
+ Set the faces (an array of triangles).
+
+
@@ -8793,13 +8839,6 @@
The main difference between a [ConvexPolygonShape2D] and a [ConcavePolygonShape2D] is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection.
-
-
-
-
- Set the array of segments.
-
-
@@ -8807,6 +8846,13 @@
Return the array of segments.
+
+
+
+
+ Set the array of segments.
+
+
@@ -8817,14 +8863,6 @@
-
-
-
-
-
-
-
-
@@ -8833,6 +8871,14 @@
+
+
+
+
+
+
+
+
@@ -8870,15 +8916,20 @@
[/codeblock]
-
+
+
+
-
-
-
-
- Assign a value to the specified key of the the specified section. If the section and/or the key do not exist, they are created. Passing a [code]NULL[/code] value deletes the specified key if it exists (and deletes the section if it ends up empty once the key has been removed).
+ Return an array of all defined key identifiers in the specified section.
+
+
+
+
+
+
+ Return an array of all defined section identifiers.
@@ -8914,22 +8965,6 @@
Check if the specified section-key pair exists.
-
-
-
-
- Return an array of all defined section identifiers.
-
-
-
-
-
-
-
-
- Return an array of all defined key identifiers in the specified section.
-
-
@@ -8949,6 +8984,17 @@
The return value is one of the OK, FAILED or ERR_* constants listed in [@Global Scope] (if the save was successful, it returns OK).
+
+
+
+
+
+
+
+
+ Assign a value to the specified key of the the specified section. If the section and/or the key do not exist, they are created. Passing a [code]NULL[/code] value deletes the specified key if it exists (and deletes the section if it ends up empty once the key has been removed).
+
+
@@ -8981,11 +9027,6 @@
A Control can inherit this to create custom container classes.
-
-
- Queue resort of the contained children. This is called automatically anyway, but can be called upon request.
-
-
@@ -8995,6 +9036,11 @@
Fit a child control in a given rect. This is mainly a helper for creating custom container classes.
+
+
+ Queue resort of the contained children. This is called automatically anyway, but can be called upon request.
+
+
@@ -9030,351 +9076,35 @@
Called when an input event reaches the control.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size.
-
-
Handles the event, no other control will receive it and it will not be sent to nodes waiting on [method Node._unhandled_input] or [method Node._unhandled_key_input].
-
-
-
-
- Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size.
-
-
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
- Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Changing the anchor mode converts the current margin offset from the previous anchor mode to the new one, so margin offsets ([method set_margin]) must be done after setting anchors, or at the same time ([method set_anchor_and_margin])
-
- Additionally, [code]keep_margin[/code] controls whether margins should be left the same, or changed to keep the same position and size on-screen.
-
-
-
-
-
-
-
-
- Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM).
-
-
-
-
-
-
-
-
- Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being set depends on the anchor mode.
-
-
-
-
-
-
-
-
-
-
- Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM), and also set its offset. This is a helper (see [method set_anchor] and [method set_margin]).
-
-
-
-
-
-
- Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]).
-
-
-
-
-
-
- Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see [method set_margin]).
-
-
-
-
-
-
- Move the Control to a new position, relative to the top-left corner of the parent Control, changing all margins if needed and without changing current anchor mode. This is a helper (see [method set_margin]).
-
-
-
-
-
-
- Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see [method set_margin]).
-
-
-
-
+
-
-
+
+
+
+
- Move the Control to a new position, relative to the top-left corner of the [i]window[/i] Control, and without changing current anchor mode. (see [method set_margin]).
+ Override a single constant (integer) in the theme of this Control. If constant equals Theme.INVALID_CONSTANT, override is cleared.
-
-
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Return a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being returned depends on the anchor mode.
-
-
-
-
-
-
-
-
-
-
-
-
- Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]).
-
-
-
-
-
-
- Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode.
-
-
-
-
-
-
- Returns the size of the Control, computed from all margins, however the size returned will [b]never be smaller than the minimum size reported by [method get_minimum_size][/b]. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, [method get_minimum_size], [method set_margin], [method set_anchor]).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode.
-
-
-
-
-
-
- Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see [method get_pos], [method get_size]).
-
-
-
-
-
-
- Return position and size of the Control, relative to the top-left corner of the [i]window[/i] Control. This is a helper (see [method get_global_pos], [method get_size]).
-
-
-
-
-
-
- Change all margins and anchors, so this Control always takes up the same area as the parent Control. This is a helper (see [method set_anchor], [method set_margin]).
-
-
-
-
-
-
- Display 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.
-
-
-
-
-
-
- Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL). Only one Control can be focused at the same time, and it will receive keyboard signals.
-
-
-
-
-
-
- Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see [method set_focus_mode]).
-
-
-
-
-
-
- Return whether the Control is the current focused control (see [method set_focus_mode]).
-
-
-
-
- Steal the focus from another control and become the focused control (see [method set_focus_mode]).
-
-
-
-
- Give up the focus, no other control will be able to receive keyboard input.
-
-
-
-
-
-
- Return which control is owning the keyboard focus, or null if no one.
-
-
-
-
-
-
- Hint for containers, set horizontal positioning flags.
-
-
-
-
-
-
- Hint for containers, return horizontal positioning flags.
-
-
-
-
-
-
- Hint for containers, set the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big.
-
-
-
-
-
-
- Hint for containers, return the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big.
-
-
-
-
-
-
- Hint for containers, set vertical positioning flags.
-
-
-
-
-
-
- Hint for containers, return vertical positioning flags.
-
-
-
-
-
-
- Override whole the [Theme] for this Control and all its children controls.
-
-
-
-
-
-
- Return a [Theme] override, if one exists (see [method set_theme]).
+ Override a single font (font) in the theme of this Control. If font is empty, override is cleared.
@@ -9403,60 +9133,45 @@
Override a single stylebox ([Stylebox]) in the theme of this Control. If stylebox is empty, override is cleared.
-
-
-
-
-
-
- Override a single font (font) in the theme of this Control. If font is empty, override is cleared.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Override a single constant (integer) in the theme of this Control. If constant equals Theme.INVALID_CONSTANT, override is cleared.
-
-
-
-
+
+
-
+
-
+
-
-
-
-
+
+
-
+
-
-
+
+
+
+
+
+
+
+
+
+
-
-
-
+
+ Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM).
+
+
+
+
+
+
@@ -9469,6 +9184,12 @@
+
+
+
+
+
+
@@ -9479,27 +9200,237 @@
-
-
+
+
-
+
+
+
+ Return the cursor shape at a certain position in the control.
+
+
+
+
+
+
+
+
+
+
+
+
+ Return the default cursor shape for this control. See enum CURSOR_* for the list of shapes.
+
+
+
+
+
+
-
-
+
+
+
+
+ Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]).
+
+
+
+
+
+
+ Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see [method set_focus_mode]).
+
+
+
+
+
+
+
+
+ Return the forced neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function.
+
+
+
+
+
+
+ Return which control is owning the keyboard focus, or null if no one.
+
+
+
+
+
+
-
+
+
+
+
+ Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode.
+
+
+
+
+
+
+ Return position and size of the Control, relative to the top-left corner of the [i]window[/i] Control. This is a helper (see [method get_global_pos], [method get_size]).
+
+
+
+
+
+
+ Hint for containers, return horizontal positioning flags.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being returned depends on the anchor mode.
+
+
+
+
+
+
+ Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size.
+
+
+
+
+
+
+ Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode.
+
+
+
+
+
+
+ Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see [method get_pos], [method get_size]).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the size of the Control, computed from all margins, however the size returned will [b]never be smaller than the minimum size reported by [method get_minimum_size][/b]. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, [method get_minimum_size], [method set_margin], [method set_anchor]).
+
+
+
+
+
+
+ Hint for containers, return the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return a [Theme] override, if one exists (see [method set_theme]).
+
+
+
+
+
+
+
+
+ Return the tooltip, which will appear when the cursor is resting over this control.
+
+
+
+
+
+
+ Hint for containers, return vertical positioning flags.
+
+
+
+
+
+
+
+
+ Steal the focus from another control and become the focused control (see [method set_focus_mode]).
+
+
+
+
+
@@ -9511,6 +9442,16 @@
+
+
+
+
+
+
+
+
+
+
@@ -9519,6 +9460,31 @@
+
+
+
+
+ Return whether the Control is the current focused control (see [method set_focus_mode]).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -9529,6 +9495,14 @@
+
+
+
+
+
+
+
+
@@ -9539,106 +9513,14 @@
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Set a tooltip, which will appear when the cursor is resting over this control.
-
-
-
-
-
-
-
-
- Return the tooltip, which will appear when the cursor is resting over this control.
-
-
-
-
-
-
- Set the default cursor shape for this control. See enum CURSOR_* for the list of shapes.
-
-
-
-
-
-
- Return the default cursor shape for this control. See enum CURSOR_* for the list of shapes.
-
-
-
-
-
-
-
-
- Return the cursor shape at a certain position in the control.
-
-
-
-
-
-
-
-
- Force a neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function.
-
-
-
-
-
-
-
-
- Return the forced neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function.
-
-
-
-
-
-
- Ignore mouse events on this control (even touchpad events send mouse events).
-
-
@@ -9646,30 +9528,72 @@
Return if the control is ignoring mouse events (even touchpad events send mouse events).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+ Give up the focus, no other control will be able to receive keyboard input.
+
+
+
+
+
+
+
+
+
+
+ Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Changing the anchor mode converts the current margin offset from the previous anchor mode to the new one, so margin offsets ([method set_margin]) must be done after setting anchors, or at the same time ([method set_anchor_and_margin])
+
+ Additionally, [code]keep_margin[/code] controls whether margins should be left the same, or changed to keep the same position and size on-screen.
+
+
+
+
+
+
+
+
+
+
+ Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM), and also set its offset. This is a helper (see [method set_anchor] and [method set_margin]).
+
+
+
+
+
+
+ Change all margins and anchors, so this Control always takes up the same area as the parent Control. This is a helper (see [method set_anchor], [method set_margin]).
+
+
+
+
+
+
+ Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]).
+
+
+
+
+
+
+
+
+
+
+
+
+ Set the default cursor shape for this control. See enum CURSOR_* for the list of shapes.
+
+
@@ -9682,13 +9606,135 @@
-
-
+
+
+
+
+ Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see [method set_margin]).
+
+
+
+
+
+
+ Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL). Only one Control can be focused at the same time, and it will receive keyboard signals.
+
+
+
+
+
+
+
+
+ Force a neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function.
+
+
+
+
+
+
+ Move the Control to a new position, relative to the top-left corner of the [i]window[/i] Control, and without changing current anchor mode. (see [method set_margin]).
+
+
+
+
+
+
+ Hint for containers, set horizontal positioning flags.
+
+
+
+
+
+
+ Ignore mouse events on this control (even touchpad events send mouse events).
+
+
+
+
+
+
+
+
+ Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being set depends on the anchor mode.
+
+
+
+
+
+
+ Move the Control to a new position, relative to the top-left corner of the parent Control, changing all margins if needed and without changing current anchor mode. This is a helper (see [method set_margin]).
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see [method set_margin]).
+
+
+
+
+
+
+
+
+
+
+
+
+ Hint for containers, set the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big.
+
+
+
+
+
+
+ Override whole the [Theme] for this Control and all its children controls.
+
+
+
+
+
+
+ Set a tooltip, which will appear when the cursor is resting over this control.
+
+
+
+
+
+
+ Hint for containers, set vertical positioning flags.
+
+
+
+
+
+
+ Display 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.
+
+
+
+
+
@@ -9699,26 +9745,6 @@
Emitted when keyboard focus is gained.
-
-
- Emitted when the mouse enters the control area.
-
-
-
-
- Emitted when the control changed size.
-
-
-
-
- Emitted when the minimum size of the control changed.
-
-
-
-
- Emitted when the size flags changed.
-
-
Emitted when the keyboard focus is lost.
@@ -9731,15 +9757,35 @@
Emitted when an input event is received. Connecting in realtime is recommended for accepting the events.
+
+
+ Emitted when the minimum size of the control changed.
+
+
+
+
+ Emitted when the mouse enters the control area.
+
+
Emitted when the mouse left the control area.
+
+
+ Emitted when the control changed size.
+
+
+
+
+ Emitted when the size flags changed.
+
+
@@ -9753,6 +9799,40 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Control can't acquire focus.
@@ -9783,40 +9863,6 @@
Modal control was closed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -9833,18 +9879,18 @@
Convex polygon shape resource, which can be set into a [PhysicsBody] or area.
-
-
-
-
-
-
+
+
+
+
+
+
@@ -9858,6 +9904,13 @@
The main difference between a [ConvexPolygonShape2D] and a [ConcavePolygonShape2D] is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection.
+
+
+
+
+ Return a list of points in either clockwise or counter clockwise order, forming a convex polygon.
+
+
@@ -9872,13 +9925,6 @@
Set a list of points in either clockwise or counter clockwise order, forming a convex polygon.
-
-
-
-
- Return a list of points in either clockwise or counter clockwise order, forming a convex polygon.
-
-
@@ -9889,7 +9935,7 @@
-
+
@@ -9901,32 +9947,18 @@
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -9935,37 +9967,53 @@
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-
+
-
+
-
+
+
+
@@ -9979,13 +10027,11 @@
-
+
-
+
-
-
-
+
@@ -9998,13 +10044,6 @@
It keeps a cache of precalculated points along the curve, to speed further calculations up.
-
-
-
-
- Returns the number of points describing the curve.
-
-
@@ -10019,95 +10058,6 @@ It keeps a cache of precalculated points along the curve, to speed further calcu
If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= [method get_point_count]), the point will be appended at the end of the point list.
-
-
-
-
-
-
- Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console.
-
-
-
-
-
-
-
-
- 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).
-
-
-
-
-
-
-
-
- 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.
-
-
-
-
-
-
-
-
- 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).
-
-
-
-
-
-
-
-
- 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.
-
-
-
-
-
-
-
-
- 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).
-
-
-
-
-
-
- Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds.
-
-
-
-
-
-
-
-
-
-
- Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results.
-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).
-
-
-
-
-
-
-
-
- Returns the position at the vertex "fofs". It calls [method interpolate] using the integer part of fofs as "idx", and its fractional part as "t".
-
-
-
-
-
-
- Sets the distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care.
-
-
@@ -10122,6 +10072,59 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i
Returns the total length of the curve, based on the cached points. Given enough density (see [method set_bake_interval]), it should be approximate enough.
+
+
+
+
+ Returns the cache of points as a [Vector2Array].
+
+
+
+
+
+
+ Returns the number of points describing the curve.
+
+
+
+
+
+
+
+
+ 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 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 vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0).
+
+
+
+
+
+
+
+
+
+
+ Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results.
+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).
+
+
@@ -10135,11 +10138,54 @@ To do that, it finds the two cached points where the "offset" lies between, then
Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough).
-
-
+
+
+
+
- Returns the cache of points as a [Vector2Array].
+ Returns the position at the vertex "fofs". It calls [method interpolate] using the integer part of fofs as "idx", and its fractional part as "t".
+
+
+
+
+
+
+ Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds.
+
+
+
+
+
+
+ Sets the distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care.
+
+
+
+
+
+
+
+
+ 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 out of 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.
@@ -10169,13 +10215,6 @@ This approximation makes straight segments between each point, then subdivides t
It keeps a cache of precalculated points along the curve, to speed further calculations up.
-
-
-
-
- Returns the number of points describing the curve.
-
-
@@ -10190,114 +10229,6 @@ It keeps a cache of precalculated points along the curve, to speed further calcu
If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= [method get_point_count]), the point will be appended at the end of the point list.
-
-
-
-
-
-
- Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console.
-
-
-
-
-
-
-
-
- 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).
-
-
-
-
-
-
-
-
- Sets the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console.
-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 [PathFollow], this tilt is an offset over the natural tilt the PathFollow calculates.
-
-
-
-
-
-
-
-
- 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.
-
-
-
-
-
-
-
-
- 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.
-
-
-
-
-
-
-
-
- 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).
-
-
-
-
-
-
-
-
- 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.
-
-
-
-
-
-
-
-
- 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).
-
-
-
-
-
-
- Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds.
-
-
-
-
-
-
-
-
-
-
- Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results.
-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).
-
-
-
-
-
-
-
-
- Returns the position at the vertex "fofs". It calls [method interpolate] using the integer part of fofs as "idx", and its fractional part as "t".
-
-
-
-
-
-
- Sets the distance in 3D units between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care.
-
-
@@ -10312,6 +10243,75 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i
Returns the total length of the curve, based on the cached points. Given enough density (see [method set_bake_interval]), it should be approximate enough.
+
+
+
+
+ Returns the cache of points as a [Vector3Array].
+
+
+
+
+
+
+ Returns the cache of tilts as a [RealArray].
+
+
+
+
+
+
+ Returns the number of points describing the curve.
+
+
+
+
+
+
+
+
+ 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 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 vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 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.
+
+
+
+
+
+
+
+
+
+
+ Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results.
+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).
+
+
@@ -10325,18 +10325,64 @@ To do that, it finds the two cached points where the "offset" lies between, then
Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough).
-
-
+
+
+
+
- Returns the cache of points as a [Vector3Array].
+ Returns the position at the vertex "fofs". It calls [method interpolate] using the integer part of fofs as "idx", and its fractional part as "t".
-
-
-
+
+
+
- Returns the cache of tilts as a [RealArray].
+ Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds.
+
+
+
+
+
+
+ Sets the distance in 3D units between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care.
+
+
+
+
+
+
+
+
+ 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 out of 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.
+
+
+
+
+
+
+
+
+ Sets the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console.
+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 [PathFollow], this tilt is an offset over the natural tilt the PathFollow calculates.
@@ -10365,11 +10411,11 @@ This approximation makes straight segments between each point, then subdivides t
Damped spring constraint for 2D physics. This resembles a spring joint that always wants to go back to a given length.
-
-
-
+
+
+
- Set the maximum length of the spring joint.
+ Return the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
@@ -10379,13 +10425,6 @@ This approximation makes straight segments between each point, then subdivides t
Return the maximum length of the spring joint.
-
-
-
-
- Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
-
-
@@ -10393,13 +10432,6 @@ This approximation makes straight segments between each point, then subdivides t
Return the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
-
-
-
-
- Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
-
-
@@ -10414,11 +10446,25 @@ This approximation makes straight segments between each point, then subdivides t
Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
-
-
-
+
+
+
- Return the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
+ Set the maximum length of the spring joint.
+
+
+
+
+
+
+ Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
+
+
+
+
+
+
+ Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
@@ -10526,26 +10572,12 @@ This approximation makes straight segments between each point, then subdivides t
A DirectionalLight is a type of [Light] node that emits light constantly in one direction (the negative z axis of the node). It is used lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored, only the basis is used do determine light direction.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -10554,22 +10586,36 @@ This approximation makes straight segments between each point, then subdivides t
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
+
+
+
+
+
+
@@ -10596,29 +10642,26 @@ This approximation makes straight segments between each point, then subdivides t
[/codeblock]
-
+
-
+
- Open an existing directory of the filesystem. The [i]path[/i] argument can be within the project tree ([code]res://folder[/code]), the user directory ([code]user://folder[/code]) or an absolute path of the user filesystem (e.g. [code]/tmp/folder[/code] or [code]C:\tmp\folder[/code]).
+ Change the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. [code]newdir[/code] or [code]../newdir[/code]), or an absolute path (e.g. [code]/tmp/newdir[/code] or [code]res://somedir/newdir[/code]).
The method returns one of the error code constants defined in [@Global Scope] (OK or ERR_*).
-
-
+
+
+
+
+
+
- Initialise the stream used to list all files and directories using the [method get_next] function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with [method list_dir_end].
- Return false if the stream could not be initialised.
-
-
-
-
-
-
- Return the next element (file or directory) in the current directory (including [code].[/code] and [code]..[/code]). The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. [method list_dir_end] would not be mandatory in such a case).
+ Copy the [i]from[/i] file to the [i]to[/i] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten.
+ Returns one of the error code constants defined in [@Global Scope] (OK, FAILED or ERR_*).
@@ -10628,16 +10671,29 @@ This approximation makes straight segments between each point, then subdivides t
Return whether the current item processed with the last [method get_next] call is a directory ([code].[/code] and [code]..[/code] are considered directories).
-
+
+
+
+
+
- Close the current stream opened with [method list_dir_begin] (whether it has been fully processed with [method get_next] or not does not matter).
+ Return whether the target directory exists. The argument can be relative to the current directory, or an absolute path.
-
-
+
+
+
+
+
+
+ Return whether the target file exists. The argument can be relative to the current directory, or an absolute path.
+
+
+
+
- On Windows, return the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0.
+ Return the absolute path to the currently opened directory (e.g. [code]res://folder[/code] or [code]C:\tmp\folder[/code]).
@@ -10649,21 +10705,38 @@ This approximation makes straight segments between each point, then subdivides t
On Windows, return the name of the drive (partition) passed as an argument (e.g. [code]C:[/code]). On other platforms, or if the requested drive does not existed, the method returns an empty String.
-
-
+
+
-
-
- Change the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. [code]newdir[/code] or [code]../newdir[/code]), or an absolute path (e.g. [code]/tmp/newdir[/code] or [code]res://somedir/newdir[/code]).
- The method returns one of the error code constants defined in [@Global Scope] (OK or ERR_*).
+ On Windows, return the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0.
-
+
- Return the absolute path to the currently opened directory (e.g. [code]res://folder[/code] or [code]C:\tmp\folder[/code]).
+ Return the next element (file or directory) in the current directory (including [code].[/code] and [code]..[/code]). The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. [method list_dir_end] would not be mandatory in such a case).
+
+
+
+
+
+
+ On Unix desktop systems, return the available space on the current directory's disk. On other platforms, this information is not available and the method returns 0 or -1.
+
+
+
+
+
+
+ Initialise the stream used to list all files and directories using the [method get_next] function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with [method list_dir_end].
+ Return false if the stream could not be initialised.
+
+
+
+
+ Close the current stream opened with [method list_dir_begin] (whether it has been fully processed with [method get_next] or not does not matter).
@@ -10686,41 +10759,24 @@ This approximation makes straight segments between each point, then subdivides t
Returns one of the error code constants defined in [@Global Scope] (OK, FAILED or ERR_*).
-
-
-
-
-
-
- Return whether the target file exists. The argument can be relative to the current directory, or an absolute path.
-
-
-
-
-
-
-
-
- Return whether the target directory exists. The argument can be relative to the current directory, or an absolute path.
-
-
-
-
-
-
- On Unix desktop systems, return the available space on the current directory's disk. On other platforms, this information is not available and the method returns 0 or -1.
-
-
-
+
-
-
-
+
- Copy the [i]from[/i] file to the [i]to[/i] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten.
- Returns one of the error code constants defined in [@Global Scope] (OK, FAILED or ERR_*).
+ Open an existing directory of the filesystem. The [i]path[/i] argument can be within the project tree ([code]res://folder[/code]), the user directory ([code]user://folder[/code]) or an absolute path of the user filesystem (e.g. [code]/tmp/folder[/code] or [code]C:\tmp\folder[/code]).
+ The method returns one of the error code constants defined in [@Global Scope] (OK or ERR_*).
+
+
+
+
+
+
+
+
+ Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail.
+ Returns one of the error code constants defined in [@Global Scope] (OK or FAILED).
@@ -10735,16 +10791,6 @@ This approximation makes straight segments between each point, then subdivides t
Returns one of the error code constants defined in [@Global Scope] (OK or FAILED).
-
-
-
-
-
-
- Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail.
- Returns one of the error code constants defined in [@Global Scope] (OK or FAILED).
-
-
@@ -10755,44 +10801,12 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -10801,15 +10815,47 @@ This approximation makes straight segments between each point, then subdivides t
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -10823,6 +10869,18 @@ This approximation makes straight segments between each point, then subdivides t
+
+
+
+
+
+
+
+
+
+
+
+
@@ -10874,13 +10932,19 @@ This approximation makes straight segments between each point, then subdivides t
+
+
+
+
+
+
-
-
-
+
+
+
@@ -10902,6 +10966,46 @@ This approximation makes straight segments between each point, then subdivides t
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -10920,72 +11024,32 @@ This approximation makes straight segments between each point, then subdivides t
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
-
+
+
+
-
-
-
-
-
-
@@ -10998,8 +11062,20 @@ This approximation makes straight segments between each point, then subdivides t
+
+
+
+
+
+
+
+
+
+
+
+
@@ -11010,12 +11086,6 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
-
-
-
@@ -11054,6 +11124,14 @@ This approximation makes straight segments between each point, then subdivides t
instead.
+
+
+
+
+
+
+
+
@@ -11149,14 +11227,6 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
-
-
-
-
-
@@ -11171,6 +11241,105 @@ This approximation makes straight segments between each point, then subdivides t
resource type, import plugins and export plugins.
+
+
+
+
+
+
+ Add a control to the bottom panel (together with
+ Output, Debug, Animation, etc).
+
+ If your plugin is being removed, also make sure to
+ remove your control by calling [method
+ remove_control_from_bottom_panel].
+
+
+
+
+
+
+
+
+ Add a custom control to a container (see
+ CONTAINER_* enum). There are many locations where
+ custom controls can be added in the editor UI.
+
+ Please remember that you have to manage the
+ visibility of your custom controls yourself (and likely
+ hide it after adding it).
+
+ If your plugin is being removed, also make sure to
+ remove your custom controls too.
+
+
+
+
+
+
+
+
+ Add the control to a specific dock slot (see DOCK_*
+ enum for options).
+
+ If the dock is repositioned and as long as the
+ plugin is active, the editor will save the dock
+ position on further sessions.
+
+ If your plugin is being removed, also make sure to
+ remove your control by calling [method
+ remove_control_from_docks].
+
+
+
+
+
+
+
+
+
+
+
+
+ Add a custom type, which will appear in the list of
+ nodes or resources. An icon can be optionally
+ passed.
+
+ When given node or resource is selected, the base
+ type will be instanced (ie, "Spatial", "Control",
+ "Resource"), then the script will be loaded and set
+ to this object.
+
+ You can use the [EditorPlugin.handles] to check if
+ your custom object is being edited by checking the
+ script or using 'extends' keyword.
+
+ During run-time, this will be a simple object with a
+ script so this function does not need to be called
+ then.
+
+
+
+
+
+
+ Add an export plugin. Plugins of this kind can
+ change files being exported. On exit don't forget to
+ call [method remove_export_plugin].
+
+
+
+
+
+
+ Add an import plugin. These plugins manage importing
+ external content (from outside the project) into
+ formats the engine can understand.
+
+ On exit, don't forget to remove the plugin by
+ calling [method remove_import_plugin]
+
+
This method is called when the editor is about to
@@ -11247,6 +11416,16 @@ This approximation makes straight segments between each point, then subdivides t
otherwise false.
+
+
+
+
+ Get a base control where it's safe to place dialogs.
+ Many plugins open dialogs and they need a control as
+ a base to make sure they use the editor icons and
+ theme.
+
+
@@ -11256,6 +11435,14 @@ This approximation makes straight segments between each point, then subdivides t
(script:line), for example: res://path_to_script.gd:25
+
+
+
+
+ Get the general settings for the editor (the same
+ window that appears in the Settings menu).
+
+
@@ -11265,6 +11452,14 @@ This approximation makes straight segments between each point, then subdivides t
(which by default is 2D, 3D, Script).
+
+
+
+
+ Get the object that handles the selection of nodes
+ in the Scene Tree editor.
+
+
@@ -11275,6 +11470,15 @@ This approximation makes straight segments between each point, then subdivides t
restored when the tab returns).
+
+
+
+
+ Get the undo/redo object. Most actions in the editor
+ can be undoable, so use this object to make sure
+ this happens when it's worth it.
+
+
@@ -11309,61 +11513,13 @@ This approximation makes straight segments between each point, then subdivides t
all your editor controls manually.
-
-
-
-
- Restore the state saved by [EditorPlugin.get_state].
-
-
-
-
-
-
-
-
- Add a custom control to a container (see
- CONTAINER_* enum). There are many locations where
- custom controls can be added in the editor UI.
-
- Please remember that you have to manage the
- visibility of your custom controls yourself (and likely
- hide it after adding it).
-
- If your plugin is being removed, also make sure to
- remove your custom controls too.
-
-
-
+
-
-
- Add a control to the bottom panel (together with
- Output, Debug, Animation, etc).
-
- If your plugin is being removed, also make sure to
- remove your control by calling [method
- remove_control_from_bottom_panel].
-
-
-
-
-
-
-
-
- Add the control to a specific dock slot (see DOCK_*
- enum for options).
-
- If the dock is repositioned and as long as the
- plugin is active, the editor will save the dock
- position on further sessions.
-
- If your plugin is being removed, also make sure to
- remove your control by calling [method
- remove_control_from_docks].
+ Remove the control from the bottom panel. Don't forget
+ to call this if you added one, so the editor can
+ remove it cleanly.
@@ -11375,43 +11531,6 @@ This approximation makes straight segments between each point, then subdivides t
the layout and remove it cleanly.
-
-
-
-
- Remove the control from the bottom panel. Don't forget
- to call this if you added one, so the editor can
- remove it cleanly.
-
-
-
-
-
-
-
-
-
-
-
-
- Add a custom type, which will appear in the list of
- nodes or resources. An icon can be optionally
- passed.
-
- When given node or resource is selected, the base
- type will be instanced (ie, "Spatial", "Control",
- "Resource"), then the script will be loaded and set
- to this object.
-
- You can use the [EditorPlugin.handles] to check if
- your custom object is being edited by checking the
- script or using 'extends' keyword.
-
- During run-time, this will be a simple object with a
- script so this function does not need to be called
- then.
-
-
@@ -11420,35 +11539,6 @@ This approximation makes straight segments between each point, then subdivides t
[EditorPlugin.add_custom_type]
-
-
-
-
- Add an import plugin. These plugins manage importing
- external content (from outside the project) into
- formats the engine can understand.
-
- On exit, don't forget to remove the plugin by
- calling [method remove_import_plugin]
-
-
-
-
-
-
- Remove the import plugin, don't forget to call this
- on exit.
-
-
-
-
-
-
- Add an export plugin. Plugins of this kind can
- change files being exported. On exit don't forget to
- call [method remove_export_plugin].
-
-
@@ -11457,39 +11547,19 @@ This approximation makes straight segments between each point, then subdivides t
on exit.
-
-
-
+
+
+
- Get a base control where it's safe to place dialogs.
- Many plugins open dialogs and they need a control as
- a base to make sure they use the editor icons and
- theme.
+ Remove the import plugin, don't forget to call this
+ on exit.
-
-
-
+
+
+
- Get the undo/redo object. Most actions in the editor
- can be undoable, so use this object to make sure
- this happens when it's worth it.
-
-
-
-
-
-
- Get the object that handles the selection of nodes
- in the Scene Tree editor.
-
-
-
-
-
-
- Get the general settings for the editor (the same
- window that appears in the Settings menu).
+ Restore the state saved by [EditorPlugin.get_state].
@@ -11589,11 +11659,6 @@ This approximation makes straight segments between each point, then subdivides t
This object manages the SceneTree selection in the editor.
-
-
- Clear the selection.
-
-
@@ -11601,11 +11666,9 @@ This approximation makes straight segments between each point, then subdivides t
Add a node to the selection.
-
-
-
+
- Remove a node from the selection.
+ Clear the selection.
@@ -11615,6 +11678,13 @@ This approximation makes straight segments between each point, then subdivides t
Get the list of selectes nodes.
+
+
+
+
+ Remove a node from the selection.
+
+
@@ -11651,6 +11721,31 @@ This approximation makes straight segments between each point, then subdivides t
Erase a given setting (pass full property path).
+
+
+
+
+ Get the list of favorite directories for this
+ project.
+
+
+
+
+
+
+ Get the specific project settings path. Projects all
+ have an unique sub-directory inside the settings
+ path where project specific settings are saved.
+
+
+
+
+
+
+ Get the list of recently visited folders in the file
+ dialog for this project.
+
+
@@ -11664,15 +11759,6 @@ This approximation makes straight segments between each point, then subdivides t
located
-
-
-
-
- Get the specific project settings path. Projects all
- have an unique sub-directory inside the settings
- path where project specific settings are saved.
-
-
@@ -11681,14 +11767,6 @@ This approximation makes straight segments between each point, then subdivides t
project.
-
-
-
-
- Get the list of favorite directories for this
- project.
-
-
@@ -11697,14 +11775,6 @@ This approximation makes straight segments between each point, then subdivides t
dialog for this project.
-
-
-
-
- Get the list of recently visited folders in the file
- dialog for this project.
-
-
@@ -11725,6 +11795,80 @@ This approximation makes straight segments between each point, then subdivides t
[method EditorPlugin.create_spatial_gizmo].
+
+
+
+
+
+
+
+
+
+
+ Add collision triangles to the gizmo for picking. A
+ [TriangleMesh] can be generated from a regular
+ [Mesh] too.
+
+ Call this function during [method redraw].
+
+
+
+
+
+
+
+
+
+
+ Add a list of handles (points) which can be used to
+ deform the object being edited.
+
+ There are virtual functions which will be called
+ upon editing of these handles.
+
+ Call this function during [method redraw].
+
+
+
+
+
+
+
+
+
+
+ Add lines to the gizmo (as sets of 2 points), with a
+ given material. The lines are used for visualizing
+ the gizmo.
+
+ Call this function during [method redraw].
+
+
+
+
+
+
+
+
+
+
+ Add a mesh to the gizmo, this is used for
+ visualization.
+
+ Call this function during [method redraw].
+
+
+
+
+
+
+
+
+ Add an unscaled billboard for visualization.
+
+ Call this function during [method redraw].
+
+
@@ -11787,80 +11931,6 @@ This approximation makes straight segments between each point, then subdivides t
so screen coordinates can be converted to raycasts.
-
-
-
-
-
-
-
-
- Add lines to the gizmo (as sets of 2 points), with a
- given material. The lines are used for visualizing
- the gizmo.
-
- Call this function during [method redraw].
-
-
-
-
-
-
-
-
-
-
- Add a mesh to the gizmo, this is used for
- visualization.
-
- Call this function during [method redraw].
-
-
-
-
-
-
-
-
-
-
-
-
- Add collision triangles to the gizmo for picking. A
- [TriangleMesh] can be generated from a regular
- [Mesh] too.
-
- Call this function during [method redraw].
-
-
-
-
-
-
-
-
- Add an unscaled billboard for visualization.
-
- Call this function during [method redraw].
-
-
-
-
-
-
-
-
-
-
- Add a list of handles (points) which can be used to
- deform the object being edited.
-
- There are virtual functions which will be called
- upon editing of these handles.
-
- Call this function during [method redraw].
-
-
@@ -11881,45 +11951,9 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -11931,94 +11965,94 @@ This approximation makes straight segments between each point, then subdivides t
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -12039,12 +12073,20 @@ This approximation makes straight segments between each point, then subdivides t
-
+
+
+
+
+
+
+
+
+
@@ -12055,6 +12097,34 @@ This approximation makes straight segments between each point, then subdivides t
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -12066,148 +12136,22 @@ This approximation makes straight segments between each point, then subdivides t
Currently, only MOD, S3M, IT, and XM music is supported.
-
-
-
-
- Set the [EventStream] this player will play.
-
-
-
-
-
-
- Return the currently assigned stream.
-
-
-
-
- Play the currently assigned stream.
-
-
-
-
- Stop playing.
-
-
-
-
-
-
- Return whether this player is playing.
-
-
-
-
-
-
- Pause stream playback.
-
-
-
-
-
-
- Return whether the playback is currently paused.
-
-
-
-
-
-
- Set whether the stream will be restarted at the end.
-
-
-
-
-
-
- Return whether this player will be restart the playback at the end.
-
-
-
-
-
-
- Set the playback volume for this player. This is a float between 0.0 (silent) and 1.0 (full volume). Values over 1.0 may amplify sound even more, but may introduce distortion. Negative values may just invert the output waveform, which produces no audible difference.
- The effect of these special values ultimately depends on the low-level implementation of the file format being played.
-
-
-
+
-
- Return the playback volume for this player.
-
-
-
-
+
- Set the pitch multiplier for all sounds coming from this stream. A value of 2.0 shifts all pitches one octave up, and a value of 0.5 shifts pitches one octave down.
+ Return the time at which the last note of a given channel in the stream plays.
-
+
-
- Return the pitch scale factor for this player.
-
-
-
-
+
- Set the tempo multiplier. This allows to slow down or speed up the music, without affecting its pitch.
-
-
-
-
-
-
- Return the tempo multiplier.
-
-
-
-
-
-
- Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for over amplifying (see [method set_volume]) still apply.
-
-
-
-
-
-
- Return the playback volume for this player, in decibels.
-
-
-
-
-
-
- Return the name of the currently assigned stream. This is not the file name, but a field inside the file. If no stream is assigned, if returns "<No Stream>".
-
-
-
-
-
-
- Return the number of times the playback has looped.
-
-
-
-
-
-
- Return the playback position. May be in seconds, but depends on the stream type.
-
-
-
-
-
-
- Set the playback position. May be in seconds, but depends on the stream type.
+ Return the volume scale for an individual channel of the stream.
@@ -12217,11 +12161,60 @@ This approximation makes straight segments between each point, then subdivides t
Return the song length. May be in seconds, but depends on the stream type.
-
-
-
+
+
+
- Set whether this player will start playing as soon as it enters the scene tree.
+ Return the number of times the playback has looped.
+
+
+
+
+
+
+ Return the pitch scale factor for this player.
+
+
+
+
+
+
+ Return the playback position. May be in seconds, but depends on the stream type.
+
+
+
+
+
+
+ Return the currently assigned stream.
+
+
+
+
+
+
+ Return the name of the currently assigned stream. This is not the file name, but a field inside the file. If no stream is assigned, if returns "<No Stream>".
+
+
+
+
+
+
+ Return the tempo multiplier.
+
+
+
+
+
+
+ Return the playback volume for this player.
+
+
+
+
+
+
+ Return the playback volume for this player, in decibels.
@@ -12231,6 +12224,46 @@ This approximation makes straight segments between each point, then subdivides t
Return whether this player will start playing as soon as it enters the scene tree.
+
+
+
+
+ Return whether this player will be restart the playback at the end.
+
+
+
+
+
+
+ Return whether the playback is currently paused.
+
+
+
+
+
+
+ Return whether this player is playing.
+
+
+
+
+ Play the currently assigned stream.
+
+
+
+
+
+
+ Set the playback position. May be in seconds, but depends on the stream type.
+
+
+
+
+
+
+ Set whether this player will start playing as soon as it enters the scene tree.
+
+
@@ -12241,22 +12274,59 @@ This approximation makes straight segments between each point, then subdivides t
Many stream formats are multichannel, so this allows to affect only a part of the music.
-
-
-
-
+
+
- Return the volume scale for an individual channel of the stream.
+ Set whether the stream will be restarted at the end.
-
-
-
-
+
+
- Return the time at which the last note of a given channel in the stream plays.
+ Pause stream playback.
+
+
+
+
+
+
+ Set the pitch multiplier for all sounds coming from this stream. A value of 2.0 shifts all pitches one octave up, and a value of 0.5 shifts pitches one octave down.
+
+
+
+
+
+
+ Set the [EventStream] this player will play.
+
+
+
+
+
+
+ Set the tempo multiplier. This allows to slow down or speed up the music, without affecting its pitch.
+
+
+
+
+
+
+ Set the playback volume for this player. This is a float between 0.0 (silent) and 1.0 (full volume). Values over 1.0 may amplify sound even more, but may introduce distortion. Negative values may just invert the output waveform, which produces no audible difference.
+ The effect of these special values ultimately depends on the low-level implementation of the file format being played.
+
+
+
+
+
+
+ Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for over amplifying (see [method set_volume]) still apply.
+
+
+
+
+ Stop playing.
@@ -12318,6 +12388,184 @@ This approximation makes straight segments between each point, then subdivides t
[/codeblock]
+
+
+ Close the currently opened file.
+
+
+
+
+
+
+ Return whether the file cursor reached the end of the file.
+
+
+
+
+
+
+
+
+ Get whether or not the file in the specified path exists.
+
+
+
+
+
+
+ Get the next 16 bits from the file as an integer.
+
+
+
+
+
+
+ Get the next 32 bits from the file as an integer.
+
+
+
+
+
+
+ Get the next 64 bits from the file as an integer.
+
+
+
+
+
+
+ Get the next 8 bits from the file as an integer.
+
+
+
+
+
+
+ Get the whole file as a [String].
+
+
+
+
+
+
+
+
+ Get next len bytes of the file as a [RawArray].
+
+
+
+
+
+
+
+
+ Get the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma).
+
+
+
+
+
+
+ Get the next 64 bits from the file as a floating point number.
+
+
+
+
+
+
+ Get whether endian swap is enabled for this file.
+
+
+
+
+
+
+ Get the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [@Global Scope].
+
+
+
+
+
+
+ Get the next 32 bits from the file as a floating point number.
+
+
+
+
+
+
+ Return the size of the file in bytes.
+
+
+
+
+
+
+ Get the next line of the file as a [String].
+
+
+
+
+
+
+
+
+ Return a md5 String representing the file at the given path or an empty [String] on failure.
+
+
+
+
+
+
+ Get a [String] saved in Pascal format from the file.
+
+
+
+
+
+
+ Return the file cursor position.
+
+
+
+
+
+
+ Get the next bits from the file as a floating point number.
+
+
+
+
+
+
+
+
+ Return a sha256 String representing the file at the given path or an empty [String] on failure.
+
+
+
+
+ Get the next Variant value from the file.
+
+
+
+
+
+
+ Return whether the file is currently opened.
+
+
+
+
+
+
+
+
+
+
+ Open the file for writing or reading, depending on the flags.
+
+
@@ -12344,29 +12592,6 @@ This approximation makes straight segments between each point, then subdivides t
Open an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it.
-
-
-
-
-
-
-
-
- Open the file for writing or reading, depending on the flags.
-
-
-
-
- Close the currently opened file.
-
-
-
-
-
-
- Return whether the file is currently opened.
-
-
@@ -12381,124 +12606,6 @@ This approximation makes straight segments between each point, then subdivides t
Change the file reading/writing cursor to the specified position (in bytes from the end of the file). Note that this is an offset, so you should use negative numbers or the cursor will be at the end of the file.
-
-
-
-
- Return the file cursor position.
-
-
-
-
-
-
- Return the size of the file in bytes.
-
-
-
-
-
-
- Return whether the file cursor reached the end of the file.
-
-
-
-
-
-
- Get the next 8 bits from the file as an integer.
-
-
-
-
-
-
- Get the next 16 bits from the file as an integer.
-
-
-
-
-
-
- Get the next 32 bits from the file as an integer.
-
-
-
-
-
-
- Get the next 64 bits from the file as an integer.
-
-
-
-
-
-
- Get the next 32 bits from the file as a floating point number.
-
-
-
-
-
-
- Get the next 64 bits from the file as a floating point number.
-
-
-
-
-
-
- Get the next bits from the file as a floating point number.
-
-
-
-
-
-
-
-
- Get next len bytes of the file as a [RawArray].
-
-
-
-
-
-
- Get the next line of the file as a [String].
-
-
-
-
-
-
- Get the whole file as a [String].
-
-
-
-
-
-
-
-
- Return a md5 String representing the file at the given path or an empty [String] on failure.
-
-
-
-
-
-
-
-
- Return a sha256 String representing the file at the given path or an empty [String] on failure.
-
-
-
-
-
-
- Get whether endian swap is enabled for this file.
-
-
@@ -12508,34 +12615,6 @@ This approximation makes straight segments between each point, then subdivides t
Note that this is about the file format, not CPU type. This is always reseted to [code]false[/code] whenever you open the file.
-
-
-
-
- Get the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [@Global Scope].
-
-
-
-
- Get the next Variant value from the file.
-
-
-
-
-
-
-
-
- Get the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma).
-
-
-
-
-
-
- Store an integer as 8 bits in the file.
-
-
@@ -12557,25 +12636,11 @@ This approximation makes straight segments between each point, then subdivides t
Store an integer as 64 bits in the file.
-
-
+
+
- Store a floating point number as 32 bits in the file.
-
-
-
-
-
-
- Store a floating point number as 64 bits in the file.
-
-
-
-
-
-
- Store a floating point number in the file.
+ Store an integer as 8 bits in the file.
@@ -12585,6 +12650,20 @@ This approximation makes straight segments between each point, then subdivides t
Store the given array of bytes in the file.
+
+
+
+
+ Store a floating point number as 64 bits in the file.
+
+
+
+
+
+
+ Store a floating point number as 32 bits in the file.
+
+
@@ -12592,6 +12671,20 @@ This approximation makes straight segments between each point, then subdivides t
Store the given [String] as a line in the file.
+
+
+
+
+ Store the given [String] as a line in the file in Pascal format (i.e. also store the length of the string).
+
+
+
+
+
+
+ Store a floating point number in the file.
+
+
@@ -12606,40 +12699,17 @@ This approximation makes straight segments between each point, then subdivides t
Store any Variant value in the file.
-
-
-
-
- Store the given [String] as a line in the file in Pascal format (i.e. also store the length of the string).
-
-
-
-
-
-
- Get a [String] saved in Pascal format from the file.
-
-
-
-
-
-
-
-
- Get whether or not the file in the specified path exists.
-
-
Open the file for reading.
-
- Open the file for writing. Create it if the file not exists and truncate if it exists.
-
Open the file for reading and writing, without truncating the file.
+
+ Open the file for writing. Create it if the file not exists and truncate if it exists.
+
Open the file for reading and writing. Create it if the file not exists and truncate if it exists.
@@ -12653,11 +12723,6 @@ This approximation makes straight segments between each point, then subdivides t
FileDialog is a preset dialog used to choose files and directories in the filesystem. It supports filter masks.
-
-
- Clear all the added filters in the dialog.
-
-
@@ -12665,6 +12730,18 @@ This approximation makes straight segments between each point, then subdivides t
Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("*.png ; PNG Images");
+
+
+ Clear all the added filters in the dialog.
+
+
+
+
+
+
+ Return the file access permission of the dialog.
+
+
@@ -12686,6 +12763,39 @@ This approximation makes straight segments between each point, then subdivides t
Get the current selected path (directory and file) of the file dialog (empty if none).
+
+
+
+
+ Get the file dialog mode from the MODE_* enum.
+
+
+
+
+
+
+ Return the vertical box container of the dialog, custom controls can be added to it.
+
+
+
+
+ Invalidate and update the current dialog content list.
+
+
+
+
+
+
+ Return true if the diaog allows show hidden files.
+
+
+
+
+
+
+ Set the file access permission of the dialog(Must be one of [ACCESS_RESOURCES], [ACCESS_USERDATA] or [ACCESS_FILESYSTEM]).
+
+
@@ -12714,34 +12824,6 @@ This approximation makes straight segments between each point, then subdivides t
Set the file dialog mode from the MODE_* enum.
-
-
-
-
- Get the file dialog mode from the MODE_* enum.
-
-
-
-
-
-
- Return the vertical box container of the dialog, custom controls can be added to it.
-
-
-
-
-
-
- Set the file access permission of the dialog(Must be one of [ACCESS_RESOURCES], [ACCESS_USERDATA] or [ACCESS_FILESYSTEM]).
-
-
-
-
-
-
- Return the file access permission of the dialog.
-
-
@@ -12749,27 +12831,8 @@ This approximation makes straight segments between each point, then subdivides t
Set the dialog should show hidden files.
-
-
-
-
- Return true if the diaog allows show hidden files.
-
-
-
-
- Invalidate and update the current dialog content list.
-
-
-
-
-
-
- Event emitted when the user selects multiple files.
-
-
@@ -12784,8 +12847,24 @@ This approximation makes straight segments between each point, then subdivides t
Event emitted when the user selects a file (double clicks it or presses the OK button).
+
+
+
+
+ Event emitted when the user selects multiple files.
+
+
+
+ The dialog allows the selection of file and directory.
+
+
+ The dialog allows ascess files under [Resource] path(res://) .
+
+
+ The dialog allows ascess files in whole file system.
+
The dialog allows the selection of one, and only one file.
@@ -12801,15 +12880,6 @@ This approximation makes straight segments between each point, then subdivides t
The dialog will warn when a file exists.
-
- The dialog allows the selection of file and directory.
-
-
- The dialog allows ascess files under [Resource] path(res://) .
-
-
- The dialog allows ascess files in whole file system.
-
@@ -12828,13 +12898,18 @@ This approximation makes straight segments between each point, then subdivides t
FixedMaterial is a simple type of material [Resource], which contains a fixed amount of parameters. It is the only type of material supported in fixed-pipeline devices and APIs. It is also an often a better alternative to [ShaderMaterial] for most simple use cases.
-
-
-
-
+
+
+
+
- Set a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it's best to check the enum.
+
+
+
+
+
+
@@ -12844,31 +12919,10 @@ This approximation makes straight segments between each point, then subdivides t
Return a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it's best to check the enum.
-
-
-
-
-
-
- Set a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [method set_texcoord_mode]).
-
-
-
-
+
+
-
-
- Return a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [method set_texcoord_mode]).
-
-
-
-
-
-
-
-
- Set the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object.
@@ -12880,27 +12934,13 @@ This approximation makes straight segments between each point, then subdivides t
Return the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object.
-
-
-
-
-
-
-
-
-
-
+
+
-
+
-
-
-
-
-
-
- Sets a special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM.
+ Return a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [method set_texcoord_mode]).
@@ -12910,16 +12950,27 @@ This approximation makes straight segments between each point, then subdivides t
Returns the special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM.
+
+
+
+
+
+
+
+
-
-
-
+
+
+
+
+
+ Set a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it's best to check the enum.
@@ -12928,14 +12979,49 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
+
+
+
+
+
+ Set the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object.
+
+
+
+
+
+
+
+
+ Set a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [method set_texcoord_mode]).
+
+
+
+
+
+
+ Sets a special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Diffuse Lighting (light scattered from surface).
@@ -12962,8 +13048,6 @@ This approximation makes straight segments between each point, then subdivides t
Maximum amount of parameters.
-
-
Read texture coordinates from the UV array.
@@ -12973,21 +13057,7 @@ This approximation makes straight segments between each point, then subdivides t
Read texture coordinates from the UV2 array.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -13014,6 +13084,23 @@ This approximation makes straight segments between each point, then subdivides t
Draw "string" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally clipping the width. "pos" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "pos" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character.
+
+
@@ -13035,12 +13122,6 @@ This approximation makes straight segments between each point, then subdivides t
Return the total font height (ascent plus descent) in pixels.
-
-
-
-
-
-
@@ -13050,21 +13131,10 @@ This approximation makes straight segments between each point, then subdivides t
Return the size of a string, taking kerning and advance into account.
-
-
+
+
-
-
-
-
-
-
-
-
-
-
- Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "pos" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character.
@@ -13101,14 +13171,14 @@ This approximation makes straight segments between each point, then subdivides t
-
-
+
+
-
-
+
+
@@ -13123,6 +13193,13 @@ This approximation makes straight segments between each point, then subdivides t
+
+
+
+
+ Should put children to the top left corner instead of center of the container.
+
+
@@ -13131,13 +13208,6 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
-
- Should put children to the top left corner instead of center of the container.
-
-
@@ -13162,16 +13232,16 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
-
+
+
+
+
@@ -13182,10 +13252,26 @@ This approximation makes straight segments between each point, then subdivides t
-
-
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -13198,14 +13284,6 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
-
-
-
-
-
@@ -13214,14 +13292,6 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
-
-
-
-
-
@@ -13238,14 +13308,6 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
-
-
-
-
-
@@ -13254,14 +13316,6 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
-
-
-
-
-
@@ -13270,20 +13324,54 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -13300,24 +13388,6 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -13334,20 +13404,6 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -13364,42 +13420,28 @@ This approximation makes straight segments between each point, then subdivides t
-
-
+
+
-
+
-
+
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
+
-
+
-
-
-
+
@@ -13418,14 +13460,16 @@ This approximation makes straight segments between each point, then subdivides t
-
-
+
+
-
+
-
+
-
+
+
+
@@ -13438,70 +13482,10 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -13520,18 +13504,104 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-
-
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -13548,25 +13618,33 @@ This approximation makes straight segments between each point, then subdivides t
Base node for geometry based visual instances. Shares some common functionality like visibility and custom materials.
-
-
-
-
- Set the material override for the whole geometry.
-
-
-
-
+
+
- Return the material override for the whole geometry.
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -13578,15 +13656,22 @@ This approximation makes straight segments between each point, then subdivides t
-
-
+
+
+
+
+ Return the material override for the whole geometry.
+
+
+
+
-
-
-
+
+
+
@@ -13596,60 +13681,45 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+ Set the material override for the whole geometry.
+
+
-
-
-
-
+
+
+
+
@@ -13674,22 +13744,11 @@ This approximation makes straight segments between each point, then subdivides t
Contains global variables accessible from everywhere. Use the normal [Object] API, such as "Globals.get(variable)", "Globals.set(variable,value)" or "Globals.has(variable)" to access them. Variables stored in engine.cfg are also loaded into globals, making this object very useful for reading custom game configuration options.
-
-
-
+
- Return true if a configuration value is present.
-
-
-
-
-
-
-
-
- Set the order of a configuration value (influences when saved to the config file).
+ Clear the whole configuration (not recommended, may break things).
@@ -13701,38 +13760,12 @@ This approximation makes straight segments between each point, then subdivides t
Return the order of a configuration value (influences when saved to the config file).
-
-
-
-
-
-
- If set to true, this value can be saved to the configuration file. This is useful for editors.
-
-
-
-
+
+
- If returns true, this value can be saved to the configuration file. This is useful for editors.
-
-
-
-
-
-
- Clear the whole configuration (not recommended, may break things).
-
-
-
-
-
-
-
-
- Convert a path to a localized path (res:// path).
@@ -13744,10 +13777,13 @@ This approximation makes straight segments between each point, then subdivides t
Convert a localized path (res://) to a full native OS path.
-
-
+
+
+
+
+ Return true if a configuration value is present.
@@ -13758,12 +13794,13 @@ This approximation makes straight segments between each point, then subdivides t
-
-
+
+
+ If returns true, this value can be saved to the configuration file. This is useful for editors.
@@ -13774,6 +13811,21 @@ This approximation makes straight segments between each point, then subdivides t
+
+
+
+
+
+
+ Convert a path to a localized path (res:// path).
+
+
+
+
+
+
+
+
@@ -13782,6 +13834,24 @@ This approximation makes straight segments between each point, then subdivides t
+
+
+
+
+
+
+ Set the order of a configuration value (influences when saved to the config file).
+
+
+
+
+
+
+
+
+ If set to true, this value can be saved to the configuration file. This is useful for editors.
+
+
@@ -13810,21 +13880,6 @@ This approximation makes straight segments between each point, then subdivides t
Create a connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode. If the connection already exists, no connection is created.
-
-
-
-
-
-
-
-
-
-
-
-
- Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode.
-
-
@@ -13852,13 +13907,6 @@ This approximation makes straight segments between each point, then subdivides t
Return the scroll offset.
-
-
-
-
- Set the zoom value of the GraphEdit. Zoom value is between [0.01; 1.728].
-
-
@@ -13866,11 +13914,19 @@ This approximation makes straight segments between each point, then subdivides t
Return the current zoom value.
-
-
+
+
+
+
+
+
+
+
+
+
- Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void.
+ Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode.
@@ -13880,41 +13936,30 @@ This approximation makes straight segments between each point, then subdivides t
Return true is the disconnection of connections is enable in the visual GraphEdit. False otherwise.
-
-
-
-
- Signal sent when a GraphNode is attempted to be removed from the GraphEdit.
-
-
-
-
- Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit.
-
-
-
-
+
+
- Signal sent when a popup is requested. Happens on right-clicking in the GraphEdit. 'p_position' is the position of the mouse pointer when the signal is sent.
+ Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void.
-
+
+
+
+
+
+ Set the zoom value of the GraphEdit. Zoom value is between [0.01; 1.728].
+
+
+
+
Signal sent at the beginning of a GraphNode movement.
-
-
-
-
-
-
-
-
-
+
- Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be removed.
+ Signal sent at the end of a GraphNode movement.
@@ -13930,22 +13975,47 @@ This approximation makes straight segments between each point, then subdivides t
Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be created.
-
+
- Signal sent at the end of a GraphNode movement.
+ Signal sent when a GraphNode is attempted to be removed from the GraphEdit.
+
+
+
+
+
+
+
+
+
+
+
+
+ Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be removed.
+
+
+
+
+ Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit.
+
+
+
+
+
+
+ Signal sent when a popup is requested. Happens on right-clicking in the GraphEdit. 'p_position' is the position of the mouse pointer when the signal is sent.
-
-
-
+
-
+
+
+
@@ -13957,11 +14027,127 @@ This approximation makes straight segments between each point, then subdivides t
A GraphNode is a container defined by a title. It can have 1 or more input and output slots, which can be enabled (shown) or disabled (not shown) and have different (incompatible) types. Colors can also be assigned to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input and output connections are left and right slots, but only enabled slots are counted as connections.
-
-
+
+
+ Disable all input and output slots of the GraphNode.
+
+
+
+
- Set the title of the GraphNode.
+ Disable input and output slot whose index is 'idx'.
+
+
+
+
+
+
+
+
+ Return the color of the input connection 'idx'.
+
+
+
+
+
+
+ Return the number of enabled input slots (connections) to the GraphNode.
+
+
+
+
+
+
+
+
+ Return the position of the input connection 'idx'.
+
+
+
+
+
+
+
+
+ Return the type of the input connection 'idx'.
+
+
+
+
+
+
+
+
+ Return the color of the output connection 'idx'.
+
+
+
+
+
+
+ Return the number of enabled output slots (connections) of the GraphNode.
+
+
+
+
+
+
+
+
+ Return the position of the output connection 'idx'.
+
+
+
+
+
+
+
+
+ Return the type of the output connection 'idx'.
+
+
+
+
+
+
+ Return the offset of the GraphNode.
+
+
+
+
+
+
+
+
+ Return the color set to 'idx' left (input) slot.
+
+
+
+
+
+
+
+
+ Return the color set to 'idx' right (output) slot.
+
+
+
+
+
+
+
+
+ Return the (integer) type of left (input) 'idx' slot.
+
+
+
+
+
+
+
+
+ Return the (integer) type of right (output) 'idx' slot.
@@ -13971,6 +14157,45 @@ This approximation makes straight segments between each point, then subdivides t
Return the title of the GraphNode.
+
+
+
+
+ Returns true if the close button is shown. False otherwise.
+
+
+
+
+
+
+
+
+ Return true if left (input) slot 'idx' is enabled. False otherwise.
+
+
+
+
+
+
+
+
+ Return true if right (output) slot 'idx' is enabled. False otherwise.
+
+
+
+
+
+
+ Set the offset of the GraphNode.
+
+
+
+
+
+
+ Show the close button on the GraphNode if 'show' is true (disabled by default). If enabled, a connection on the signal close_request is needed for the close button to work.
+
+
@@ -13990,175 +14215,15 @@ This approximation makes straight segments between each point, then subdivides t
Set the tuple of input/output slots defined by 'idx' ID. 'left' slots are input, 'right' are output. 'type' is an integer defining the type of the slot. Refer to description for the compatibility between slot types.
-
-
+
+
- Disable input and output slot whose index is 'idx'.
-
-
-
-
- Disable all input and output slots of the GraphNode.
-
-
-
-
-
-
-
-
- Return true if left (input) slot 'idx' is enabled. False otherwise.
-
-
-
-
-
-
-
-
- Return the (integer) type of left (input) 'idx' slot.
-
-
-
-
-
-
-
-
- Return the color set to 'idx' left (input) slot.
-
-
-
-
-
-
-
-
- Return true if right (output) slot 'idx' is enabled. False otherwise.
-
-
-
-
-
-
-
-
- Return the (integer) type of right (output) 'idx' slot.
-
-
-
-
-
-
-
-
- Return the color set to 'idx' right (output) slot.
-
-
-
-
-
-
- Set the offset of the GraphNode.
-
-
-
-
-
-
- Return the offset of the GraphNode.
-
-
-
-
-
-
- Return the number of enabled output slots (connections) of the GraphNode.
-
-
-
-
-
-
- Return the number of enabled input slots (connections) to the GraphNode.
-
-
-
-
-
-
-
-
- Return the position of the output connection 'idx'.
-
-
-
-
-
-
-
-
- Return the type of the output connection 'idx'.
-
-
-
-
-
-
-
-
- Return the color of the output connection 'idx'.
-
-
-
-
-
-
-
-
- Return the position of the input connection 'idx'.
-
-
-
-
-
-
-
-
- Return the type of the input connection 'idx'.
-
-
-
-
-
-
-
-
- Return the color of the input connection 'idx'.
-
-
-
-
-
-
- Show the close button on the GraphNode if 'show' is true (disabled by default). If enabled, a connection on the signal close_request is needed for the close button to work.
-
-
-
-
-
-
- Returns true if the close button is shown. False otherwise.
+ Set the title of the GraphNode.
-
-
- Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode.
-
-
Signal sent on closing the GraphNode.
@@ -14178,34 +14243,39 @@ This approximation makes straight segments between each point, then subdivides t
Signal sent when the GraphNode is moved.
+
+
+ Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode.
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -14216,13 +14286,6 @@ This approximation makes straight segments between each point, then subdivides t
Grid container will arrange its children in a grid like structure, the grid columns are specified using the [method set_columns] method and the number of rows will be equal to the number of children in the container divided by the number of columns, for example: if the container has 5 children, and 2 columns, there will be 3 rows in the container. Notice that grid layout will preserve the columns and rows for every size of the container.
-
-
-
-
- Sets the numbers of columns in the container, then reorder its children to accommodate the new layout
-
-
@@ -14230,14 +14293,21 @@ This approximation makes straight segments between each point, then subdivides t
Returns the number of columns in this container
+
+
+
+
+ Sets the numbers of columns in the container, then reorder its children to accommodate the new layout
+
+
-
-
+
+
@@ -14246,64 +14316,98 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
+
-
-
+
+
-
-
-
-
-
+
-
+
+
+
+
+
+
+
+
+
-
-
-
-
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
+
+
@@ -14332,48 +14436,110 @@ This approximation makes straight segments between each point, then subdivides t
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -14386,120 +14552,24 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
-
-
-
+
+
-
-
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -14514,11 +14584,11 @@ This approximation makes straight segments between each point, then subdivides t
Groove constraint for 2D physics. This is useful for making a body "slide" through a segment placed in another.
-
-
-
+
+
+
- Set the length of the groove.
+ Set the final offset of the groove on body A.
@@ -14535,11 +14605,11 @@ This approximation makes straight segments between each point, then subdivides t
Set the initial offset of the groove on body A.
-
-
-
+
+
+
- Set the final offset of the groove on body A.
+ Set the length of the groove.
@@ -14576,24 +14646,24 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-
-
-
+
+
+
@@ -14608,22 +14678,22 @@ This approximation makes straight segments between each point, then subdivides t
-
+
-
-
-
+
-
+
-
+
+
+
@@ -14656,17 +14726,17 @@ This approximation makes straight segments between each point, then subdivides t
-
-
-
+
+
+
-
+
@@ -14684,11 +14754,11 @@ This approximation makes straight segments between each point, then subdivides t
-
+
-
+
@@ -14701,6 +14771,11 @@ This approximation makes straight segments between each point, then subdivides t
Can be reused to connect to different hosts and make many requests.
+
+
+ Cloces the current connection, allows for reusal of [HTTPClient].
+
+
@@ -14718,13 +14793,6 @@ This approximation makes straight segments between each point, then subdivides t
verify_host will check the SSL identity of the host if set to true.
-
-
-
-
- Set connection to use, for this client.
-
-
@@ -14732,81 +14800,11 @@ This approximation makes straight segments between each point, then subdivides t
Return current connection.
-
+
-
-
-
-
-
-
-
-
- Sends a raw request to the connected host. The url is what is normally behind the hostname, i.e. in [code]http://somehost.com/index.php[/code], url would be "index.php".
- Headers are HTTP request headers.
- Sends body raw, as a byte array, does not encode it in any way.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Sends a request to the connected host. The url is what is normally behind the hostname, i.e. in [code]http://somehost.com/index.php[/code], url would be "index.php".
- Headers are HTTP request headers.
- To create a POST request with query strings to push to the server, do:
- [codeblock]
- var fields = {"username" : "user", "password" : "pass"}
- var queryString = httpClient.query_string_from_dict(fields)
- var headers = ["Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(queryString.length())]
- var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, queryString)
- [/codeblock]
-
-
-
-
-
-
-
-
- Stub function
-
-
-
-
-
-
-
-
- Stub function
-
-
-
-
- Cloces the current connection, allows for reusal of [HTTPClient].
-
-
-
-
-
-
- Return whether this [HTTPClient] has a response available.
-
-
-
-
-
-
- Return whether this [HTTPClient] has a response that is chunked.
+ Return the response's body length.
@@ -14832,32 +14830,18 @@ Structure: ("key":"value1; value2")
Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
- Return the response's body length.
+ Returns a status string like STATUS_REQUESTING. Need to call [method poll] in order to get status updates.
-
-
+
+
- Reads one chunk from the response.
-
-
-
-
-
-
- Sets the size of the buffer used and maximum bytes to read per iteration. see [method read_response_body_chunk]
-
-
-
-
-
-
- If set to true, execution will block until all data is read from the response.
+ Return whether this [HTTPClient] has a response available.
@@ -14867,11 +14851,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return whether blocking mode is enabled.
-
-
+
+
- Returns a status string like STATUS_REQUESTING. Need to call [method poll] in order to get status updates.
+ Return whether this [HTTPClient] has a response that is chunked.
@@ -14895,6 +14879,92 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
[/codeblock]
+
+
+
+
+ Reads one chunk from the response.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sends a request to the connected host. The url is what is normally behind the hostname, i.e. in [code]http://somehost.com/index.php[/code], url would be "index.php".
+ Headers are HTTP request headers.
+ To create a POST request with query strings to push to the server, do:
+ [codeblock]
+ var fields = {"username" : "user", "password" : "pass"}
+ var queryString = httpClient.query_string_from_dict(fields)
+ var headers = ["Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(queryString.length())]
+ var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, queryString)
+ [/codeblock]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sends a raw request to the connected host. The url is what is normally behind the hostname, i.e. in [code]http://somehost.com/index.php[/code], url would be "index.php".
+ Headers are HTTP request headers.
+ Sends body raw, as a byte array, does not encode it in any way.
+
+
+
+
+
+
+
+
+ Stub function
+
+
+
+
+
+
+
+
+ Stub function
+
+
+
+
+
+
+ If set to true, execution will block until all data is read from the response.
+
+
+
+
+
+
+ Set connection to use, for this client.
+
+
+
+
+
+
+ Sets the size of the buffer used and maximum bytes to read per iteration. see [method read_response_body_chunk]
+
+
@@ -14915,26 +14985,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -15033,6 +15083,26 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -15044,52 +15114,16 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Can be used to make HTTP requests or download files via HTTP.
-
-
-
-
-
-
-
-
-
-
- Make a HTTP GET request. The url is the complete url including "http://" or "https://" which will be parsed for a host and a port.
- The custom_headers are HTTP request headers which will be used. If User-Agent is not specified a Godot specific will be used.
- The ssl_validate_domain specifies if in case of HTTPS the server certificate should be verified.
-
-
Cancel the current request.
-
+
- Return the current status of the underlying [HTTPClient].
-
-
-
-
-
-
- Make this HTTPRequest use threads.
-
-
-
-
-
-
- Whether this request is using threads.
-
-
-
-
-
-
- Set the response body size limit.
+ Return the response body length.
@@ -15099,27 +15133,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return current body size limit.
-
-
-
-
- Set the maximum amount of redirects the request will follow.
-
-
-
-
-
-
- Return the maximum amount of redirects that will be followed.
-
-
-
-
-
-
- Set the file to download into. Outputs the response body into the file.
-
-
@@ -15134,11 +15147,68 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the amount of bytes this HTTPRequest downloaded.
-
+
- Return the response body length.
+ Return the current status of the underlying [HTTPClient].
+
+
+
+
+
+
+ Return the maximum amount of redirects that will be followed.
+
+
+
+
+
+
+ Whether this request is using threads.
+
+
+
+
+
+
+
+
+
+
+
+
+ Make a HTTP GET request. The url is the complete url including "http://" or "https://" which will be parsed for a host and a port.
+ The custom_headers are HTTP request headers which will be used. If User-Agent is not specified a Godot specific will be used.
+ The ssl_validate_domain specifies if in case of HTTPS the server certificate should be verified.
+
+
+
+
+
+
+ Set the response body size limit.
+
+
+
+
+
+
+ Set the file to download into. Outputs the response body into the file.
+
+
+
+
+
+
+ Set the maximum amount of redirects the request will follow.
+
+
+
+
+
+
+ Make this HTTPRequest use threads.
@@ -15163,6 +15233,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+ HTTPRequest couldn't write to the download file.
+
+
+ Request reached it's maximum redirect limit, see [method set_max_redirects].
+
Request failed while connecting.
@@ -15187,12 +15263,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
HTTPRequest couldn't open the download file.
-
- HTTPRequest couldn't write to the download file.
-
-
- Request reached it's maximum redirect limit, see [method set_max_redirects].
-
@@ -15201,10 +15271,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
+
+
+
+
@@ -15225,16 +15295,22 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
+
+
+
+
+
+
+
+
+
+
@@ -15253,12 +15329,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
@@ -15269,6 +15339,37 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
IP contains some support functions for the IPv4 protocol. TCP/IP support is in different classes (see [StreamPeerTCP] and [TCP_Server]). IP provides hostname resolution support, both blocking and threaded.
+
+
+
+
+ Erase a queue ID, removing it from the queue if needed. This should be used after a queue is completed to free it and enable more queries to happen.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return a resolved item address, or an empty string if an error happened or resolution didn't happen yet (see [method get_resolve_item_status]).
+
+
+
+
+
+
+
+
+ Return the status of hostname queued for resolving, given it's queue ID. Returned status can be any of the RESOLVER_STATUS_* enumeration.
+
+
@@ -15287,39 +15388,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Create a queue item for resolving a given hostname. The queue ID is returned, or RESOLVER_INVALID_ID on error.
-
-
-
-
-
-
- Return the status of hostname queued for resolving, given it's queue ID. Returned status can be any of the RESOLVER_STATUS_* enumeration.
-
-
-
-
-
-
-
-
- Return a resolved item address, or an empty string if an error happened or resolution didn't happen yet (see [method get_resolve_item_status]).
-
-
-
-
-
-
- Erase a queue ID, removing it from the queue if needed. This should be used after a queue is completed to free it and enable more queries to happen.
-
-
-
-
-
-
-
-
+
+
@@ -15330,8 +15402,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
@@ -15352,6 +15422,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Built in native image datatype. Contains image data, which can be converted to a texture, and several functions to interact with it.
+
+
+
+
+
+
+
+
+
+
+
+
+ Create an empty image of a specific size and format.
+
+
@@ -15524,21 +15609,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Save this [Image] as a png.
-
-
-
-
-
-
-
-
-
-
-
-
- Create an empty image of a specific size and format.
-
-
@@ -15553,22 +15623,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -15589,12 +15643,28 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -15635,25 +15705,8 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Create a new [ImageTexture] from an [Image] with "flags" from [Texture].FLAG_*.
-
-
-
+
- Return the format of the [ImageTexture], one of [Image].FORMAT_*.
-
-
-
-
-
-
- Load an [ImageTexure].
-
-
-
-
-
-
- Set the [Image] of this [ImageTexture].
@@ -15663,25 +15716,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the [Image] of this [ImageTexture].
-
-
-
-
- Set the storage type. One of [ImageTexture].STORAGE_*.
-
-
-
+
- Return the storage type. One of [ImageTexture].STORAGE_*.
-
-
-
-
-
-
- Set the storage quality in case of [ImageTexture].STORAGE_COMPRESS_LOSSY.
+ Return the format of the [ImageTexture], one of [Image].FORMAT_*.
@@ -15691,7 +15730,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the storage quality for [ImageTexture].STORAGE_COMPRESS_LOSSY.
-
+
+
+
+
+ Return the storage type. One of [ImageTexture].STORAGE_*.
+
+
+
+
+
+
+ Load an [ImageTexure].
+
+
+
@@ -15699,12 +15752,18 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
+
+
+ Set the [Image] of this [ImageTexture].
-
+
+
+
+ Set the storage quality in case of [ImageTexture].STORAGE_COMPRESS_LOSSY.
@@ -15713,6 +15772,17 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+ Set the storage type. One of [ImageTexture].STORAGE_*.
+
+
+
+
+
+
@@ -15732,6 +15802,22 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -15740,6 +15826,20 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -15752,12 +15852,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
@@ -15770,30 +15864,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -15806,6 +15876,140 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joysticks, and input actions.
+
+
+
+
+ This will simulate pressing the specificed action.
+
+
+
+
+
+
+ If the specified action is already pressed, this will release it.
+
+
+
+
+
+
+
+
+ Add a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices.
+
+
+
+
+
+
+ If the device has an accelerometer, this will return the movement.
+
+
+
+
+
+
+
+
+
+
+ Returns the current value of the joystick axis at given index (see JOY_* constants in [@Global Scope])
+
+
+
+
+
+
+
+
+ Returns a SDL2 compatible device guid on platforms that use gamepad remapping. Returns "Default Gamepad" otherwise.
+
+
+
+
+
+
+
+
+ Returns the name of the joystick at the specified device index
+
+
+
+
+
+
+
+
+ Returns the duration of the current vibration effect in seconds.
+
+
+
+
+
+
+
+
+ Returns the strength of the joystick vibration: x is the strength of the weak motor, and y is the strength of the strong motor.
+
+
+
+
+
+
+ If the device has a magnetometer, this will return the magnetic field strength in micro-Tesla for all axes.
+
+
+
+
+
+
+ Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time the bits are added together.
+
+
+
+
+
+
+ Return the mouse mode. See the constants for more information.
+
+
+
+
+
+
+ Returns the mouse speed.
+
+
+
+
+
+
+
+
+ Returns true or false depending on whether the action event is pressed. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with [InputMap].
+
+
+
+
+
+
+
+
+
+
+ Returns if the joystick button at the given index is currently pressed. (see JOY_* constants in [@Global Scope])
+
+
+
+
+
+
+
+
+ Returns if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in the JOY_* constants (see [@Global Scope]). Unknown joysticks are not expected to match these constants, but you can still retrieve events from them.
+
+
@@ -15824,35 +16028,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Returns true or false depending on whether mouse button is pressed or not. You can pass BUTTON_*, which are pre-defined constants listed in [@Global Scope].
-
-
-
-
-
-
-
-
- Returns if the joystick button at the given index is currently pressed. (see JOY_* constants in [@Global Scope])
-
-
-
-
-
-
-
-
- Returns true or false depending on whether the action event is pressed. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with [InputMap].
-
-
-
-
-
-
-
-
- Add a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices.
-
-
@@ -15860,60 +16035,20 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Removes all mappings from the internal db that match the given uid.
-
-
-
-
+
+
+
+
- Returns if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in the JOY_* constants (see [@Global Scope]). Unknown joysticks are not expected to match these constants, but you can still retrieve events from them.
+ Set a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified.
-
-
-
-
-
-
+
+
- Returns the current value of the joystick axis at given index (see JOY_* constants in [@Global Scope])
-
-
-
-
-
-
-
-
- Returns the name of the joystick at the specified device index
-
-
-
-
-
-
-
-
- Returns a SDL2 compatible device guid on platforms that use gamepad remapping. Returns "Default Gamepad" otherwise.
-
-
-
-
-
-
-
-
- Returns the strength of the joystick vibration: x is the strength of the weak motor, and y is the strength of the strong motor.
-
-
-
-
-
-
-
-
- Returns the duration of the current vibration effect in seconds.
+ Set the mouse mode. See the constants for more information.
@@ -15923,7 +16058,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
Starts to vibrate the joystick. Joysticks usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will play the vibration indefinitely).
@@ -15936,48 +16071,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Stops the vibration of the joystick.
-
-
-
-
- If the device has an accelerometer, this will return the movement.
-
-
-
-
-
-
- If the device has a magnetometer, this will return the magnetic field strength in micro-Tesla for all axes.
-
-
-
-
-
-
- Returns the mouse speed.
-
-
-
-
-
-
- Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time the bits are added together.
-
-
-
-
-
-
- Set the mouse mode. See the constants for more information.
-
-
-
-
-
-
- Return the mouse mode. See the constants for more information.
-
-
@@ -15985,29 +16078,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Sets the mouse position to the specified vector.
-
-
-
-
- This will simulate pressing the specificed action.
-
-
-
-
-
-
- If the specified action is already pressed, this will release it.
-
-
-
-
-
-
-
-
- Set a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified.
-
-
@@ -16099,16 +16169,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
-
+
-
- Empty input event.
+
+
+
+ Joystick motion event.
+
+
+ Joystick button event.
Key event.
@@ -16119,18 +16194,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Mouse button event.
-
- Joystick motion event.
-
-
- Joystick button event.
+
+ Empty input event.
-
-
@@ -16185,15 +16255,19 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
-
+
-
+
+
+
+
+
@@ -16201,16 +16275,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
-
-
@@ -16265,21 +16335,25 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
+
+
+
+
-
+
+
+
+
+
@@ -16287,16 +16361,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
-
-
@@ -16351,19 +16421,23 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
+
+
+
+
-
+
+
+
+
+
@@ -16371,16 +16445,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
-
-
@@ -16435,31 +16505,35 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
+
+
+
+
-
-
+
+
+
+
-
+
+
+
+
+
@@ -16467,16 +16541,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
-
-
@@ -16531,43 +16601,47 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
+
-
+
-
+
-
+
+
+
-
+
-
+
-
+
+
+
+
+
+
+
-
+
+
+
+
+
@@ -16575,16 +16649,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
-
-
@@ -16639,49 +16709,53 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
+
-
+
+
+
+
+
-
+
+
+
-
+
+
+
+
+
-
+
+
+
+
+
@@ -16689,16 +16763,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
-
-
@@ -16753,35 +16823,39 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
-
-
-
-
-
-
+
+
-
+
-
+
+
+
+
+
-
+
+
+
+
+
@@ -16789,16 +16863,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
-
-
@@ -16853,25 +16923,29 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
-
-
-
-
-
-
+
+
+
+
+
+
-
+
+
+
+
+
@@ -16879,16 +16953,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
-
-
@@ -16899,38 +16969,33 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Singleton that manages actions. InputMap has a list of the actions used in InputEvent, which can be modified.
-
+
+
+
+
+
+
+ Add an [InputEvent] to action. This [InputEvent] will trigger the action.
+
+
+
+
+
+
+
+
+ Remove an [InputEvent] from an action.
+
+
+
-
- Whether this InputMap has an action with name "action".
-
-
-
-
-
-
+
- Return the id of an action.
-
-
-
-
-
-
-
-
- Return the action from an id.
-
-
-
-
-
-
- Return an [Array] of all actions in the [InputMap].
+ Whether an action has an [InputEvent] associated with it.
@@ -16947,33 +17012,32 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Remove an action from the [InputMap].
-
-
+
+
+
+
-
+
- Add an [InputEvent] to action. This [InputEvent] will trigger the action.
-
-
+
+
+
+
+
+
+ Return the action from an id.
+
+
+
+
-
-
- Whether an action has an [InputEvent] associated with it.
-
-
-
-
-
-
-
-
- Remove an [InputEvent] from an action.
+ Return the id of an action.
@@ -16985,14 +17049,20 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return an [Array] of [InputEvent]s associated with an action.
-
+
+
+
+
+ Return an [Array] of all actions in the [InputMap].
+
+
+
-
-
-
+
+ Whether this InputMap has an action with name "action".
@@ -17010,18 +17080,18 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
+
+
+
+
+
+
@@ -17034,6 +17104,15 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Integer Array. Array of integers. Can only contain integers. Optimized for memory usage, can't fragment the memory.
+
+
+
+
+
+
+ Create from a generic array.
+
+
@@ -17064,15 +17143,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the array size.
-
-
-
-
-
-
- Create from a generic array.
-
-
@@ -17083,9 +17153,9 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
+
+
@@ -17095,20 +17165,8 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
@@ -17119,9 +17177,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -17135,45 +17205,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
@@ -17183,15 +17229,39 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
+
+
+
+
+
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -17205,6 +17275,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+
+
+
+
@@ -17215,185 +17293,17 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
+
+
+
@@ -17403,102 +17313,24 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -17509,7 +17341,245 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -17521,14 +17591,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
@@ -17543,6 +17605,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+
+
+
+
@@ -17555,33 +17625,33 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
@@ -17591,9 +17661,9 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
+
+
@@ -17603,24 +17673,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
@@ -17633,9 +17691,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -17651,11 +17721,16 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Base node for all joint constraints in 2D physics. Joints take 2 bodies and apply a custom constraint.
-
-
-
+
+
+
+
+
+
+
+
+
- Set the path to the A node for the joint. Must be of type [PhysicsBody2D].
@@ -17665,13 +17740,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the path to the A node for the joint.
-
-
-
-
- Set the path to the B node for the joint. Must be of type [PhysicsBody2D].
-
-
@@ -17685,22 +17753,24 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
+
+
+
+ Set the path to the A node for the joint. Must be of type [PhysicsBody2D].
+
+
+
+
+
+
+ Set the path to the B node for the joint. Must be of type [PhysicsBody2D].
@@ -17717,6 +17787,92 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Kinematic Characters: KinematicBody also has an api for moving objects (the [method move] method) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics.
+
+
+
+
+ Return if this body can collide with character bodies.
+
+
+
+
+
+
+ Return if this body can collide with kinematic bodies.
+
+
+
+
+
+
+ Return if this body can collide with rigid bodies.
+
+
+
+
+
+
+ Return if this body can collide with static bodies.
+
+
+
+
+
+
+
+
+ Returns whether the KinematicBody can be teleported to the destination given as an argument, checking all collision shapes of the body against potential colliders at the destination.
+
+
+
+
+
+
+ Return the body that collided with this one.
+
+
+
+
+
+
+ Return the shape index from the body that collided with this one. If there is no collision, this method will return 0, so collisions must be checked first with [method is_colliding].
+
+
+
+
+
+
+ Return the velocity of the body that collided with this one.
+
+
+
+
+
+
+ Return the collision margin for this object.
+
+
+
+
+
+
+ Return the normal of the surface the body collided with. This is useful to implement sliding along a surface.
+
+
+
+
+
+
+ Return the point in space where the body is touching another. If there is no collision, this method will return (0,0,0), so collisions must be checked first with [method is_colliding].
+
+
+
+
+
+
+ Return whether the body is colliding with another.
+
+
@@ -17735,69 +17891,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Move the body to the given position. This is not a teleport, and the body will stop if there is an obstacle. The returned vector is how much movement was remaining before being stopped.
-
-
-
-
-
-
- Returns whether the KinematicBody can be teleported to the destination given as an argument, checking all collision shapes of the body against potential colliders at the destination.
-
-
-
-
-
-
- Return whether the body is colliding with another.
-
-
-
-
-
-
- Return the point in space where the body is touching another. If there is no collision, this method will return (0,0,0), so collisions must be checked first with [method is_colliding].
-
-
-
-
-
-
- Return the normal of the surface the body collided with. This is useful to implement sliding along a surface.
-
-
-
-
-
-
- Return the velocity of the body that collided with this one.
-
-
-
-
-
-
- Return the body that collided with this one.
-
-
-
-
-
-
- Return the shape index from the body that collided with this one. If there is no collision, this method will return 0, so collisions must be checked first with [method is_colliding].
-
-
-
+
- Set if this body should collide with static bodies.
-
-
-
-
-
-
- Return if this body can collide with static bodies.
+ Set if this body should collide with character bodies.
@@ -17807,13 +17905,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Set if this body should collide with kinematic bodies.
-
-
-
-
- Return if this body can collide with kinematic bodies.
-
-
@@ -17821,25 +17912,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Set if this body should collide with rigid bodies.
-
-
-
-
- Return if this body can collide with rigid bodies.
-
-
-
+
- Set if this body should collide with character bodies.
-
-
-
-
-
-
- Return if this body can collide with character bodies.
+ Set if this body should collide with static bodies.
@@ -17849,13 +17926,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Set the collision margin for this object. A collision margin is an amount that all shapes will grow when computing collisions, to account for numerical imprecision.
-
-
-
-
- Return the collision margin for this object.
-
-
@@ -17870,6 +17940,69 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Kinematic Characters: KinematicBody2D also has an api for moving objects (the [method move] method) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics.
+
+
+
+
+ Return the body that collided with this one.
+
+
+
+
+
+
+ Return the metadata of the shape that collided with this body. If there is no collision, it will return 0, so collisions must be checked first with [method is_colliding]. Additionally, this metadata can not be set with [method Object.set_meta], it must be set with [method Physics2DServer.body_set_shape_metadata].
+
+
+
+
+
+
+ Return the shape index from the body that collided with this one. If there is no collision, this method will return 0, so collisions must be checked first with [method is_colliding].
+
+
+
+
+
+
+ Return the velocity of the body that collided with this one.
+
+
+
+
+
+
+ Return the collision margin for this object.
+
+
+
+
+
+
+ Return the normal of the surface the body collided with. This is useful to implement sliding along a surface.
+
+
+
+
+
+
+ Return the point in space where the body is touching another. If there is no collision, this method will return (0,0), so collisions must be checked first with [method is_colliding].
+
+
+
+
+
+
+ Return the last movement done by the body.
+
+
+
+
+
+
+ Return whether the body is colliding with another.
+
+
@@ -17888,76 +18021,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Move the body to the given position. This is not a teleport, and the body will stop if there is an obstacle. The returned vector is how much movement was remaining before being stopped.
-
-
-
-
-
-
- Return true if there would be a collision if the body moved in the given direction.
-
-
-
-
-
-
- Return the last movement done by the body.
-
-
Undo the last movement done by the body.
-
-
-
-
- Return whether the body is colliding with another.
-
-
-
-
-
-
- Return the point in space where the body is touching another. If there is no collision, this method will return (0,0), so collisions must be checked first with [method is_colliding].
-
-
-
-
-
-
- Return the normal of the surface the body collided with. This is useful to implement sliding along a surface.
-
-
-
-
-
-
- Return the velocity of the body that collided with this one.
-
-
-
-
-
-
- Return the body that collided with this one.
-
-
-
-
-
-
- Return the shape index from the body that collided with this one. If there is no collision, this method will return 0, so collisions must be checked first with [method is_colliding].
-
-
-
-
-
-
- Return the metadata of the shape that collided with this body. If there is no collision, it will return 0, so collisions must be checked first with [method is_colliding]. Additionally, this metadata can not be set with [method Object.set_meta], it must be set with [method Physics2DServer.body_set_shape_metadata].
-
-
@@ -17965,11 +18033,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Set the collision margin for this object. A collision margin is an amount (in pixels) that all shapes will grow when computing collisions, to account for numerical imprecision.
-
-
+
+
+
+
- Return the collision margin for this object.
+ Return true if there would be a collision if the body moved in the given direction.
@@ -17984,13 +18054,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Label is a control that displays formatted text, optionally autowrapping it to the [Control] area. It inherits from range to be able to scroll wrapped text vertically.
-
-
-
-
- Sets the alignment mode to any of the ALIGN_* enumeration values.
-
-
@@ -17998,83 +18061,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the alignment mode (any of the ALIGN_* enumeration values).
-
-
-
-
- Sets the vertical alignment mode to any of the VALIGN_* enumeration values.
-
-
-
-
-
-
- Return the vertical alignment mode (any of the VALIGN_* enumeration values).
-
-
-
-
-
-
- Set the label text. Text can contain newlines.
-
-
-
-
-
-
- Return the label text. Text can contain newlines.
-
-
-
-
-
-
- Set [i]autowrap[/i] mode. When enabled, autowrap will fit text to the control width, breaking sentences when they exceed the available horizontal space. When disabled, the label minimum width becomes the width of the longest row, and the minimum height large enough to fit all rows.
-
-
-
-
-
-
- Return the state of the [i]autowrap[/i] mode (see [method set_autowrap]).
-
-
-
-
-
-
- Cuts off the rest of the text if it is too wide.
-
-
-
-
-
-
- Return true if text would be cut off if it is too wide.
-
-
-
-
-
-
- Display text in all capitals.
-
-
-
-
-
-
- Return true if text is displayed in all capitals.
-
-
-
-
-
-
- Return the height of a line.
-
-
@@ -18082,46 +18068,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the amount of lines.
-
+
- Return the total length of the text.
-
-
-
-
-
-
- Restricts the number of characters to display. Set to -1 to disable.
-
-
-
-
-
-
- Return the restricted number of characters to display. Returns -1 if unrestricted.
-
-
-
-
-
-
- Restricts the number of characters to display (as a percentage of the total text).
-
-
-
-
-
-
- Return the restricted number of characters to display (as a percentage of the total text).
-
-
-
-
-
-
- Sets the number of lines to skip before displaying. Useful for scrolling text.
+ Return the height of a line.
@@ -18131,6 +18082,97 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the the number of lines to skipped before displaying.
+
+
+
+
+ Return the restricted number of lines to display. Returns -1 if unrestricted.
+
+
+
+
+
+
+ Return the restricted number of characters to display (as a percentage of the total text).
+
+
+
+
+
+
+ Return the label text. Text can contain newlines.
+
+
+
+
+
+
+ Return the total length of the text.
+
+
+
+
+
+
+ Return the vertical alignment mode (any of the VALIGN_* enumeration values).
+
+
+
+
+
+
+ Return the restricted number of characters to display. Returns -1 if unrestricted.
+
+
+
+
+
+
+ Return the state of the [i]autowrap[/i] mode (see [method set_autowrap]).
+
+
+
+
+
+
+ Return true if text would be cut off if it is too wide.
+
+
+
+
+
+
+ Return true if text is displayed in all capitals.
+
+
+
+
+
+
+ Sets the alignment mode to any of the ALIGN_* enumeration values.
+
+
+
+
+
+
+ Set [i]autowrap[/i] mode. When enabled, autowrap will fit text to the control width, breaking sentences when they exceed the available horizontal space. When disabled, the label minimum width becomes the width of the longest row, and the minimum height large enough to fit all rows.
+
+
+
+
+
+
+ Cuts off the rest of the text if it is too wide.
+
+
+
+
+
+
+ Sets the number of lines to skip before displaying. Useful for scrolling text.
+
+
@@ -18138,11 +18180,39 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Restricts the number of lines to display. Set to -1 to disable.
-
-
-
+
+
+
- Return the restricted number of lines to display. Returns -1 if unrestricted.
+ Restricts the number of characters to display (as a percentage of the total text).
+
+
+
+
+
+
+ Set the label text. Text can contain newlines.
+
+
+
+
+
+
+ Display text in all capitals.
+
+
+
+
+
+
+ Sets the vertical alignment mode to any of the VALIGN_* enumeration values.
+
+
+
+
+
+
+ Restricts the number of characters to display. Set to -1 to disable.
@@ -18173,19 +18243,19 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
+
-
+
+
+
+
+
+
+
@@ -18209,31 +18279,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Add another [Texture] to this [LargeTexture], starting on offset "ofs".
-
-
-
-
-
-
- Set the offset of the piece with index "idx" to "ofs".
-
-
-
-
-
-
-
-
- Set the [Texture] of the piece with index "idx" to "ofs".
-
-
-
-
-
-
- Set the size of this [LargeTexture].
-
-
Clear the [LargeTexture].
@@ -18264,6 +18309,31 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the [Texture] of the piece with index "idx".
+
+
+
+
+
+
+ Set the offset of the piece with index "idx" to "ofs".
+
+
+
+
+
+
+
+
+ Set the [Texture] of the piece with index "idx" to "ofs".
+
+
+
+
+
+
+ Set the size of this [LargeTexture].
+
+
@@ -18276,14 +18346,26 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Light is the abstract base class for light nodes, so it shouldn't be used directly (It can't be instanced). Other types of light nodes inherit from it. Light contains the common variables and parameters used for lighting.
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -18292,6 +18374,36 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -18300,10 +18412,28 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -18314,92 +18444,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -18408,6 +18460,24 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -18418,55 +18488,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Node that casts light in a 2D environment. Light is defined by a (usually grayscale) texture, a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related). Note that Light2D can be used as a mask.
-
-
-
-
- Switches the Light2D on or off, depending on the 'enabled' parameter.
-
-
-
-
-
-
- Return true if the Light2D is enabled, false if it is not.
-
-
-
-
-
-
- Set the texture of the Light2D.
-
-
-
-
-
-
- Return the texture of the Light2D.
-
-
-
-
-
-
- Set the offset of the light texture.
-
-
-
-
-
-
- Return the offset of the light texture.
-
-
-
-
-
-
- Set the color of the Light2D.
-
-
@@ -18474,27 +18495,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the color of the Light2D.
-
-
-
-
- Set the height of the Light2D. Used with 2D normalmapping.
-
-
-
-
-
-
- Return the height of the Light2D. Used with 2D normalmapping.
-
-
-
-
-
-
- Set the energy value of the Light2D. The bigger the value, the stronger the light.
-
-
@@ -18502,81 +18502,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the energy value of the Light2D.
-
-
-
-
- Set the scale value of the light texture.
-
-
-
+
- Return the scale value of the light texture.
-
-
-
-
-
-
- Set the minimum Z value that objects of the scene have to be in order to be affected by the Light2D.
-
-
-
-
-
-
- Get the minimum Z value that objects of the scene have to be in order to be affected by the Light2D.
-
-
-
-
-
-
- Set the maximum Z value that objects of the scene can be in order to be affected by the Light2D.
-
-
-
-
-
-
- Get the maximum Z value that objects of the scene can be in order to be affected by the Light2D.
-
-
-
-
-
-
- Set the minimum layer value of objects of the scene that are affected by the Light2D.
-
-
-
-
-
-
- Get the minimum layer value of objects of the scene that are affected by the Light2D.
-
-
-
-
-
-
- Set the maximum layer value of objects of the scene that are affected by the Light2D.
-
-
-
-
-
-
- Set the maximum layer value of objects of the scene that are affected by the Light2D.
-
-
-
-
-
-
- Set the item mask of the Light2D to 'item_mask' value.
+ Return the height of the Light2D. Used with 2D normalmapping.
@@ -18586,13 +18516,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the item mask of the Light2D.
-
-
-
-
- Set the item shadow mask to 'item_shadow_mask' value.
-
-
@@ -18600,11 +18523,18 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the item shadow mask of the Light2D.
-
-
-
+
+
+
- Set the behaviour mode of the Light2D. Use constants defined in the constants section.
+ Set the maximum layer value of objects of the scene that are affected by the Light2D.
+
+
+
+
+
+
+ Get the minimum layer value of objects of the scene that are affected by the Light2D.
@@ -18614,27 +18544,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the current mode set to the Light2D.
-
-
-
-
- Enable or disable shadows casting from this Light2D according to the 'enabled' parameter.
-
-
-
-
-
-
- Return true if shadow casting is enabled for this Light2D, else return false.
-
-
-
-
-
-
- Set the shadow buffer size.
-
-
@@ -18642,11 +18551,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the shadow buffer size.
-
-
-
+
+
+
- Set the Exponential Shadow Multiplier (ESM) value of the Light2D.
+ Return the color of casted shadows for this Light2D.
@@ -18656,6 +18565,125 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the Exponential Shadow Multiplier (ESM) value of the Light2D.
+
+
+
+
+ Return the texture of the Light2D.
+
+
+
+
+
+
+ Return the offset of the light texture.
+
+
+
+
+
+
+ Return the scale value of the light texture.
+
+
+
+
+
+
+ Get the maximum Z value that objects of the scene can be in order to be affected by the Light2D.
+
+
+
+
+
+
+ Get the minimum Z value that objects of the scene have to be in order to be affected by the Light2D.
+
+
+
+
+
+
+ Return true if the Light2D is enabled, false if it is not.
+
+
+
+
+
+
+ Return true if shadow casting is enabled for this Light2D, else return false.
+
+
+
+
+
+
+ Set the color of the Light2D.
+
+
+
+
+
+
+ Switches the Light2D on or off, depending on the 'enabled' parameter.
+
+
+
+
+
+
+ Set the energy value of the Light2D. The bigger the value, the stronger the light.
+
+
+
+
+
+
+ Set the height of the Light2D. Used with 2D normalmapping.
+
+
+
+
+
+
+ Set the item mask of the Light2D to 'item_mask' value.
+
+
+
+
+
+
+ Set the item shadow mask to 'item_shadow_mask' value.
+
+
+
+
+
+
+ Set the maximum layer value of objects of the scene that are affected by the Light2D.
+
+
+
+
+
+
+ Set the minimum layer value of objects of the scene that are affected by the Light2D.
+
+
+
+
+
+
+ Set the behaviour mode of the Light2D. Use constants defined in the constants section.
+
+
+
+
+
+
+ Set the shadow buffer size.
+
+
@@ -18663,11 +18691,53 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Set the color of casted shadows for this Light2D.
-
-
-
+
+
+
- Return the color of casted shadows for this Light2D.
+ Enable or disable shadows casting from this Light2D according to the 'enabled' parameter.
+
+
+
+
+
+
+ Set the Exponential Shadow Multiplier (ESM) value of the Light2D.
+
+
+
+
+
+
+ Set the texture of the Light2D.
+
+
+
+
+
+
+ Set the offset of the light texture.
+
+
+
+
+
+
+ Set the scale value of the light texture.
+
+
+
+
+
+
+ Set the maximum Z value that objects of the scene can be in order to be affected by the Light2D.
+
+
+
+
+
+
+ Set the minimum Z value that objects of the scene have to be in order to be affected by the Light2D.
@@ -18694,11 +18764,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Occludes light cast by a Light2D, thus casting shadows. The LightOccluder2D must be provided with a shape (see OccluderPolygon2D) that allows the shadow to be computed. This shape affects the resulting shadow, while the shape of the representating asset shadowed does not actually affect shadows.
-
-
-
+
+
+
- Set the OccluderPolygon2D that defines the LightOccluder2D.
+ Return the light mask of the LightOccluder2D.
@@ -18715,11 +18785,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Set the LightOccluder2D light mask. The LightOccluder2D will cast shadows only from Light2Ds that belong to the same light mask(s).
-
-
-
+
+
+
- Return the light mask of the LightOccluder2D.
+ Set the OccluderPolygon2D that defines the LightOccluder2D.
@@ -18734,16 +18804,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
LineEdit provides a single line string editor, used for text fields.
-
-
+
+
-
-
-
-
-
-
+ Append text at cursor, scrolling the [LineEdit] when needed.
@@ -18751,30 +18816,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Clear the [LineEdit] text.
-
-
- Select the whole string.
-
-
-
-
-
-
- Set the text in the [LineEdit], clearing the existing one and the selection.
-
-
-
-
+
+
- Return the text in the [LineEdit].
-
-
-
-
-
-
- Set the cursor position inside the [LineEdit], causing it to scroll if needed.
@@ -18784,13 +18829,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the cursor position inside the [LineEdit].
-
-
-
-
- Set the maximum amount of characters the [LineEdit] can edit, and cropping existing text in case it exceeds that limit. Setting 0 removes the limit.
-
-
@@ -18798,18 +18836,17 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the maximum amount of characters the [LineEdit] can edit. If 0 is returned, no limit exists.
-
-
-
+
+
+
- Append text at cursor, scrolling the [LineEdit] when needed.
-
-
-
+
+
+
- Set the [i]editable[/i] status of the [LineEdit]. When disabled, existing text can't be modified and new text can't be added.
+ Return the text in the [LineEdit].
@@ -18819,13 +18856,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the [i]editable[/i] status of the [LineEdit] (see [method set_editable]).
-
-
-
-
- Set the [i]secret[/i] status of the [LineEdit]. When enabled, every character is displayed as "*".
-
-
@@ -18833,6 +18863,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the [i]secret[/i] status of the [LineEdit] (see [method set_secret]).
+
+
+
+
+
+
@@ -18841,27 +18877,54 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
+
+
+ Select the whole string.
+
+
+
+
-
-
-
+
+
+
+ Set the cursor position inside the [LineEdit], causing it to scroll if needed.
+
+
+
+
+
+
+ Set the [i]editable[/i] status of the [LineEdit]. When disabled, existing text can't be modified and new text can't be added.
+
+
+
+
+
+
+ Set the maximum amount of characters the [LineEdit] can edit, and cropping existing text in case it exceeds that limit. Setting 0 removes the limit.
+
+
+
+
+
+
+ Set the [i]secret[/i] status of the [LineEdit]. When enabled, every character is displayed as "*".
+
+
+
+
+
+
+ Set the text in the [LineEdit], clearing the existing one and the selection.
-
-
-
-
- This signal is emitted when the user presses KEY_ENTER on the [LineEdit]. This signal is often used as an alternate confirmation mechanism in dialogs.
-
-
@@ -18869,6 +18932,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
When the text changes, this signal is emitted.
+
+
+
+
+ This signal is emitted when the user presses KEY_ENTER on the [LineEdit]. This signal is often used as an alternate confirmation mechanism in dialogs.
+
+
@@ -18895,24 +18965,24 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
@@ -18923,11 +18993,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Line shape for 2D collision objects. It works like a 2D plane and will not allow any body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame.
-
-
-
+
+
+
- Set the line normal.
+ Return the line distance from the origin.
@@ -18944,11 +19014,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Set the line distance from the origin.
-
-
-
+
+
+
- Return the line distance from the origin.
+ Set the line normal.
@@ -18963,13 +19033,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
This kind of buttons are primarily used when the interaction with the button causes a context change (like linking to a web page).
-
-
-
-
- Sets the text of the button.
-
-
@@ -18977,13 +19040,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Returns the text of the button.
-
-
-
-
- Sets the underline mode for this button, the argument must be one of the [LinkButton] constants (see constants section).
-
-
@@ -18991,6 +19047,20 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Returns the underline mode for this button.
+
+
+
+
+ Sets the text of the button.
+
+
+
+
+
+
+ Sets the underline mode for this button, the argument must be one of the [LinkButton] constants (see constants section).
+
+
@@ -19001,7 +19071,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
@@ -19009,7 +19079,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
@@ -19019,11 +19089,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
-
+
+
+
@@ -19033,9 +19105,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
@@ -19091,6 +19161,22 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -19103,10 +19189,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
@@ -19115,18 +19197,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
@@ -19157,13 +19227,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
-
+
+
+
@@ -19173,10 +19243,18 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
+
+
+
+
+
+
+
+
-
+
@@ -19197,14 +19275,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
@@ -19213,10 +19283,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
-
+
@@ -19233,13 +19303,17 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Material is a base [Resource] used for coloring and shading geometry. All materials inherit from it and almost all [VisualInstance] derived nodes carry a Material. A few flags and parameters are shared between all material types and are configured here.
-
-
-
-
-
+
+
+
+
+ Return blend mode for the material, which can be one of BLEND_MODE_MIX (default), BLEND_MODE_ADD, BLEND_MODE_SUB. Keep in mind that only BLEND_MODE_MIX ensures that the material [i]may[/i] be opaque, any other blend mode will render with alpha blending enabled in raster-based [VisualServer] implementations.
+
+
+
+
+
- Set a [Material] flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list.
@@ -19251,6 +19325,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return a [Material] flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list.
+
+
+
+
+ Return the line width for geometry drawn with FLAG_WIREFRAME enabled, or LINE primitives. Note that not all hardware or VisualServer backends support this (like DirectX).
+
+
@@ -19258,11 +19339,19 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Set blend mode for the material, which can be one of BLEND_MODE_MIX (default), BLEND_MODE_ADD, BLEND_MODE_SUB. Keep in mind that only BLEND_MODE_MIX ensures that the material [i]may[/i] be opaque, any other blend mode will render with alpha blending enabled in raster-based [VisualServer] implementations.
-
-
-
+
+
+
- Return blend mode for the material, which can be one of BLEND_MODE_MIX (default), BLEND_MODE_ADD, BLEND_MODE_SUB. Keep in mind that only BLEND_MODE_MIX ensures that the material [i]may[/i] be opaque, any other blend mode will render with alpha blending enabled in raster-based [VisualServer] implementations.
+
+
+
+
+
+
+
+
+ Set a [Material] flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list.
@@ -19272,27 +19361,29 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Set the line width for geometry drawn with FLAG_WIREFRAME enabled, or LINE primitives. Note that not all hardware or VisualServer backends support this (like DirectX).
-
-
-
-
- Return the line width for geometry drawn with FLAG_WIREFRAME enabled, or LINE primitives. Note that not all hardware or VisualServer backends support this (like DirectX).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ Use the regular alpha blending equation (source and dest colors are faded) (default).
+
+
+ Use additive blending equation, often used for particle effects such as fire or light decals.
+
+
+ Use subtractive blending equation, often used for some smoke effects or types of glass.
+
+
+
+
+
+
+
+
+
+
+
+
+
Geometry is visible when this flag is enabled (default).
@@ -19314,27 +19405,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Maximum amount of flags.
-
-
-
-
-
-
-
-
-
- Use the regular alpha blending equation (source and dest colors are faded) (default).
-
-
- Use additive blending equation, often used for particle effects such as fire or light decals.
-
-
- Use subtractive blending equation, often used for some smoke effects or types of glass.
-
-
-
-
-
@@ -19365,6 +19435,39 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z. Can also be accessed as array of 3D vectors. Almost always used as orthogonal basis for a [Transform].
+
+
+
+
+
+
+ Create a matrix from a quaternion.
+
+
+
+
+
+
+
+
+
+
+ Create a matrix from an axis vector and an angle.
+
+
+
+
+
+
+
+
+
+
+
+
+ Create a matrix from 3 axis vectors.
+
+
@@ -19477,39 +19580,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return a vector transformed by the transposed matrix and return it.
-
-
-
-
-
-
-
-
-
-
- Create a matrix from 3 axis vectors.
-
-
-
-
-
-
-
-
-
-
- Create a matrix from an axis vector and an angle.
-
-
-
-
-
-
-
-
- Create a matrix from a quaternion.
-
-
@@ -19530,6 +19600,36 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
3x2 Matrix for 2D transforms.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -19632,44 +19732,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-
@@ -19699,28 +19769,28 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
-
+
+
+
+
+
-
-
-
-
-
-
-
+
+
+
@@ -19737,36 +19807,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -19782,6 +19822,40 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
The format of a surface determines which arrays it will allocate and hold, so "format" is a combination of ARRAY_FORMAT_* mask constants ORed together. ARRAY_FORMAT_VERTEX must be always present. "array_len" determines the amount of vertices in the array (not primitives!). if ARRAY_FORMAT_INDEX is in the format mask, then it means that an index array will be allocated and "index_array_len" must be passed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -19789,87 +19863,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the amount of surfaces that the [Mesh] holds.
-
-
-
-
- Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down.
-
-
-
-
-
-
-
-
- Return the length in vertices of the vertex array in the requested surface (see [method add_surface]).
-
-
-
-
-
-
-
-
- Return the length in indices of the index array in the requested surface (see [method add_surface]).
-
-
-
-
-
-
-
-
- Return the format mask of the requested surface (see [method add_surface]).
-
-
-
-
-
-
-
-
- Return the primitive type of the requested surface (see [method add_surface]).
-
-
-
-
-
-
-
-
- Set a [Material] for a given surface. Surface will be rendered using this material.
-
-
-
-
-
-
-
-
- Return a [Material] in a given surface. Surface is rendered using this material.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -19880,73 +19873,150 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
+
+
+
+
+
+
+
+
+
+
+
+ Return the length in indices of the index array in the requested surface (see [method add_surface]).
+
+
+
+
+
+
+
+
+ Return the length in vertices of the vertex array in the requested surface (see [method add_surface]).
+
+
+
+
+
+
+
+
+ Return the format mask of the requested surface (see [method add_surface]).
+
+
+
+
+
+
+
+
+ Return a [Material] in a given surface. Surface is rendered using this material.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return the primitive type of the requested surface (see [method add_surface]).
+
+
+
+
+
+
+ Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down.
+
+
+
+
+
+
+
+
+ Set a [Material] for a given surface. Surface will be rendered using this material.
+
+
+
+
+
+
+
-
- Default value used for index_array_len when no indices are present.
-
-
- Amount of weights/bone indices per vertex (always 4).
-
Vertex array (array of [Vector3] vertices).
+
+ Array format will include vertices (mandatory).
+
Normal array (array of [Vector3] normals).
+
+ Array format will include bone weights.
+
+
+ Array format will include UVs.
+
+
+ Array format will include normals
+
Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1.
+
+ Index array will be used.
+
Vertex array (array of [Color] colors).
+
+ Array format will include another set of UVs.
+
+
+ Array format will include tangents
+
UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)).
+
+ Amount of weights/bone indices per vertex (always 4).
+
Second UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)).
Array of bone indices, as a float array. Each element in groups of 4 floats.
+
+ Array format will include bone indices.
+
Array of bone weights, as a float array. Each element in groups of 4 floats.
-
- Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size.
-
-
- Array format will include vertices (mandatory).
-
-
- Array format will include normals
-
-
- Array format will include tangents
-
Array format will include a color array.
-
- Array format will include UVs.
+
+ Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size.
-
- Array format will include another set of UVs.
-
-
- Array format will include bone indices.
-
-
- Array format will include bone weights.
-
-
- Index array will be used.
+
+ Default value used for index_array_len when no indices are present.
Render array as points (one vertex equals one point).
@@ -19981,6 +20051,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+
+
+
+
@@ -19991,10 +20069,72 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -20005,32 +20145,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -20039,94 +20159,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -20135,33 +20167,17 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
+
+
+
@@ -20181,18 +20197,46 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -20207,32 +20251,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -20241,29 +20259,81 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -20279,30 +20349,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
MeshInstance is a [Node] that takes a [Mesh] resource and adds it to the current scenario by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a single [Mesh] in many places. This allows to reuse geometry and save on resources. When a [Mesh] has to be instanced more than thousands of times at close proximity, consider using a [MultiMesh] in a [MultiMeshInstance] instead.
-
-
-
-
- Set the [Mesh] resource for the instance.
-
-
-
-
-
-
- Return the current [Mesh] resource for the instance.
-
-
-
-
-
+
-
-
-
+
+ This helper creates a [StaticBody] child [Node] using the mesh geometry as collision. It's mainly used for testing.
@@ -20312,12 +20365,29 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the AABB of the mesh, in local coordinates.
-
+
+
+
- This helper creates a [StaticBody] child [Node] using the mesh geometry as collision. It's mainly used for testing.
+ Return the current [Mesh] resource for the instance.
-
+
+
+
+
+
+
+
+
+
+
+ Set the [Mesh] resource for the instance.
+
+
+
+
+
@@ -20333,6 +20403,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Library of meshes. Contains a list of [Mesh] resources, each with name and ID. Useful for GridMap or painting Terrain.
+
+
+ Clear the library.
+
+
@@ -20340,47 +20415,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Create a new item in the library, supplied an id.
-
-
-
-
-
-
- Set the name of the item.
-
-
-
-
-
-
-
-
- Set the mesh of the item.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-
- Return the name of the item.
+ Return the list of items.
@@ -20392,6 +20431,15 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the mesh of the item.
+
+
+
+
+
+
+ Return the name of the item.
+
+
@@ -20408,6 +20456,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+ Get an unused id for a new item.
+
+
@@ -20415,23 +20470,38 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Remove the item.
-
+
+
+
+
+
- Clear the library.
+ Set the mesh of the item.
-
-
-
+
+
+
+
+
- Return the list of items.
+ Set the name of the item.
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
- Get an unused id for a new item.
@@ -20449,59 +20519,16 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Since instances may have any behavior, the AABB used for visibility must be provided by the user, or generated with [method generate_aabb].
-
-
-
+
- Set the [Mesh] resource to be drawn in multiple instances.
+ Generate a new visibility AABB, using mesh AABB and instance transforms. Since instance information is stored in the [VisualServer], this function is VERY SLOW and must NOT be used often.
-
-
+
+
- Return the [Mesh] resource drawn as multiple instances.
-
-
-
-
-
-
- Set the amount of instances that is going to be drawn. Changing this number will erase all the existing instance transform and color data.
-
-
-
-
-
-
- Return the amount of instances that is going to be drawn.
-
-
-
-
-
-
-
-
- Set the transform for a specific instance.
-
-
-
-
-
-
-
-
- Return the transform of a specific instance.
-
-
-
-
-
-
-
-
- Set the color of a specific instance.
+ Return the visibility AABB.
@@ -20513,6 +20540,29 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Get the color of a specific instance.
+
+
+
+
+ Return the amount of instances that is going to be drawn.
+
+
+
+
+
+
+
+
+ Return the transform of a specific instance.
+
+
+
+
+
+
+ Return the [Mesh] resource drawn as multiple instances.
+
+
@@ -20520,16 +20570,36 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Set the visibility AABB. If not provided, MultiMesh will not be visible.
-
-
-
+
+
+
+
+
- Return the visibility AABB.
+ Set the color of a specific instance.
-
+
+
+
- Generate a new visibility AABB, using mesh AABB and instance transforms. Since instance information is stored in the [VisualServer], this function is VERY SLOW and must NOT be used often.
+ Set the amount of instances that is going to be drawn. Changing this number will erase all the existing instance transform and color data.
+
+
+
+
+
+
+
+
+ Set the transform for a specific instance.
+
+
+
+
+
+
+ Set the [Mesh] resource to be drawn in multiple instances.
@@ -20544,13 +20614,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
MultiMeshInstance is a [Node] that takes a [MultiMesh] resource and adds it to the current scenario by creating an instance of it (yes, this is an instance of instances).
-
-
-
-
- Set the [MultiMesh] to be instance.
-
-
@@ -20558,6 +20621,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the [MultiMesh] that is used for instancing.
+
+
+
+
+ Set the [MultiMesh] to be instance.
+
+
@@ -20597,56 +20667,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -20671,8 +20691,26 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -20683,6 +20721,38 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -20693,44 +20763,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -20747,6 +20779,44 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -20757,27 +20827,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -20789,7 +20845,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -20803,14 +20873,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
+
+
-
-
+
+
@@ -20821,9 +20891,9 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
+
+
@@ -20837,42 +20907,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -20887,17 +20921,17 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
+
+
-
-
-
-
-
+
+
+
+
+
@@ -20909,17 +20943,53 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
-
+
+
+
@@ -20933,14 +21003,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
+
+
-
-
+
+
@@ -20951,9 +21021,9 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
+
+
@@ -20968,157 +21038,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -21130,7 +21050,157 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -21203,20 +21273,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Called when any key input happens that was not handled by something else.
-
-
-
-
- Set the name of the [Node]. Name must be unique within parent, and setting an already existing name will cause for the node to be automatically renamed.
-
-
-
-
-
-
- Return the name of the [Node]. Name is be unique within parent.
-
-
@@ -21227,11 +21283,50 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
The optional boolean argument enforces creating child node with human-readable names, based on the name of node being instanced instead of its type only.
-
-
+
+
+
+
- Remove a child [Node]. Node is NOT deleted and will have to be deleted manually.
+ Add a node to a group. Groups are helpers to name and organize group of nodes, like for example: "Enemies", "Collectables", etc. A [Node] can be in any number of groups. Nodes can be assigned a group at any time, but will not be added to it until they are inside the scene tree (see [method is_inside_tree]).
+
+
+
+
+
+
+ Return true if the node can process.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Find a descendant of this node whose name matches [code]mask[/code] as in [method String.match] (i.e. case sensitive, but '*' matches zero or more characters and '?' matches any single character except '.'). Note that it does not match against the full path, just against individual node names.
+
+
+
+
+
+
+
+
+ Return a children node by it's index (see [method get_child_count]). This method is often used for iterating all children of a node.
@@ -21247,21 +21342,38 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
+
+
-
-
- Return a children node by it's index (see [method get_child_count]). This method is often used for iterating all children of a node.
+ Return a filename that may be containedA node can contained by the node. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded (see [method set_filename]).
-
-
+
+
-
-
+ Return the time elapsed since the last fixed frame. This is always the same in fixed processing unless the frames per second is changed in [OS].
+
+
+
+
+
+
+
+
+
+
+
+
+ Get the node index in the parent (assuming it has a parent).
+
+
+
+
+
+
+ Return the name of the [Node]. Name is be unique within parent.
@@ -21288,34 +21400,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
- get_node("/root/MyGame")
-
-
-
-
- Return the parent [Node] of the current [Node], or an empty Object if the node lacks a parent.
-
-
-
-
-
-
-
-
-
-
-
-
- Find a descendant of this node whose name matches [code]mask[/code] as in [method String.match] (i.e. case sensitive, but '*' matches zero or more characters and '?' matches any single character except '.'). Note that it does not match against the full path, just against individual node names.
-
-
-
-
-
-
-
-
-
-
@@ -21324,28 +21408,18 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
+
+
+ Get the node owner (see [method set_owner]).
-
-
+
+
-
-
- Return [i]true[/i] if the "node" argument is a direct or indirect child of the current node, otherwise return [i]false[/i].
-
-
-
-
-
-
-
-
- Return [i]true[/i] if "node" occurs later in the scene hierarchy than the current node, otherwise return [i]false[/i].
+ Return the parent [Node] of the current [Node], or an empty Object if the node lacks a parent.
@@ -21364,20 +21438,82 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the relative path from the current node to the specified node in "node" argument. Both nodes must be in the same scene, or else the function will fail.
-
-
-
-
-
+
+
+
- Add a node to a group. Groups are helpers to name and organize group of nodes, like for example: "Enemies", "Collectables", etc. A [Node] can be in any number of groups. Nodes can be assigned a group at any time, but will not be added to it until they are inside the scene tree (see [method is_inside_tree]).
-
-
+
+
+
+
+
+
+
+
+
+
+ Return the time elapsed (in seconds) since the last process callback. This is almost always different each time.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Remove a node from a group.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return [i]true[/i] if the "node" argument is a direct or indirect child of the current node, otherwise return [i]false[/i].
+
+
+
+
+
+
+ Return true if fixed processing is enabled (see [method set_fixed_process]).
+
+
+
+
+
+
+
+
+ Return [i]true[/i] if "node" occurs later in the scene hierarchy than the current node, otherwise return [i]false[/i].
@@ -21388,6 +21524,39 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+
+
+
+
+
+
+ Return whether processing is enabled in the current node (see [method set_process]).
+
+
+
+
+
+
+ Return true if the node is processing input (see [method set_process_input]).
+
+
+
+
+
+
+ Return true if the node is processing unhandled input (see [method set_process_unhandled_input]).
+
+
+
+
+
+
+
+
@@ -21397,62 +21566,15 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Move a child node to a different position (order) amongst the other children. Since calls, signals, etc are performed by tree order, changing the order of children nodes may be useful.
-
-
-
+
-
-
- Move this node to the top of the array of nodes of the parent node. This is often useful on GUIs ([Control]), because their order of drawing fully depends on their order in the tree.
-
-
-
-
-
-
- Set the node owner. A node can have any other node as owner (as long as a valid parent, grandparent, etc ascending in the tree). When saving a node (using SceneSaver) all the nodes it owns will be saved with it. This allows to create complex SceneTrees, with instancing and subinstancing.
-
-
-
-
-
-
- Get the node owner (see [method set_owner]).
-
-
-
-
- Remove a node and set all its children as children of the parent node (if exists). All even subscriptions that pass by the removed node will be unsubscribed.
-
-
-
-
-
-
- Get the node index in the parent (assuming it has a parent).
-
-
Print the scene to stdout. Used mainly for debugging purposes.
-
-
-
-
- A node can contain a filename. This filename should not be changed by the user, unless writing editors and tools. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded.
-
-
-
-
-
-
- Return a filename that may be containedA node can contained by the node. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded (see [method set_filename]).
-
-
@@ -21460,129 +21582,32 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Notify the current node and all its children recursively by calling notification() in all of them.
-
-
+
+
+
+
+
+
+ Move this node to the top of the array of nodes of the parent node. This is often useful on GUIs ([Control]), because their order of drawing fully depends on their order in the tree.
+
+
+
+
+ Remove a node and set all its children as children of the parent node (if exists). All even subscriptions that pass by the removed node will be unsubscribed.
+
+
+
+
- Enables or disables node fixed framerate processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS at a fixed (usually 60 fps, check [OS] to change that) interval (and the [method _fixed_process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_fixed_process_delta_time].
+ Remove a child [Node]. Node is NOT deleted and will have to be deleted manually.
-
-
-
-
- Return the time elapsed since the last fixed frame. This is always the same in fixed processing unless the frames per second is changed in [OS].
-
-
-
-
-
-
- Return true if fixed processing is enabled (see [method set_fixed_process]).
-
-
-
-
-
-
- Enables or disables node processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the [method _process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_process_delta_time].
-
-
-
-
-
-
- Return the time elapsed (in seconds) since the last process callback. This is almost always different each time.
-
-
-
-
-
-
- Return whether processing is enabled in the current node (see [method set_process]).
-
-
-
-
-
-
- Enable input processing for node. This is not required for GUI controls! It hooks up the node to receive all input (see [method _input]).
-
-
-
-
-
-
- Return true if the node is processing input (see [method set_process_input]).
-
-
-
-
-
-
- Enable unhandled input processing for node. This is not required for GUI controls! It hooks up the node to receive all input that was not previously handled before (usually by a [Control]). (see [method _unhandled_input]).
-
-
-
-
-
-
- Return true if the node is processing unhandled input (see [method set_process_unhandled_input]).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Return true if the node can process.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+ Remove a node from a group.
@@ -21594,35 +21619,75 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost.
+
+
+
+
+ A node can contain a filename. This filename should not be changed by the user, unless writing editors and tools. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded.
+
+
+
+
+
+
+ Enables or disables node fixed framerate processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS at a fixed (usually 60 fps, check [OS] to change that) interval (and the [method _fixed_process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_fixed_process_delta_time].
+
+
+
+
+
+
+ Set the name of the [Node]. Name must be unique within parent, and setting an already existing name will cause for the node to be automatically renamed.
+
+
+
+
+
+
+ Set the node owner. A node can have any other node as owner (as long as a valid parent, grandparent, etc ascending in the tree). When saving a node (using SceneSaver) all the nodes it owns will be saved with it. This allows to create complex SceneTrees, with instancing and subinstancing.
+
+
+
+
+
+
+
+
+
+
+
+
+ Enables or disables node processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the [method _process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_process_delta_time].
+
+
+
+
+
+
+ Enable input processing for node. This is not required for GUI controls! It hooks up the node to receive all input (see [method _input]).
+
+
+
+
+
+
+ Enable unhandled input processing for node. This is not required for GUI controls! It hooks up the node to receive all input that was not previously handled before (usually by a [Control]). (see [method _unhandled_input]).
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Emitted when the node is renamed.
-
-
@@ -21631,6 +21696,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+ Emitted when the node is renamed.
+
+
@@ -21641,6 +21711,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
@@ -21652,10 +21726,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Notification received when a node is unparented (parent removed it from the list of children).
-
-
-
-
@@ -21678,6 +21748,139 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Base node for 2D system. Node2D contains a position, rotation and scale, which is used to position and animate. It can alternatively be used with a custom 2D transform ([Matrix32]). A tree of Node2Ds allows complex hierarchies for animation and positioning.
+
+
+
+
+ Set the pivot position of the 2D node to 'pivot' value. This method is implemented only in some nodes that inherit Node2D.
+
+
+
+
+
+
+
+
+ Return the rotation angle in radians needed for the 2d node to point at 'point' position.
+
+
+
+
+
+
+ Return the global position of the 2D node.
+
+
+
+
+
+
+ Return the position of the 2D node.
+
+
+
+
+
+
+
+
+ Return the transform [Matrix32] calculated relatively to the parent of this 2D node.
+
+
+
+
+
+
+ Return the rotation of the 2D node.
+
+
+
+
+
+
+
+
+
+
+
+
+ Return the scale of the 2D node.
+
+
+
+
+
+
+ Return the Z-index of the 2D node.
+
+
+
+
+
+
+ Apply a global translation of 'offset' to the 2D node, starting from its current global position.
+
+
+
+
+
+
+ Return true if the Z-index value of this 2D node is relative to its parent's. Else, return false.
+
+
+
+
+
+
+ Rotate the 2d node so it points at 'point' position.
+
+
+
+
+
+
+
+
+ Apply a local translation on X axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized.
+
+
+
+
+
+
+
+
+ Apply a local translation on Y axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized.
+
+
+
+
+
+
+ Apply a 'radians' rotation to the 2D node, starting from its current rotation.
+
+
+
+
+
+
+ Apply the 'ratio' scale to the 2D node, according to its current scale value.
+
+
+
+
+
+
+ Set the global position of the 2D node to 'pos'.
+
+
+
+
+
+
+ Set the global transform [Matrix32] of the 2D node.
+
+
@@ -21706,93 +21909,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Set the scale of the 2D node.
-
-
-
-
- Return the position of the 2D node.
-
-
-
-
-
-
- Return the rotation of the 2D node.
-
-
-
-
-
-
-
-
-
-
-
-
- Return the scale of the 2D node.
-
-
-
-
-
-
- Apply a 'radians' rotation to the 2D node, starting from its current rotation.
-
-
-
-
-
-
-
-
- Apply a local translation on X axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized.
-
-
-
-
-
-
-
-
- Apply a local translation on Y axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized.
-
-
-
-
-
-
- Apply a local translation of 'offset' to the 2D node, starting from its current local position.
-
-
-
-
-
-
- Apply a global translation of 'offset' to the 2D node, starting from its current global position.
-
-
-
-
-
-
- Apply the 'ratio' scale to the 2D node, according to its current scale value.
-
-
-
-
-
-
- Set the global position of the 2D node to 'pos'.
-
-
-
-
-
-
- Return the global position of the 2D node.
-
-
@@ -21800,29 +21916,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Set the local transform [Matrix32] of the 2D node.
-
-
-
-
- Set the global transform [Matrix32] of the 2D node.
-
-
-
-
-
-
- Rotate the 2d node so it points at 'point' position.
-
-
-
-
-
-
-
-
- Return the rotation angle in radians needed for the 2d node to point at 'point' position.
-
-
@@ -21830,13 +21923,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Set the Z-index value of the 2D node.
-
-
-
-
- Return the Z-index of the 2D node.
-
-
@@ -21844,27 +21930,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Set the Z-index value as relative to the parent node of this 2D node. Thus, if this 2D node's Z-index value is 2 and its parent's effective Z-index is 3, then the effective Z-index value of this 2D node would be 3 + 2 = 5.
-
-
-
-
- Return true if the Z-index value of this 2D node is relative to its parent's. Else, return false.
-
-
-
-
+
+
- Set the pivot position of the 2D node to 'pivot' value. This method is implemented only in some nodes that inherit Node2D.
-
-
-
-
-
-
-
-
- Return the transform [Matrix32] calculated relatively to the parent of this 2D node.
+ Apply a local translation of 'offset' to the 2D node, starting from its current local position.
@@ -21881,6 +21951,15 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
A [NodePath] is made up of a list of node names, a list of "subnode" (resource) names, and the name of a property in the final node or resource.
+
+
+
+
+
+
+ Create a NodePath from a string, e.g. "Path2D/PathFollow2D/Sprite:texture:size". A path is absolute if it starts with a slash. Absolute paths are only valid in the global scene tree, not within individual scenes. In a relative path, [code]"."[/code] and [code]".."[/code] indicate the current node and its parent.
+
+
@@ -21934,15 +22013,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return true if the node path is empty.
-
-
-
-
-
-
- Create a NodePath from a string, e.g. "Path2D/PathFollow2D/Sprite:texture:size". A path is absolute if it starts with a slash. Absolute paths are only valid in the global scene tree, not within individual scenes. In a relative path, [code]"."[/code] and [code]".."[/code] indicate the current node and its parent.
-
-
@@ -21964,11 +22034,80 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-Command Line
-
-
+
+
+
+
- Set clipboard to the OS.
+
+
+
+
+
+
+ Return true if the host OS allows drawing.
+
+
+
+
+
+
+
+
+
+
+
+
+ Delay executing of the current thread by given milliseconds.
+
+
+
+
+
+
+ Delay executing of the current thread by given microseconds.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Execute the binary file in given path, optionally blocking until it returns. A process ID is returned.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -21978,17 +22117,291 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Get clipboard from the host OS.
-
-
-
-
-
-
-
-
+
+
+
+
+ Return the commandline passed to the engine.
+
+
+
+
+
+
+ Returns the current screen index (0 padded).
+
+
+
+
+
+
+
+
+
+
+
+
+ Return the absolute directory path of user data path([user://]).
+
+
+
+
+
+
- Change the video mode.
+ Returns current date as a dictionary of keys: year, month, day, weekday, dst (daylight savings time).
+
+
+
+
+
+
+
+
+ Returns current datetime as a dictionary of keys: year, month, day, weekday, dst (daylight savings time), hour, minute, second.
+
+
+
+
+
+
+
+
+ Get a dictionary of time values when given epoch time.
+ Dictionary Time values will be a union of values from [method get_time] and [method get_date] dictionaries (with the exception of dst = day light standard time, as it cannot be determined from epoch).
+
+
+
+
+
+
+ Return the total amount of dynamic memory used (only works in debug).
+
+
+
+
+
+
+
+
+ Return an environment variable.
+
+
+
+
+
+
+ Return the path to the current engine executable.
+
+
+
+
+
+
+ Return the total amount of frames drawn.
+
+
+
+
+
+
+ Returns the frames per second of the running game.
+
+
+
+
+
+
+
+
+ Return the list of fullscreen modes.
+
+
+
+
+
+
+ Return the amount of fixed iterations per second (for fixed process and physics).
+
+
+
+
+
+
+ Return the host OS locale.
+
+
+
+
+
+
+ Return the main loop object (see [MainLoop]).
+
+
+
+
+
+
+
+
+
+
+
+
+ Return the name of the host OS. Possible values are: "Android", "BlackBerry 10", "Flash", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "WinRT", "X11"
+
+
+
+
+
+
+ Returns the game process ID
+
+
+
+
+
+
+ Returns the number of cores available in the host machine.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the number of displays attached to the host machine
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the current screen orientation, the return value will be one of the SCREEN_ORIENTATION constants in this class.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the dimensions in pixels of the specified screen.
+
+
+
+
+
+
+
+
+
+
+
+
+ Return the max amount of static memory used (only works in debug).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return the amount of time passed in milliseconds since the engine started.
+
+
+
+
+
+
+
+
+ Returns current time as a dictionary of keys: hour, minute, second
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return the current unix timestamp.
+
+
+
+
+
+
+
+
+ Get an epoch time value from a dictionary of time values.
+ [code]datetime[/code] must be populated with the following keys: year, month, day, hour, minute, second.
+ You can pass the output from [method get_datetime_from_unix_time] directly into this function. Daylight savings time (dst), if present, is ignored.
@@ -22000,6 +22413,76 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the current video mode size.
+
+
+
+
+ Returns the window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right.
+
+
+
+
+
+
+ Returns the size of the window (without counting window manager decorations).
+
+
+
+
+
+
+
+
+ Return true if an environment variable exists.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return true if low cpu usage mode is enabled.
+
+
+
+
+
+
+ Returns whether the screen is being kept on or not.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return true if the engine was executed with -v (verbose stdout).
+
+
@@ -22018,93 +22501,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return true if the window is resizable.
-
-
-
-
-
-
- Return the list of fullscreen modes.
-
-
-
-
+
+
- Returns the number of displays attached to the host machine
-
-
-
-
-
-
- Returns the current screen index (0 padded).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns the dimensions in pixels of the specified screen.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns the window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right.
-
-
-
-
-
-
- Sets the position of the window to the specified position (this function could be restricted by the window manager, meaning that there could be some unreachable areas of the screen).
-
-
-
-
-
-
- Returns the size of the window (without counting window manager decorations).
-
-
-
-
-
-
- Sets the window size to the specified size.
-
-
-
-
-
-
- Sets window fullscreen mode to the [i]enabled[/i] argument, [i]enabled[/i] is a toggle for the fullscreen mode, calling the function with [i]enabled[/i] true when the screen is not on fullscreen mode will cause the screen to go to fullscreen mode, calling the function with [i]enabled[/i] false when the screen is in fullscreen mode will cause the window to exit the fullscreen mode.
@@ -22114,25 +22514,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Returns whether the window is in fullscreen mode or not.
-
-
-
-
- Set the window resizable state, if the window is not resizable it will preserve the dimensions specified in the project settings.
-
-
-
+
- Returns whether the window is resizable or not.
-
-
-
-
-
-
- Set whether the window is minimized.
+ Return true if the window is maximized.
@@ -22142,153 +22528,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return true if the window is minimized.
-
-
-
-
- Set the window size to maximized.
-
-
-
+
- Return true if the window is maximized.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Sets the current screen orientation, the argument value must be one of the SCREEN_ORIENTATION constants in this class.
-
-
-
-
-
-
- Returns the current screen orientation, the return value will be one of the SCREEN_ORIENTATION constants in this class.
-
-
-
-
-
-
- Set keep screen on if true, or goes to sleep by device setting if false. (for Android/iOS)
-
-
-
-
-
-
- Returns whether the screen is being kept on or not.
-
-
-
-
-
-
- Set the amount of fixed iterations per second (for fixed process and physics).
-
-
-
-
-
-
- Return the amount of fixed iterations per second (for fixed process and physics).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Speeds up or slows down the physics by changing the delta variable. (delta * time_scale)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Sets the window title to the specified string.
-
-
-
-
-
-
- Set to true to enable the low cpu usage mode. In this mode, the screen only redraws when there are changes, and a considerable sleep time is inserted between frames. This way, editors using the engine UI only use very little cpu.
-
-
-
-
-
-
- Return true if low cpu usage mode is enabled.
-
-
-
-
-
-
- Returns the number of cores available in the host machine.
-
-
-
-
-
-
- Return the path to the current engine executable.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Execute the binary file in given path, optionally blocking until it returns. A process ID is returned.
+ Returns whether the window is resizable or not.
@@ -22300,297 +22544,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Kill a process ID (this method can be used to kill processes that were not spawned by the game).
-
-
-
-
-
-
-
-
-
-
-
-
- Returns the game process ID
-
-
-
-
-
-
-
-
- Return an environment variable.
-
-
-
-
-
-
-
-
- Return true if an environment variable exists.
-
-
-
-
-
-
- Return the name of the host OS. Possible values are: "Android", "BlackBerry 10", "Flash", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "WinRT", "X11"
-
-
-
-
-
-
- Return the commandline passed to the engine.
-
-
-
-
-
-
- Return the main loop object (see [MainLoop]).
-
-
-
-
-
-
-
-
- Returns current datetime as a dictionary of keys: year, month, day, weekday, dst (daylight savings time), hour, minute, second.
-
-
-
-
-
-
-
-
- Returns current date as a dictionary of keys: year, month, day, weekday, dst (daylight savings time).
-
-
-
-
-
-
-
-
- Returns current time as a dictionary of keys: hour, minute, second
-
-
-
-
-
-
-
-
-
-
-
-
- Return the current unix timestamp.
-
-
-
-
-
-
-
-
- Get a dictionary of time values when given epoch time.
- Dictionary Time values will be a union of values from [method get_time] and [method get_date] dictionaries (with the exception of dst = day light standard time, as it cannot be determined from epoch).
-
-
-
-
-
-
-
-
- Get an epoch time value from a dictionary of time values.
- [code]datetime[/code] must be populated with the following keys: year, month, day, hour, minute, second.
- You can pass the output from [method get_datetime_from_unix_time] directly into this function. Daylight savings time (dst), if present, is ignored.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Delay executing of the current thread by given microseconds.
-
-
-
-
-
-
- Delay executing of the current thread by given milliseconds.
-
-
-
-
-
-
- Return the amount of time passed in milliseconds since the engine started.
-
-
-
-
-
-
-
-
-
-
-
-
- Return the host OS locale.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Return true if the host OS allows drawing.
-
-
-
-
-
-
- Return the total amount of frames drawn.
-
-
-
-
-
-
- Return true if the engine was executed with -v (verbose stdout).
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Return the max amount of static memory used (only works in debug).
-
-
-
-
-
-
- Return the total amount of dynamic memory used (only works in debug).
-
-
-
-
-
-
- Return the absolute directory path of user data path([user://]).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns the frames per second of the running game.
-
-
-
-
-
-
-
-
-
+
@@ -22608,58 +22568,91 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-
-
-
+
+
+
+
+
+
-
-
-
-
+
+
-
+
+
+
+
+
+
+
+
+
+
+ Set clipboard to the OS.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Set the amount of fixed iterations per second (for fixed process and physics).
+
+
+
+ Set keep screen on if true, or goes to sleep by device setting if false. (for Android/iOS)
-
-
+
+
-
+
+ Set to true to enable the low cpu usage mode. In this mode, the screen only redraws when there are changes, and a considerable sleep time is inserted between frames. This way, editors using the engine UI only use very little cpu.
+
+
+
+
+
+
+ Sets the current screen orientation, the argument value must be one of the SCREEN_ORIENTATION constants in this class.
+
+
+
+
@@ -22672,15 +22665,92 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+ Speeds up or slows down the physics by changing the delta variable. (delta * time_scale)
+
+
+
+
+
+
+
+
-
-
+
+
+
+
+
+
+
+
+
+
+ Change the video mode.
+
+
+
+
+
+
+ Sets window fullscreen mode to the [i]enabled[/i] argument, [i]enabled[/i] is a toggle for the fullscreen mode, calling the function with [i]enabled[/i] true when the screen is not on fullscreen mode will cause the screen to go to fullscreen mode, calling the function with [i]enabled[/i] false when the screen is in fullscreen mode will cause the window to exit the fullscreen mode.
+
+
+
+
+
+
+ Set the window size to maximized.
+
+
+
+
+
+
+ Set whether the window is minimized.
+
+
+
+
+
+
+ Sets the position of the window to the specified position (this function could be restricted by the window manager, meaning that there could be some unreachable areas of the screen).
+
+
+
+
+
+
+ Set the window resizable state, if the window is not resizable it will preserve the dimensions specified in the project settings.
+
+
+
+
+
+
+ Sets the window size to the specified size.
+
+
+
+
+
+
+ Sets the window title to the specified string.
+
+
+
+
+
+
@@ -22702,6 +22772,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+
+
@@ -22718,12 +22794,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
@@ -22768,6 +22838,15 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Objects also receive notifications ([method _notification]). Notifications are a simple way to notify the object about simple events, so they can all be handled together.
+
+
+
+
+
+
+ Deprecated, will go away.
+
+
@@ -22802,117 +22881,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Set a property. Return true if the property was found.
-
-
-
-
-
-
-
-
- Return the type of the object as a string.
-
-
-
-
-
-
-
-
- Check the type of the object against a string (including inheritance).
-
-
-
-
-
-
-
-
- Set property into the object.
-
-
-
-
-
-
- Get a property from the object.
-
-
-
-
-
-
- Return the list of properties as an array of dictionaries, dictionaries contain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Notify the object of something.
-
-
-
-
-
-
- Return the instance ID. All objects have a unique instance ID.
-
-
-
-
-
-
- Set a script into the object, scripts extend the object functionality.
-
-
-
-
-
-
- Return the object script (or null if it doesn't have one).
-
-
-
-
-
-
-
-
- Set a metadata into the object. Metadata is serialized. Metadata can be [i]anything[/i].
-
-
-
-
-
-
- Return a metadata from the object.
-
-
-
-
-
-
-
-
- Return true if a metadata is found with the requested name.
-
-
-
-
-
-
- Return the list of metadata in the object.
-
-
@@ -22922,31 +22890,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from [@Global Scope] TYPE_*).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Emit a signal. Arguments are passed in an array.
-
-
@@ -23001,27 +22944,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
-
-
-
-
-
-
-
-
-
- Return the list of signals as an array of dictionaries.
-
-
-
-
-
-
-
+ Return true if this object can translate strings.
@@ -23052,6 +22979,129 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Disconnect a signal from a method.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Emit a signal. Arguments are passed in an array.
+
+
+
+
+
+
+
+
+
+
+ Get a property from the object.
+
+
+
+
+
+
+ Return the instance ID. All objects have a unique instance ID.
+
+
+
+
+
+
+ Return a metadata from the object.
+
+
+
+
+
+
+ Return the list of metadata in the object.
+
+
+
+
+
+
+
+
+
+
+
+
+ Return the list of properties as an array of dictionaries, dictionaries contain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals).
+
+
+
+
+
+
+ Return the object script (or null if it doesn't have one).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return the list of signals as an array of dictionaries.
+
+
+
+
+
+
+ Return the type of the object as a string.
+
+
+
+
+
+
+
+
+ Return true if a metadata is found with the requested name.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return true if signal emission blocking is enabled.
+
+
@@ -23065,6 +23115,43 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return true if a connection exists for a given signal and target/method.
+
+
+
+
+
+
+
+
+
+
+
+
+ Check the type of the object against a string (including inheritance).
+
+
+
+
+
+
+
+
+ Notify the object of something.
+
+
+
+
+
+
+
+
+
+
+
+
+ Set property into the object.
+
+
@@ -23072,13 +23159,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
If set to true, signal emission is blocked.
-
-
-
-
- Return true if signal emission blocking is enabled.
-
-
@@ -23086,24 +23166,20 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Set true if this object can translate strings (in calls to tr() ). Default is true.
-
-
-
-
- Return true if this object can translate strings.
-
-
-
-
-
-
-
-
-
-
+
+
+
+
- Deprecated, will go away.
+ Set a metadata into the object. Metadata is serialized. Metadata can be [i]anything[/i].
+
+
+
+
+
+
+ Set a script into the object, scripts extend the object functionality.
@@ -23115,12 +23191,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Translate a message. Only works in message translation is enabled (which is by default). See [method set_message_translation].
-
-
-
-
-
-
@@ -23129,12 +23199,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
- Called right when the object is initialized. Not available in script.
-
-
- Called before the object is about to be deleted.
-
Connect a signal in deferred mode. This way, signal emissions are stored in a queue, then set on idle time.
@@ -23144,6 +23208,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
One short connections disconnect themselves after emission.
+
+ Called right when the object is initialized. Not available in script.
+
+
+ Called before the object is about to be deleted.
+
@@ -23152,9 +23222,15 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
+
+
+
+
+
+
+
+
@@ -23164,30 +23240,24 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
@@ -23218,15 +23288,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
OptionButton is a type button that provides a selectable list of items when pressed. The item selected becomes the "current" item and is displayed as the button text.
-
-
-
-
-
-
- Add an item, with text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end.
-
-
@@ -23238,95 +23299,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Add an item, with a "texture" icon, text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end.
-
-
+
+
-
+
- Set the text of an item at index "idx".
-
-
-
-
-
-
-
-
- Set the icon of an item at index "idx".
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Set the ID of an item at index "idx".
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Return the text of the item at index "idx".
-
-
-
-
-
-
-
-
- Return the icon of the item at index "idx".
-
-
-
-
-
-
-
-
- Return the ID of the item at index "idx".
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Return the amount of items in the OptionButton.
+ Add an item, with text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end.
@@ -23339,11 +23318,44 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Clear all the items in the [OptionButton].
-
+
+
+
- Select an item by index and make it the current item.
+ Return the ID of the item at index "idx".
+
+
+
+
+
+
+ Return the amount of items in the OptionButton.
+
+
+
+
+
+
+
+
+ Return the icon of the item at index "idx".
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return the text of the item at index "idx".
@@ -23363,12 +23375,70 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+
+
+
+
+
+
+
+
+ Select an item by index and make it the current item.
+
+
+
+
+
+
+
+
+ Set the ID of an item at index "idx".
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Set the icon of an item at index "idx".
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Set the text of an item at index "idx".
+
+
@@ -23382,32 +23452,32 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
-
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
+
+
+
@@ -23416,16 +23486,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
@@ -23444,6 +23504,16 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+
+
+
+
+
+
@@ -23513,23 +23583,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
TODO: explain ownership, and that node does not need to own itself
-
-
-
-
-
-
- Pack will ignore any sub-nodes not owned by given node. See [method Node.set_owner].
-
-
-
-
-
-
-
-
-
-
@@ -23542,6 +23595,23 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Pack will ignore any sub-nodes not owned by given node. See [method Node.set_owner].
+
+
@@ -23554,20 +23624,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
PacketPeer is an abstraction and base class for packet-based protocols (such as UDP). It provides an API for sending and receiving packets both as raw data or variables. This makes it easy to transfer data over a protocol, without having to encode data as low level bytes or having to worry about network ordering.
-
-
-
-
- Get a Variant.
-
-
-
+
-
-
- Send a Variant as a packet.
+ Return the number of packets currently available in the ring-buffer.
@@ -23577,6 +23638,20 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Get a raw packet.
+
+
+
+
+ Return the error state of the last packet received (via [method get_packet] and [method get_var]).
+
+
+
+
+
+
+ Get a Variant.
+
+
@@ -23586,18 +23661,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Send a raw packet.
-
-
-
-
- Return the error state of the last packet received (via [method get_packet] and [method get_var]).
-
-
-
+
+
+
- Return the number of packets currently available in the ring-buffer.
+ Send a Variant as a packet.
@@ -23631,6 +23701,39 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
UDP packet peer. Can be used to send raw UDP packets as well as [Variant]s.
+
+
+ Close the UDP socket the [PacketPeerUDP] is currently listening on.
+
+
+
+
+
+
+ Return the address of the remote peer(as a 32bit integer) that sent the last packet(that was received with [method get_packet] or [method get_var]).
+
+
+
+
+
+
+ Return the IP of the remote peer that sent the last packet(that was received with [method get_packet] or [method get_var]).
+
+
+
+
+
+
+ Return the port of the remote peer that sent the last packet(that was received with [method get_packet] or [method get_var]).
+
+
+
+
+
+
+ Return whether this [PacketPeerUDP] is listening.
+
+
@@ -23642,46 +23745,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Make this [PacketPeerUDP] listen on the "port" using a buffer size "recv_buf_size". Listens on all available adresses.
-
-
- Close the UDP socket the [PacketPeerUDP] is currently listening on.
-
-
-
-
-
-
- Wait for a packet to arrive on the listening port, see [method listen].
-
-
-
-
-
-
- Return whether this [PacketPeerUDP] is listening.
-
-
-
-
-
-
- Return the IP of the remote peer that sent the last packet(that was received with [method get_packet] or [method get_var]).
-
-
-
-
-
-
- Return the address of the remote peer(as a 32bit integer) that sent the last packet(that was received with [method get_packet] or [method get_var]).
-
-
-
-
-
-
- Return the port of the remote peer that sent the last packet(that was received with [method get_packet] or [method get_var]).
-
-
@@ -23693,6 +23756,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Set the destination address and port for sending packets and variables, a hostname will be resolved if valid.
+
+
+
+
+ Wait for a packet to arrive on the listening port, see [method listen].
+
+
@@ -23709,10 +23779,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
+
+
@@ -23741,53 +23811,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
A ParallaxBackground will use one or more [ParallaxLayer] nodes to create a parallax scrolling background. Each [ParallaxLayer] can be set to move at different speeds relative to the camera movement, this can be used to create an illusion of depth in a 2D game.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Set the base offset in pixels of all children [ParallaxLayer] nodes.
-
-
-
-
-
-
- Return the base offset.
-
-
-
-
-
-
- Set the base motion scale of all children [ParallaxLayer] nodes.
-
-
-
-
-
-
- Return the base motion scale.
-
-
-
-
-
-
- Set the left and top limits in pixels for scrolling to begin. If the camera is outside of this limit the background will not continue to scroll. If an axis is greater than or equal to the corresponding axis of limit_end, then it will not limit scrolling for that axis.
-
-
@@ -23795,13 +23818,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the beginning limit.
-
-
-
-
- Set the right and bottom limits in pixels for scrolling to end. If the camera is outside of this limit the background will not continue to scroll. If an axis is less than or equal to the corresponding axis of limit_begin, then it will not limit scrolling for that axis.
-
-
@@ -23809,11 +23825,24 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the ending limit.
-
-
-
+
+
+
+
+ Return the base offset.
+
+
+
+
+
+
+ Return the base motion scale.
+
+
+
+
+
- Set to true for all child [ParallaxLayer] nodes to not be affected by the zoom level of the camera.
@@ -23823,6 +23852,47 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return ignoring camera zoom.
+
+
+
+
+ Set to true for all child [ParallaxLayer] nodes to not be affected by the zoom level of the camera.
+
+
+
+
+
+
+ Set the left and top limits in pixels for scrolling to begin. If the camera is outside of this limit the background will not continue to scroll. If an axis is greater than or equal to the corresponding axis of limit_end, then it will not limit scrolling for that axis.
+
+
+
+
+
+
+ Set the right and bottom limits in pixels for scrolling to end. If the camera is outside of this limit the background will not continue to scroll. If an axis is less than or equal to the corresponding axis of limit_begin, then it will not limit scrolling for that axis.
+
+
+
+
+
+
+ Set the base offset in pixels of all children [ParallaxLayer] nodes.
+
+
+
+
+
+
+ Set the base motion scale of all children [ParallaxLayer] nodes.
+
+
+
+
+
+
+
+
@@ -23835,11 +23905,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
A ParallaxLayer must be the child of a [ParallaxBackground] node. All child nodes will be affected by the parallax scrolling of this layer.
-
-
-
+
+
+
- Set the motion scale of the ParallaxLayer. If an axis is set to 0 then it will not move at all, it will stick with the camera.
+ Return the mirroring of the ParallaxLayer.
@@ -23856,11 +23926,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Set the mirroring of the ParallaxLayer. If an axis is set to 0 then that axis will have no mirroring.
-
-
-
+
+
+
- Return the mirroring of the ParallaxLayer.
+ Set the motion scale of the ParallaxLayer. If an axis is set to 0 then it will not move at all, it will stick with the camera.
@@ -23873,63 +23943,63 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -23939,9 +24009,9 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
+
+
@@ -23957,13 +24027,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Particles is a particle system 3D [Node] that is used to simulate several types of particle effects, such as explosions, rain, snow, fireflies, or other magical-like shinny sparkles. Particles are drawn using impostors, and given their dynamic behavior, the user must provide a visibility AABB (although helpers to create one automatically exist).
-
-
-
-
- Set total amount of particles in the system.
-
-
@@ -23971,149 +24034,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the total amount of particles in the system.
-
-
-
-
- Set the "emitting" property state. When emitting, the particle system generates new particles at constant rate.
-
-
-
-
-
-
- Return the "emitting" property state (see [method set_emitting]).
-
-
-
-
-
-
- Set the visibility AABB for the particle system, since the default one will not work properly most of the time.
-
-
-
-
-
-
- Return the current visibility AABB.
-
-
-
-
-
-
- Set the half extents for the emission box.
-
-
-
-
-
-
- Return the half extents for the emission box.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Set the normal vector towards where gravity is pulling (by default, negative Y).
-
-
-
-
-
-
- Return the normal vector towards where gravity is pulling (by default, negative Y).
-
-
-
-
-
-
-
-
- Set a specific variable for the particle system (see VAR_* enum).
-
-
-
-
-
-
-
-
- Return a specific variable for the particle system (see VAR_* enum).
-
-
-
-
-
-
-
-
- Set the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted.
-
-
-
-
-
-
-
-
- Return the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted.
-
-
-
-
-
-
-
-
- Set the position of a color phase (0 to 1).
-
-
-
-
-
-
-
-
- Return the position of a color phase (0 to 1).
-
-
-
-
-
-
-
-
- Set the color of a color phase.
-
-
@@ -24123,23 +24043,37 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the color of a color phase.
-
-
+
+
+
+
- Set the material used to draw particles.
+ Return the position of a color phase (0 to 1).
-
-
+
+
- Return the material used to draw particles.
-
-
-
+
+
+
+
+
+
+
+
+
+
+ Return the half extents for the emission box.
+
+
+
+
+
@@ -24149,10 +24083,43 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
+
+
+
+
+ Return the normal vector towards where gravity is pulling (by default, negative Y).
+
+
+
+
+
+
+ Return the material used to draw particles.
+
+
+
+
+
+
+ Return the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted.
+
+
+
+
+
+
+
+
+ Return a specific variable for the particle system (see VAR_* enum).
+
+
+
+
+
+
+ Return the current visibility AABB.
@@ -24161,10 +24128,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
+
+
+ Return the "emitting" property state (see [method set_emitting]).
@@ -24173,24 +24141,136 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
+
+
+
+
+ Set total amount of particles in the system.
+
+
+
+
+
+
+
+
+ Set the color of a color phase.
+
+
+
+
+
+
+
+
+ Set the position of a color phase (0 to 1).
+
+
-
-
-
+
+
+
+
+
+
+
+ Set the half extents for the emission box.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Set the "emitting" property state. When emitting, the particle system generates new particles at constant rate.
+
+
+
+
+
+
+ Set the normal vector towards where gravity is pulling (by default, negative Y).
+
+
+
+
+
+
+
+
+
+
+
+
+ Set the material used to draw particles.
+
+
+
+
+
+
+
+
+ Set the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Set a specific variable for the particle system (see VAR_* enum).
+
+
+
+
+
+
+ Set the visibility AABB for the particle system, since the default one will not work properly most of the time.
+
+
+
+
+
+
+
+
+
+
+
+
@@ -24205,16 +24285,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
@@ -24225,27 +24295,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Particles2D is a particle system 2D [Node] that is used to simulate several types of particle effects, such as explosions, rain, snow, fireflies, or other magical-like shinny sparkles. Particles are drawn using impostors, and given their dynamic behavior, the user must provide a visibility AABB (although helpers to create one automatically exist).
-
-
-
-
- If this is set to true then the particle emitter will emit particles, if its false it will not.
-
-
-
-
-
-
- Returns whether this emitter is currently emitting or not
-
-
-
-
-
-
- Sets the amount of particles spawned at each emission
-
-
@@ -24253,51 +24302,60 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Returns the amount of particles spawned at each emission
-
-
-
-
- Sets the amount of seconds that each particle will be visible.
-
-
-
-
+
+
- Gets the amount of seconds that each particle will be visible.
+ Returns the tint color for each particle.
-
-
+
+
+
+
- Sets the increment or decrement for the particle lifetime. for example: if the time scale is set to 2, the particles will die and move twice as fast.
-
+
-
- Returns the emitter time scale
-
-
-
-
+
-
-
+
+
-
-
-
+
+
+
- Sets the amount of seconds during which the emitter will spawn particles, after the specified seconds the emitter state will be set to non emitting, so calling [method is_emitting] will return false. If the timeout is 0 the emitter will spawn forever.
+ Returns the [ColorRamp] used to tint each particle
+
+
+
+
+
+
+ Returns the half extents of the emission box.
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the particle spawn origin position relative to the emitter.
@@ -24307,13 +24365,29 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Returns the amount of seconds during which the emitter will spawn particles
-
-
-
-
-
+
+
+
- Sets the value of the specified emitter parameter (see the constants secction for the list of parameters)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Gets the amount of seconds that each particle will be visible.
@@ -24325,13 +24399,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Returns the value of the specified emitter parameter
-
-
-
-
-
+
+
+
- Sets the randomness value of the specified emitter parameter (see the constants secction for the list of parameters), 0 means no randomness, so every particle will have the parameters specified, 1 means that the parameter will be choosen at random, the closer the randomness value gets to 0 the more conservative the variation of the parameter will be.
@@ -24343,15 +24414,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Returns the randomness value of the specified emitter parameter
-
-
-
-
-
-
- Sets the texture for each particle
-
-
@@ -24359,54 +24421,24 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Returns the texture for emitted particles
-
-
-
-
- Set the tint color for each particle.
-
-
-
-
+
+
- Returns the tint color for each particle.
+ Returns the emitter time scale
-
-
-
-
-
-
- Sets the [ColorRamp] used to tint each particle. Particle will be tinted according to their lifetimes.
-
-
-
-
+
+
- Returns the [ColorRamp] used to tint each particle
-
-
-
-
- Sets the particle spawn origin position relative to the emitter center. for example if this value is set to (50, 50), the particle will spawn 50 units to the right and 50 units to the bottom of the emitter center.
-
-
-
-
+
+
- Returns the particle spawn origin position relative to the emitter.
-
-
-
-
-
-
+ Returns whether this emitter is currently emitting or not
@@ -24415,100 +24447,18 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Sets the half extents of the emission box, particles will be spawned at random inside this box.
-
-
-
-
-
-
- Returns the half extents of the emission box.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -24519,15 +24469,106 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
+
+
+
+
+ Sets the amount of particles spawned at each emission
+
+
+
+
+
+
+ Set the tint color for each particle.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets the [ColorRamp] used to tint each particle. Particle will be tinted according to their lifetimes.
+
+
+
+
+
+
+ Sets the half extents of the emission box, particles will be spawned at random inside this box.
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets the particle spawn origin position relative to the emitter center. for example if this value is set to (50, 50), the particle will spawn 50 units to the right and 50 units to the bottom of the emitter center.
+
+
+
+
+
+
+ Sets the amount of seconds during which the emitter will spawn particles, after the specified seconds the emitter state will be set to non emitting, so calling [method is_emitting] will return false. If the timeout is 0 the emitter will spawn forever.
+
+
+
+
+
+
+ If this is set to true then the particle emitter will emit particles, if its false it will not.
+
+
+
+
+
+
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
@@ -24537,43 +24578,91 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
+
+
+ Sets the amount of seconds that each particle will be visible.
-
-
+
+
+
+
+
+
+ Sets the value of the specified emitter parameter (see the constants secction for the list of parameters)
+
+
+
+
-
-
-
+
+
+
+
+
+ Sets the randomness value of the specified emitter parameter (see the constants secction for the list of parameters), 0 means no randomness, so every particle will have the parameters specified, 1 means that the parameter will be choosen at random, the closer the randomness value gets to 0 the more conservative the variation of the parameter will be.
-
-
+
+
+
+
+
+
+ Sets the texture for each particle
+
+
+
+
+
+
+ Sets the increment or decrement for the particle lifetime. for example: if the time scale is set to 2, the particles will die and move twice as fast.
+
+
+
+
-
-
-
+
+
+
+
+
Direction in radians at which the particles will be launched, Notice that when the direction is set to 0 the particles will be launched to the negative
+
+ Initial angle in radians at which each particle will be spawned
+
+
+ Initial size of each particle
+
+
+ Final size of each particle, the particle size will interpolate to this value during its lifetime.
+
+
+
+
+
+
+
+
+
Velocity at which the particles will be launched.
@@ -24596,25 +24685,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Amount of damping for each particle
-
- Initial angle in radians at which each particle will be spawned
-
-
- Initial size of each particle
-
-
- Final size of each particle, the particle size will interpolate to this value during its lifetime.
-
-
-
-
-
-
-
-
-
-
-
@@ -24623,38 +24693,18 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -24663,14 +24713,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
+
+
-
-
+
+
@@ -24681,9 +24731,29 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -24699,13 +24769,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
This class is a container/Node-ification of a [Curve3D], so it can have [Spatial] properties and [Node] info.
-
-
-
-
- Sets the [Curve3D].
-
-
@@ -24713,6 +24776,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Returns the [Curve3D] contained.
+
+
+
+
+ Sets the [Curve3D].
+
+
@@ -24725,13 +24795,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
This class is a container/Node-ification of a [Curve2D], so it can have [Node2D] properties and [Node] info.
-
-
-
-
- Sets the [Curve2D].
-
-
@@ -24739,6 +24802,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Returns the [Curve2D] contained.
+
+
+
+
+ Sets the [Curve2D].
+
+
@@ -24752,26 +24822,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be descendants of this node. Then, when setting an offset in this node, the descendant nodes will move accordingly.
-
-
-
-
- Sets the distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path.
-
-
-
-
+
+
- Returns the distance along the path in 3D units.
-
-
-
-
-
-
- Moves this node in the X axis. As this node's position will be set every time its offset is set, this allows many PathFollow to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset.
-A similar effect may be achieved moving the this node's descendants.
+ This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly.
@@ -24781,25 +24836,18 @@ A similar effect may be achieved moving the this node's descendants.
Returns the X displacement this node has from its parent [Path].
-
-
-
-
- Moves this node in the Y axis, for the same reasons of [method set_h_offset].
-
-
-
+
- Returns the Y displacement this node has from its parent [Path].
+ Returns the distance along the path in 3D units.
-
-
-
+
+
+
- Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length.
+ Returns the rotation mode. The constants below list which axes are allowed to rotate for each mode.
@@ -24809,18 +24857,18 @@ A similar effect may be achieved moving the this node's descendants.
Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last).
-
-
-
-
- Allows or forbids rotation on one or more axes, per the constants below.
-
-
-
-
+
+
- Returns the rotation mode. The constants below list which axes are allowed to rotate for each mode.
+ Returns the Y displacement this node has from its parent [Path].
+
+
+
+
+
+
+ Returns whether this node wraps its offsets around, or truncates them to the path ends.
@@ -24832,11 +24880,12 @@ There are two answers to this problem: Either increase the number of cached poin
This method controls whether the position between two cached points is interpolated linearly, or cubicly.
-
-
-
+
+
+
- This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly.
+ Moves this node in the X axis. As this node's position will be set every time its offset is set, this allows many PathFollow to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset.
+A similar effect may be achieved moving the this node's descendants.
@@ -24846,11 +24895,32 @@ This method controls whether the position between two cached points is interpola
If set, any offset outside the path's length (whether set by [method set_offset] or [method set_unit_offset] will wrap around, instead of stopping at the ends. Set it for cyclic paths.
-
-
-
+
+
+
- Returns whether this node wraps its offsets around, or truncates them to the path ends.
+ Sets the distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path.
+
+
+
+
+
+
+ Allows or forbids rotation on one or more axes, per the constants below.
+
+
+
+
+
+
+ Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length.
+
+
+
+
+
+
+ Moves this node in the Y axis, for the same reasons of [method set_h_offset].
@@ -24878,26 +24948,11 @@ This method controls whether the position between two cached points is interpola
It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be descendants of this node. Then, when setting an offset in this node, the descendant nodes will move accordingly.
-
-
-
-
- Sets the distance from the first vertex, measured in pixels along the path. This sets this node's position to a point within the path.
-
-
-
-
+
+
- Returns the distance along the path in pixels.
-
-
-
-
-
-
- Moves this node horizontally. As this node's position will be set every time its offset is set, this allows many PathFollow2D to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset.
-A similar effect may be achieved moving this node's descendants.
+ This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly.
@@ -24907,25 +24962,11 @@ A similar effect may be achieved moving this node's descendants.
Returns the horizontal displacement this node has from its parent [Path2D].
-
-
-
-
- Moves the PathFollow2D vertically, for the same reasons of [method set_h_offset].
-
-
-
+
- Returns the vertical displacement this node has from its parent [Path2D].
-
-
-
-
-
-
- Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length.
+ Returns the distance along the path in pixels.
@@ -24935,11 +24976,18 @@ A similar effect may be achieved moving this node's descendants.
Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last).
-
-
-
+
+
+
- If set, this node rotates to follow the path, making its descendants rotate.
+ Returns the vertical displacement this node has from its parent [Path2D].
+
+
+
+
+
+
+ Returns whether this node wraps its offsets around, or truncates them to the path ends.
@@ -24958,11 +25006,12 @@ There are two answers to this problem: Either increase the number of cached poin
This method controls whether the position between two cached points is interpolated linearly, or cubicly.
-
-
-
+
+
+
- This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly.
+ Moves this node horizontally. As this node's position will be set every time its offset is set, this allows many PathFollow2D to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset.
+A similar effect may be achieved moving this node's descendants.
@@ -24972,11 +25021,32 @@ This method controls whether the position between two cached points is interpola
If set, any offset outside the path's length (whether set by [method set_offset] or [method set_unit_offset] will wrap around, instead of stopping at the ends. Set it for cyclic paths.
-
-
-
+
+
+
- Returns whether this node wraps its offsets around, or truncates them to the path ends.
+ Sets the distance from the first vertex, measured in pixels along the path. This sets this node's position to a point within the path.
+
+
+
+
+
+
+ If set, this node rotates to follow the path, making its descendants rotate.
+
+
+
+
+
+
+ Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length.
+
+
+
+
+
+
+ Moves the PathFollow2D vertically, for the same reasons of [method set_h_offset].
@@ -25002,13 +25072,16 @@ This method controls whether the position between two cached points is interpola
Add a remap from a file to another.
-
-
-
+
+
+ Clear all remaps.
+
+
+
- Return true if a file is being remapped.
+ Erase a remap.
@@ -25020,16 +25093,13 @@ This method controls whether the position between two cached points is interpola
Return the remapped new path of a file.
-
+
+
+
- Erase a remap.
-
-
-
-
- Clear all remaps.
+ Return true if a file is being remapped.
@@ -25052,12 +25122,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
@@ -25068,31 +25132,13 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -25106,7 +25152,31 @@ This method controls whether the position between two cached points is interpola
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -25118,62 +25188,6 @@ This method controls whether the position between two cached points is interpola
Direct access object to a physics body in the [Physics2DServer]. This object is passed via the direct state callback of rigid/character bodies, and is intended for changing the direct state of that body.
-
-
-
-
- Return the total gravity vector being currently applied to this body.
-
-
-
-
-
-
- Return the rate at which the body stops moving, if there are not any other forces moving it.
-
-
-
-
-
-
- Return the rate at which the body stops rotating, if there are not any other forces moving it.
-
-
-
-
-
-
- Return the inverse of the mass of the body.
-
-
-
-
-
-
- Return the inverse of the inertia of the body.
-
-
-
-
-
-
- Change the linear velocity of the body.
-
-
-
-
-
-
- Return the current linear velocity of the body.
-
-
-
-
-
-
- Change the angular velocity of the body.
-
-
@@ -25181,68 +25195,6 @@ This method controls whether the position between two cached points is interpola
Return the angular velocity of the body.
-
-
-
-
- Change the transform matrix of the body.
-
-
-
-
-
-
- Return the transform matrix of the body.
-
-
-
-
-
-
- Set the sleeping state of the body, only affects character/rigid bodies.
-
-
-
-
-
-
- Return true if this body is currently sleeping (not active).
-
-
-
-
-
-
- Return the amount of contacts this body has with other bodies. Note that by default this returns 0 unless bodies are configured to log contacts.
-
-
-
-
-
-
-
-
- Return the local position (of this body) of the contact point.
-
-
-
-
-
-
-
-
- Return the local normal (of this body) of the contact point.
-
-
-
-
-
-
-
-
- Return the local shape index of the collision.
-
-
@@ -25252,15 +25204,6 @@ This method controls whether the position between two cached points is interpola
Return the [RID] of the collider.
-
-
-
-
-
-
- Return the contact position in the collider.
-
-
@@ -25279,6 +25222,15 @@ This method controls whether the position between two cached points is interpola
Return the collider object, this depends on how it was created (will return a scene node if such was used to create it).
+
+
+
+
+
+
+ Return the contact position in the collider.
+
+
@@ -25306,16 +25258,59 @@ This method controls whether the position between two cached points is interpola
Return the linear velocity vector at contact point of the collider.
-
+
+
+
+
+ Return the amount of contacts this body has with other bodies. Note that by default this returns 0 unless bodies are configured to log contacts.
+
+
+
+
+
+
+
+
+ Return the local normal (of this body) of the contact point.
+
+
+
+
+
+
+
+
+ Return the local position (of this body) of the contact point.
+
+
+
+
+
+
+
+
+ Return the local shape index of the collision.
+
+
+
- Return the timestep (delta) used for the simulation.
+ Return the inverse of the inertia of the body.
-
+
+
+
- Call the built-in force integration code.
+ Return the inverse of the mass of the body.
+
+
+
+
+
+
+ Return the current linear velocity of the body.
@@ -25325,6 +25320,81 @@ This method controls whether the position between two cached points is interpola
Return the current state of space, useful for queries.
+
+
+
+
+ Return the timestep (delta) used for the simulation.
+
+
+
+
+
+
+ Return the rate at which the body stops rotating, if there are not any other forces moving it.
+
+
+
+
+
+
+ Return the total gravity vector being currently applied to this body.
+
+
+
+
+
+
+ Return the rate at which the body stops moving, if there are not any other forces moving it.
+
+
+
+
+
+
+ Return the transform matrix of the body.
+
+
+
+
+ Call the built-in force integration code.
+
+
+
+
+
+
+ Return true if this body is currently sleeping (not active).
+
+
+
+
+
+
+ Change the angular velocity of the body.
+
+
+
+
+
+
+ Change the linear velocity of the body.
+
+
+
+
+
+
+ Set the sleeping state of the body, only affects character/rigid bodies.
+
+
+
+
+
+
+ Change the transform matrix of the body.
+
+
@@ -25349,6 +25419,45 @@ This method controls whether the position between two cached points is interpola
Direct access object to a space in the [Physics2DServer]. It's used mainly to do queries against objects and areas residing in a given space.
+
+
+
+
+
+
+ Check whether the shape can travel to a point. If it can, the method will return an array with two floats: The first is the distance the shape can move in that direction without colliding, and the second is the distance at which it will collide.
+ If the shape can not move, the array will be empty.
+
+
+
+
+
+
+
+
+
+
+ Check the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. The resulting array contains a list of points where the shape intersects another. Like with [method intersect_shape], the number of returned results can be limited to save processing time.
+
+
+
+
+
+
+
+
+ Check the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. If it collides with more than a shape, the nearest one is selected. The returned object is a dictionary containing the following fields:
+ pointo: Place where the shapes intersect.
+ normal: Normal of the object at the point where the shapes intersect.
+ shape: Shape index within the object against which the shape intersected.
+ metadata: Metadata of the shape against which the shape intersected. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data].
+ collider_id: Id of the object against which the shape intersected.
+ collider: Object against which the shape intersected.
+ rid: [RID] of the object against which the shape intersected.
+ linear_velocity: The movement vector of the object the shape intersected, if it was a body. If it was an area, it is (0,0).
+ If the shape did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead.
+
+
@@ -25415,50 +25524,17 @@ This method controls whether the position between two cached points is interpola
The number of intersections can be limited with the second paramater, to reduce the processing time.
-
-
-
-
-
-
- Check whether the shape can travel to a point. If it can, the method will return an array with two floats: The first is the distance the shape can move in that direction without colliding, and the second is the distance at which it will collide.
- If the shape can not move, the array will be empty.
-
-
-
-
-
-
-
-
-
-
- Check the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. The resulting array contains a list of points where the shape intersects another. Like with [method intersect_shape], the number of returned results can be limited to save processing time.
-
-
-
-
-
-
-
-
- Check the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. If it collides with more than a shape, the nearest one is selected. The returned object is a dictionary containing the following fields:
- pointo: Place where the shapes intersect.
- normal: Normal of the object at the point where the shapes intersect.
- shape: Shape index within the object against which the shape intersected.
- metadata: Metadata of the shape against which the shape intersected. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data].
- collider_id: Id of the object against which the shape intersected.
- collider: Object against which the shape intersected.
- rid: [RID] of the object against which the shape intersected.
- linear_velocity: The movement vector of the object the shape intersected, if it was a body. If it was an area, it is (0,0).
- If the shape did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead.
-
-
Check for collisions with static bodies.
+
+ Check for collisions with any kind of bodies (but not areas).
+
+
+ Check for collisions with areas.
+
Check for collisions with kinematic bodies.
@@ -25468,12 +25544,6 @@ This method controls whether the position between two cached points is interpola
Check for collisions with rigid bodies in character mode.
-
- Check for collisions with areas.
-
-
- Check for collisions with any kind of bodies (but not areas).
-
@@ -25484,94 +25554,31 @@ This method controls whether the position between two cached points is interpola
Physics 2D Server is the server responsible for all 2D physics. It can create many kinds of physics objects, but does not insert them on the node tree.
-
-
-
-
+
+
+
+
+
+
- Create a shape of type SHAPE_*. Does not assign it to a body or an area. To do so, you must use [method area_set_shape] or [method body_set_shape].
+ Add a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
-
-
+
+
-
+
- Set the shape data that defines its shape and size. The data to be passed depends on the kind of shape created [method shape_get_type].
+ Assign the area to a descendant of [Object], so it can exist in the node tree.
-
-
-
-
+
+
- Return the type of shape (see SHAPE_* constants).
-
-
-
-
-
-
- Return the shape data.
-
-
-
-
-
-
- Create a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with [method area_set_space], or to a body with [method body_set_space].
-
-
-
-
-
-
-
-
- Mark a space as active. It will not have an effect, unless it is assigned to an area or body.
-
-
-
-
-
-
-
-
- Return whether the space is active.
-
-
-
-
-
-
-
-
-
-
- Set the value for a space parameter. A list of available parameters is on the SPACE_PARAM_* constants.
-
-
-
-
-
-
-
-
-
-
- Return the value of a space parameter.
-
-
-
-
-
-
-
-
- Return the state of a space, a [Physics2DDirectSpaceState]. This object can be used to make collision/intersection queries.
+ Remove all shapes from an area. It does not delete the shapes, so they can be reassigned later.
@@ -25581,13 +25588,53 @@ This method controls whether the position between two cached points is interpola
Create an [Area2D].
-
+
+
+
-
+
+ Get the instance ID of the object the area is assigned to.
+
+
+
+
+
+
- Assign a space to the area.
+ Return an area parameter value.
+
+
+
+
+
+
+
+
+
+
+ Return the [RID] of the nth shape of an area.
+
+
+
+
+
+
+
+
+ Return the number of shapes assigned to an area.
+
+
+
+
+
+
+
+
+
+
+ Return the transform matrix of a shape within an area.
@@ -25599,15 +25646,6 @@ This method controls whether the position between two cached points is interpola
Return the space assigned to the area.
-
-
-
-
-
-
- Set the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE_*.
-
-
@@ -25617,15 +25655,67 @@ This method controls whether the position between two cached points is interpola
Return the space override mode for the area.
-
+
+
+
-
+
+ Return the transform matrix for an area.
+
+
+
+
-
+
- Add a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
+ Remove a shape from an area. It does not delete the shape, so it can be reassigned later.
+
+
+
+
+
+
+
+
+ Set which physics layers the area will monitor.
+
+
+
+
+
+
+
+
+ Assign the area to one or many physics layers.
+
+
+
+
+
+
+
+
+
+
+ Set the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters:
+ 1: AREA_BODY_ADDED or AREA_BODY_REMOVED, depending on whether the object entered or exited the area.
+ 2: [RID] of the object that entered/exited the area.
+ 3: Instance ID of the object that entered/exited the area.
+ 4: The shape index of the object that entered/exited the area.
+ 5: The shape index of the area where the object entered/exited.
+
+
+
+
+
+
+
+
+
+
+ Set the value for an area parameter. A list of available parameters is on the AREA_PARAM_* constants.
@@ -25650,80 +25740,22 @@ This method controls whether the position between two cached points is interpola
Set the transform matrix for an area shape.
-
-
-
+
+
+
- Return the number of shapes assigned to an area.
+ Assign a space to the area.
-
-
-
+
-
+
- Return the [RID] of the nth shape of an area.
-
-
-
-
-
-
-
-
-
-
- Return the transform matrix of a shape within an area.
-
-
-
-
-
-
-
-
- Remove a shape from an area. It does not delete the shape, so it can be reassigned later.
-
-
-
-
-
-
- Remove all shapes from an area. It does not delete the shapes, so they can be reassigned later.
-
-
-
-
-
-
-
-
- Assign the area to one or many physics layers.
-
-
-
-
-
-
-
-
- Set which physics layers the area will monitor.
-
-
-
-
-
-
-
-
-
-
- Set the value for an area parameter. A list of available parameters is on the AREA_PARAM_* constants.
+ Set the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE_*.
@@ -25735,351 +25767,13 @@ This method controls whether the position between two cached points is interpola
Set the transform matrix for an area.
-
-
-
-
-
-
- Return an area parameter value.
-
-
-
-
-
-
-
-
- Return the transform matrix for an area.
-
-
-
-
-
-
-
-
- Assign the area to a descendant of [Object], so it can exist in the node tree.
-
-
-
-
-
-
-
-
- Get the instance ID of the object the area is assigned to.
-
-
-
-
-
-
-
-
-
-
- Set the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters:
- 1: AREA_BODY_ADDED or AREA_BODY_REMOVED, depending on whether the object entered or exited the area.
- 2: [RID] of the object that entered/exited the area.
- 3: Instance ID of the object that entered/exited the area.
- 4: The shape index of the object that entered/exited the area.
- 5: The shape index of the area where the object entered/exited.
-
-
-
-
-
-
-
-
-
-
- Create a physics body. The first parameter can be any value from constants BODY_MODE*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time.
-
-
-
+
-
+
- Assign a space to the body (see [method create_space]).
-
-
-
-
-
-
-
-
- Return the [RID] of the space assigned to a body.
-
-
-
-
-
-
-
-
- Set the body mode, from one of the constants BODY_MODE*.
-
-
-
-
-
-
-
-
- Return the body mode.
-
-
-
-
-
-
-
-
-
-
- Add a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
-
-
-
-
-
-
-
-
-
-
- Substitute a given body shape by another. The old shape is selected by its index, the new one by its [RID].
-
-
-
-
-
-
-
-
-
-
- Set the transform matrix for a body shape.
-
-
-
-
-
-
-
-
-
-
- Set metadata of a shape within a body. This metadata is different from [method Object.set_meta], and can be retrieved on shape queries.
-
-
-
-
-
-
-
-
- Return the number of shapes assigned to a body.
-
-
-
-
-
-
-
-
-
-
- Return the [RID] of the nth shape of a body.
-
-
-
-
-
-
-
-
-
-
- Return the transform matrix of a body shape.
-
-
-
-
-
-
-
-
- Return the metadata of a shape of a body.
-
-
-
-
-
-
-
-
- Remove a shape from a body. The shape is not deleted, so it can be reused afterwards.
-
-
-
-
-
-
- Remove all shapes from a body.
-
-
-
-
-
-
-
-
-
-
- Mark a body's shape as a trigger. A trigger shape cannot affect other bodies, but detects other shapes entering and exiting it.
-
-
-
-
-
-
-
-
-
-
- Return whether a body's shape is marked as a trigger.
-
-
-
-
-
-
-
-
- Assign the area to a descendant of [Object], so it can exist in the node tree.
-
-
-
-
-
-
-
-
- Get the instance ID of the object the area is assigned to.
-
-
-
-
-
-
-
-
- Set the continuous collision detection mode from any of the CCD_MODE_* constants.
- Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
-
-
-
-
-
-
-
-
- Return the continuous collision detection mode.
-
-
-
-
-
-
-
-
- Set the physics layer or layers a body belongs to.
-
-
-
-
-
-
-
-
- Return the physics layer or layers a body belongs to.
-
-
-
-
-
-
-
-
- Set the physics layer or layers a body can collide with.
-
-
-
-
-
-
-
-
- Return the physics layer or layers a body can collide with.
-
-
-
-
-
-
-
-
-
-
- Set a body parameter (see BODY_PARAM* constants).
-
-
-
-
-
-
-
-
-
-
- Return the value of a body parameter.
-
-
-
-
-
-
-
-
-
-
- Set a body state (see BODY_STATE* constants).
-
-
-
-
-
-
-
-
- Return a body state.
-
-
-
-
-
-
-
-
-
-
- Add a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates.
+ Add a body to the list of bodies exempt from collisions.
@@ -26093,40 +25787,80 @@ This method controls whether the position between two cached points is interpola
Add a positioned force to the applied force and torque. As with [method body_apply_impulse], both the force and the offset from the body origin are in global coordinates. A force differs from an impulse in that, while the two are forces, the impulse clears itself after being applied.
-
+
-
+
+
+
- Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
+ Add a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
-
+
-
+
+
+
- Add a body to the list of bodies exempt from collisions.
+ Add a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates.
-
+
-
+
- Remove a body from the list of bodies exempt from collisions.
+ Assign the area to a descendant of [Object], so it can exist in the node tree.
-
+
-
+
+ Remove all shapes from a body.
+
+
+
+
+
+
+
+
- Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0.
+ Create a physics body. The first parameter can be any value from constants BODY_MODE*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time.
+
+
+
+
+
+
+
+
+ Return the physics layer or layers a body can collide with.
+
+
+
+
+
+
+
+
+ Return the continuous collision detection mode.
+
+
+
+
+
+
+
+
+ Return the physics layer or layers a body belongs to.
@@ -26138,13 +25872,22 @@ This method controls whether the position between two cached points is interpola
Return the maximum contacts that can be reported. See [method body_set_max_contacts_reported].
-
+
+
+
-
+
+ Return the body mode.
+
+
+
+
+
+
- Set a direction in which bodies can go through the given one. If this value is different from (0,0), any movement within 90 degrees of this vector is considered a valid movement. Set this direction to (0,0) to disable one-way collisions.
+ Get the instance ID of the object the area is assigned to.
@@ -26156,15 +25899,6 @@ This method controls whether the position between two cached points is interpola
Return the direction used for one-way collision detection.
-
-
-
-
-
-
- Set how far a body can go through the given one, if it allows one-way collisions (see [method body_set_one_way_collision_direction]).
-
-
@@ -26174,13 +25908,73 @@ This method controls whether the position between two cached points is interpola
Return how far a body can go through the given one, when it allows one-way collisions.
-
+
+
+
-
+
- Set whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]).
+ Return the value of a body parameter.
+
+
+
+
+
+
+
+
+
+
+ Return the [RID] of the nth shape of a body.
+
+
+
+
+
+
+
+
+ Return the number of shapes assigned to a body.
+
+
+
+
+
+
+
+
+ Return the metadata of a shape of a body.
+
+
+
+
+
+
+
+
+
+
+ Return the transform matrix of a body shape.
+
+
+
+
+
+
+
+
+ Return the [RID] of the space assigned to a body.
+
+
+
+
+
+
+
+
+ Return a body state.
@@ -26192,6 +25986,63 @@ This method controls whether the position between two cached points is interpola
Return whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]).
+
+
+
+
+
+
+
+
+ Return whether a body's shape is marked as a trigger.
+
+
+
+
+
+
+
+
+ Remove a body from the list of bodies exempt from collisions.
+
+
+
+
+
+
+
+
+ Remove a shape from a body. The shape is not deleted, so it can be reused afterwards.
+
+
+
+
+
+
+
+
+ Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
+
+
+
+
+
+
+
+
+ Set the physics layer or layers a body can collide with.
+
+
+
+
+
+
+
+
+ Set the continuous collision detection mode from any of the CCD_MODE_* constants.
+ Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
+
+
@@ -26205,6 +26056,135 @@ This method controls whether the position between two cached points is interpola
Set the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force integration]).
+
+
+
+
+
+
+ Set the physics layer or layers a body belongs to.
+
+
+
+
+
+
+
+
+ Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0.
+
+
+
+
+
+
+
+
+ Set the body mode, from one of the constants BODY_MODE*.
+
+
+
+
+
+
+
+
+ Set whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]).
+
+
+
+
+
+
+
+
+ Set a direction in which bodies can go through the given one. If this value is different from (0,0), any movement within 90 degrees of this vector is considered a valid movement. Set this direction to (0,0) to disable one-way collisions.
+
+
+
+
+
+
+
+
+ Set how far a body can go through the given one, if it allows one-way collisions (see [method body_set_one_way_collision_direction]).
+
+
+
+
+
+
+
+
+
+
+ Set a body parameter (see BODY_PARAM* constants).
+
+
+
+
+
+
+
+
+
+
+ Substitute a given body shape by another. The old shape is selected by its index, the new one by its [RID].
+
+
+
+
+
+
+
+
+
+
+ Mark a body's shape as a trigger. A trigger shape cannot affect other bodies, but detects other shapes entering and exiting it.
+
+
+
+
+
+
+
+
+
+
+ Set metadata of a shape within a body. This metadata is different from [method Object.set_meta], and can be retrieved on shape queries.
+
+
+
+
+
+
+
+
+
+
+ Set the transform matrix for a body shape.
+
+
+
+
+
+
+
+
+ Assign a space to the body (see [method create_space]).
+
+
+
+
+
+
+
+
+
+
+ Set a body state (see BODY_STATE* constants).
+
+
@@ -26220,18 +26200,22 @@ This method controls whether the position between two cached points is interpola
Return whether a body can move in a given direction. Apart from the boolean return value, a [Physics2DTestMotionResult] can be passed to return additional information in.
-
-
+
+
+
+
-
+
-
+
+
+
- Set a joint parameter. Parameters are explained in the JOINT_PARAM* constants.
+ Create a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself.
-
+
@@ -26239,20 +26223,34 @@ This method controls whether the position between two cached points is interpola
- Return the value of a joint parameter.
+ Return the value of a damped spring joint parameter.
-
-
-
-
+
+
-
+
-
+
- Create a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself.
+ Set a damped spring joint parameter. Parameters are explained in the DAMPED_STRING* constants.
+
+
+
+
+
+
+ Destroy any of the objects created by Physics2DServer. If the [RID] passed is not one of the objects that can be created by Physics2DServer, an error will be sent to the console.
+
+
+
+
+
+
+
+
+ Return information about the current state of the 2D physics engine. The states are listed under the INFO_* constants.
@@ -26272,33 +26270,7 @@ This method controls whether the position between two cached points is interpola
Create a groove joint between two bodies. If not specified, the bodyies are assumed to be the joint itself.
-
-
-
-
-
-
-
-
-
-
-
-
- Create a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself.
-
-
-
-
-
-
-
-
-
-
- Set a damped spring joint parameter. Parameters are explained in the DAMPED_STRING* constants.
-
-
-
+
@@ -26306,7 +26278,7 @@ This method controls whether the position between two cached points is interpola
- Return the value of a damped spring joint parameter.
+ Return the value of a joint parameter.
@@ -26318,11 +26290,28 @@ This method controls whether the position between two cached points is interpola
Return the type of a joint (see JOINT_* constants).
-
-
+
+
+
+
+
+
- Destroy any of the objects created by Physics2DServer. If the [RID] passed is not one of the objects that can be created by Physics2DServer, an error will be sent to the console.
+ Set a joint parameter. Parameters are explained in the JOINT_PARAM* constants.
+
+
+
+
+
+
+
+
+
+
+
+
+ Create a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself.
@@ -26332,37 +26321,229 @@ This method controls whether the position between two cached points is interpola
Activate or deactivate the 2D physics engine.
-
-
+
+
-
+
- Return information about the current state of the 2D physics engine. The states are listed under the INFO_* constants.
+ Create a shape of type SHAPE_*. Does not assign it to a body or an area. To do so, you must use [method area_set_shape] or [method body_set_shape].
+
+
+
+
+
+
+ Return the shape data.
+
+
+
+
+
+
+
+
+ Return the type of shape (see SHAPE_* constants).
+
+
+
+
+
+
+
+
+ Set the shape data that defines its shape and size. The data to be passed depends on the kind of shape created [method shape_get_type].
+
+
+
+
+
+
+ Create a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with [method area_set_space], or to a body with [method body_set_space].
+
+
+
+
+
+
+
+
+ Return the state of a space, a [Physics2DDirectSpaceState]. This object can be used to make collision/intersection queries.
+
+
+
+
+
+
+
+
+
+
+ Return the value of a space parameter.
+
+
+
+
+
+
+
+
+ Return whether the space is active.
+
+
+
+
+
+
+
+
+ Mark a space as active. It will not have an effect, unless it is assigned to an area or body.
+
+
+
+
+
+
+
+
+
+
+ Set the value for a space parameter. A list of available parameters is on the SPACE_PARAM_* constants.
-
- Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated.
+
+ The value of the first parameter and area callback function receives, when an object enters one of its shapes.
-
- Constant to set/get the maximum distance a shape can be from another before they are considered separated.
+
+ Constant to set/get gravity strength in an area.
-
- Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision.
+
+ This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
-
- Constant to set/get the linear velocity threshold. Bodies slower than this will be marked as potentially inactive.
+
+ The value of the first parameter and area callback function receives, when an object exits one of its shapes.
-
- Constant to set/get the angular velocity threshold. Bodies slower than this will be marked as potentially inactive.
+
+ Constant to set/get gravity vector/center in an area.
-
- Constant to set/get the maximum time of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after this time.
+
+ This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects.
-
- Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision.
+
+ Constant to set/get whether the gravity vector of an area is a direction, or a center point.
+
+
+ This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one.
+
+
+ Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance.
+
+
+ This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
+
+
+ This constant was used to set/get the falloff factor for point gravity. It has been superseded by AREA_PARAM_GRAVITY_DISTANCE_SCALE.
+
+
+ This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
+
+
+ Constant to set/get the linear dampening factor of an area.
+
+
+ Constant to set/get the angular dampening factor of an area.
+
+
+ Constant to set/get the priority (order of processing) of an area.
+
+
+ Constant for static bodies.
+
+
+ Constant to set/get a body's bounce factor.
+
+
+ Constant to set/get the current transform matrix of the body.
+
+
+ Constant for kinematic bodies.
+
+
+ Constant to set/get a body's friction.
+
+
+ Constant to set/get the current linear velocity of the body.
+
+
+ Constant for rigid bodies.
+
+
+ Constant to set/get a body's mass.
+
+
+ Constant to set/get the current angular velocity of the body.
+
+
+ Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics.
+
+
+ Constant to set/get a body's inertia.
+
+
+ Constant to sleep/wake up a body, or to get whether it is sleeping.
+
+
+ Constant to set/get a body's gravity multiplier.
+
+
+ Constant to set/get whether the body can sleep.
+
+
+ Constant to set/get a body's linear dampening factor.
+
+
+ Constant to set/get a body's angular dampening factor.
+
+
+ This is the last ID for body parameters. Any attempt to set this property is ignored. Any attempt to get it returns 0.
+
+
+ Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects.
+
+
+ Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise.
+
+
+ Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise.
+
+
+ Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
+
+
+ Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
+
+
+ Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
+
+
+ Constant to get the number of objects that are not sleeping.
+
+
+ Constant to get the number of possible collisions.
+
+
+ Constant to get the number of space regions where a collision could occur.
+
+
+ Constant to create pin joints.
+
+
+ Constant to create groove joints.
+
+
+ Constant to create damped spring joints.
This is the constant for creating line shapes. A line shape is an infinite line with an origin point, and a normal. Thus, it can be used for front/behind checks.
@@ -26388,137 +26569,26 @@ This method controls whether the position between two cached points is interpola
This constant is used internally by the engine. Any attempt to create this kind of shape results in an error.
-
- Constant to set/get gravity strength in an area.
+
+ Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated.
-
- Constant to set/get gravity vector/center in an area.
+
+ Constant to set/get the maximum distance a shape can be from another before they are considered separated.
-
- Constant to set/get whether the gravity vector of an area is a direction, or a center point.
+
+ Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision.
-
- Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance.
+
+ Constant to set/get the linear velocity threshold. Bodies slower than this will be marked as potentially inactive.
-
- This constant was used to set/get the falloff factor for point gravity. It has been superseded by AREA_PARAM_GRAVITY_DISTANCE_SCALE.
+
+ Constant to set/get the angular velocity threshold. Bodies slower than this will be marked as potentially inactive.
-
- Constant to set/get the linear dampening factor of an area.
+
+ Constant to set/get the maximum time of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after this time.
-
- Constant to set/get the angular dampening factor of an area.
-
-
- Constant to set/get the priority (order of processing) of an area.
-
-
- This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
-
-
- This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects.
-
-
- This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one.
-
-
- This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
-
-
- This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
-
-
- Constant for static bodies.
-
-
- Constant for kinematic bodies.
-
-
- Constant for rigid bodies.
-
-
- Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics.
-
-
- Constant to set/get a body's bounce factor.
-
-
- Constant to set/get a body's friction.
-
-
- Constant to set/get a body's mass.
-
-
- Constant to set/get a body's inertia.
-
-
- Constant to set/get a body's gravity multiplier.
-
-
- Constant to set/get a body's linear dampening factor.
-
-
- Constant to set/get a body's angular dampening factor.
-
-
- This is the last ID for body parameters. Any attempt to set this property is ignored. Any attempt to get it returns 0.
-
-
- Constant to set/get the current transform matrix of the body.
-
-
- Constant to set/get the current linear velocity of the body.
-
-
- Constant to set/get the current angular velocity of the body.
-
-
- Constant to sleep/wake up a body, or to get whether it is sleeping.
-
-
- Constant to set/get whether the body can sleep.
-
-
- Constant to create pin joints.
-
-
- Constant to create groove joints.
-
-
- Constant to create damped spring joints.
-
-
- Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
-
-
- Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
-
-
- Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
-
-
- Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects.
-
-
- Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise.
-
-
- Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise.
-
-
- The value of the first parameter and area callback function receives, when an object enters one of its shapes.
-
-
- The value of the first parameter and area callback function receives, when an object exits one of its shapes.
-
-
- Constant to get the number of objects that are not sleeping.
-
-
- Constant to get the number of possible collisions.
-
-
- Constant to get the number of space regions where a collision could occur.
+
+ Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision.
@@ -26542,6 +26612,90 @@ This method controls whether the position between two cached points is interpola
This class contains the shape and other parameters for intersection/collision queries.
+
+
+
+
+ Return the list of objects, or object [RID]s, that will be excluded from collisions.
+
+
+
+
+
+
+ Return the physics layer(s) the shape belongs to.
+
+
+
+
+
+
+ Return the collision margin for the shape.
+
+
+
+
+
+
+ Return the current movement speed of the shape.
+
+
+
+
+
+
+ Return the type of object the shape belongs to.
+
+
+
+
+
+
+ Return the [RID] of the shape queried.
+
+
+
+
+
+
+ Return the transform matrix of the shape queried.
+
+
+
+
+
+
+ Set the list of objects, or object [RID]s, that will be excluded from collisions.
+
+
+
+
+
+
+ Set the physics layer(s) the shape belongs to.
+
+
+
+
+
+
+ Set the collision margin for the shape. A collision margin is an amount (in pixels) that the shape will grow when computing collisions, to account for numerical imprecision.
+
+
+
+
+
+
+ Set the current movement speed of the shape.
+
+
+
+
+
+
+ Set the type of object the shape belongs to (see Physics2DDirectSpaceState.TYPE_MASK_*).
+
+
@@ -26556,13 +26710,6 @@ This method controls whether the position between two cached points is interpola
Set the [RID] of the shape to be used in queries.
-
-
-
-
- Return the [RID] of the shape queried.
-
-
@@ -26570,83 +26717,6 @@ This method controls whether the position between two cached points is interpola
Set the transormation matrix of the shape. This is necessary to set its position/rotation/scale.
-
-
-
-
- Return the transform matrix of the shape queried.
-
-
-
-
-
-
- Set the current movement speed of the shape.
-
-
-
-
-
-
- Return the current movement speed of the shape.
-
-
-
-
-
-
- Set the collision margin for the shape. A collision margin is an amount (in pixels) that the shape will grow when computing collisions, to account for numerical imprecision.
-
-
-
-
-
-
- Return the collision margin for the shape.
-
-
-
-
-
-
- Set the physics layer(s) the shape belongs to.
-
-
-
-
-
-
- Return the physics layer(s) the shape belongs to.
-
-
-
-
-
-
- Set the type of object the shape belongs to (see Physics2DDirectSpaceState.TYPE_MASK_*).
-
-
-
-
-
-
- Return the type of object the shape belongs to.
-
-
-
-
-
-
- Set the list of objects, or object [RID]s, that will be excluded from collisions.
-
-
-
-
-
-
- Return the list of objects, or object [RID]s, that will be excluded from collisions.
-
-
@@ -26663,8 +26733,8 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
@@ -26679,16 +26749,16 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
-
-
+
+
@@ -26705,32 +26775,8 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
@@ -26747,14 +26793,38 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -26771,20 +26841,8 @@ This method controls whether the position between two cached points is interpola
PhysicsBody is an abstract base class for implementing a physics body. All PhysicsBody types inherit from it.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
@@ -26795,14 +26853,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
@@ -26811,11 +26861,9 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
+
+
+
@@ -26827,14 +26875,36 @@ This method controls whether the position between two cached points is interpola
-
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -26851,27 +26921,11 @@ This method controls whether the position between two cached points is interpola
PhysicsBody2D is an abstract base class for implementing a physics body. All *Body2D types inherit from it.
-
-
+
+
- Set the physics layers this area is in.
- Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask].
- A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
-
-
-
-
-
-
- Return the physics layer this area is in.
-
-
-
-
-
-
- Set the physics layers this area can scan for collisions.
+ Adds a body to the collision exception list. This list contains bodies that this body will not collide with.
@@ -26881,15 +26935,6 @@ This method controls whether the position between two cached points is interpola
Return the physics layers this area can scan for collisions.
-
-
-
-
-
-
- Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
-
-
@@ -26899,13 +26944,11 @@ This method controls whether the position between two cached points is interpola
Return an individual bit on the collision mask.
-
-
-
-
-
+
+
+
- Set/clear individual bits on the layer mask. This makes getting a body in/out of only one layer easier.
+ Return the physics layer this area is in.
@@ -26917,13 +26960,6 @@ This method controls whether the position between two cached points is interpola
Return an individual bit on the collision mask.
-
-
-
-
- Set a direction in which bodies can go through this one. If this value is different from (0,0), any movement within 90 degrees of this vector is considered a valid movement. Set this direction to (0,0) to disable one-way collisions.
-
-
@@ -26931,13 +26967,6 @@ This method controls whether the position between two cached points is interpola
Return the direction used for one-way collision detection.
-
-
-
-
- Set how far a body can go through this one, when it allows one-way collisions (see [method set_one_way_collision_direction]).
-
-
@@ -26945,13 +26974,6 @@ This method controls whether the position between two cached points is interpola
Return how far a body can go through this one, when it allows one-way collisions.
-
-
-
-
- Adds a body to the collision exception list. This list contains bodies that this body will not collide with.
-
-
@@ -26959,6 +26981,54 @@ This method controls whether the position between two cached points is interpola
Removes a body from the collision exception list.
+
+
+
+
+ Set the physics layers this area can scan for collisions.
+
+
+
+
+
+
+
+
+ Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
+
+
+
+
+
+
+ Set the physics layers this area is in.
+ Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask].
+ A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
+
+
+
+
+
+
+
+
+ Set/clear individual bits on the layer mask. This makes getting a body in/out of only one layer easier.
+
+
+
+
+
+
+ Set a direction in which bodies can go through this one. If this value is different from (0,0), any movement within 90 degrees of this vector is considered a valid movement. Set this direction to (0,0) to disable one-way collisions.
+
+
+
+
+
+
+ Set how far a body can go through this one, when it allows one-way collisions (see [method set_one_way_collision_direction]).
+
+
@@ -26969,72 +27039,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -27051,45 +27055,9 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -27101,14 +27069,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
@@ -27125,6 +27085,14 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
@@ -27141,22 +27109,124 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -27177,32 +27247,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -27231,20 +27275,46 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
@@ -27253,82 +27323,26 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
+
+
+
+
+
+
-
-
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
@@ -27339,10 +27353,46 @@ This method controls whether the position between two cached points is interpola
-
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -27355,14 +27405,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
@@ -27371,12 +27413,70 @@ This method controls whether the position between two cached points is interpola
-
+
+
+
-
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -27401,70 +27501,18 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -27477,60 +27525,44 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
-
+
-
-
-
-
+
+
+
+
+
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
@@ -27545,31 +27577,7 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -27577,32 +27585,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -27613,12 +27595,224 @@ This method controls whether the position between two cached points is interpola
-
+
+
+
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -27643,96 +27837,10 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -27747,149 +27855,7 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -27899,140 +27865,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -28043,62 +27875,20 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -28127,26 +27917,14 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
+
@@ -28159,8 +27937,437 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
+
+
+
+
+
+
+ This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects.
+
+
+
+
+ This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one.
+
+
+
+
+ This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
+
+
+
+
+ This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -28177,46 +28384,28 @@ This method controls whether the position between two cached points is interpola
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -28237,146 +28426,27 @@ This method controls whether the position between two cached points is interpola
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
-
-
- This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects.
-
-
- This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one.
-
-
- This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
-
-
- This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -28396,6 +28466,66 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -28408,72 +28538,12 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -28491,8 +28561,8 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
@@ -28507,16 +28577,16 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
-
-
+
+
@@ -28533,14 +28603,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
@@ -28549,6 +28611,14 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
@@ -28567,18 +28637,18 @@ This method controls whether the position between two cached points is interpola
Pin Joint for 2D Rigid Bodies. It pins 2 bodies (rigid or static) together, or a single body to a fixed position in space.
-
-
-
-
-
-
+
+
+
+
+
+
@@ -28591,6 +28661,45 @@ This method controls whether the position between two cached points is interpola
Plane represents a normalized plane equation. Basically, "normal" is the normal of the plane (a,b,c normalized), and "d" is the distance from the origin to the plane (in the direction of "normal"). "Over" or "Above" the plane is considered the side of the plane towards where the normal is pointing.
+
+
+
+
+
+
+
+
+
+
+
+
+ Creates a plane from the three parameters "a", "b", "c" and "d".
+
+
+
+
+
+
+
+
+
+
+
+
+ Creates a plane from three points.
+
+
+
+
+
+
+
+
+
+
+ Creates a plane from the normal and the plane's distance to the origin.
+
+
@@ -28683,47 +28792,10 @@ This method controls whether the position between two cached points is interpola
Returns the orthogonal projection of point "p" into a point in the plane.
-
-
-
-
-
-
-
-
-
-
-
-
- Creates a plane from the three parameters "a", "b", "c" and "d".
-
-
-
-
-
-
-
-
-
-
-
-
- Creates a plane from three points.
-
-
-
-
-
-
-
-
-
-
- Creates a plane from the normal and the plane's distance to the origin.
-
-
+
+
@@ -28732,8 +28804,6 @@ This method controls whether the position between two cached points is interpola
-
-
@@ -28744,18 +28814,18 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
+
+
+
+
+
+
@@ -28768,41 +28838,6 @@ This method controls whether the position between two cached points is interpola
A Polygon2D is defined by a set of n vertices connected together by line segments, meaning that the vertex 1 will be connected with vertex 2, vertex 2 with vertex 3 ..., vertex n-1 with vertex n and vertex n with vertex 1 in order to close the loop and define a polygon.
-
-
-
-
- Define the set of vertices that will represent the polygon.
-
-
-
-
-
-
- Return the set of vertices that defines this polygon.
-
-
-
-
-
-
- Set the texture coordinates for every vertex of the polygon. There should be one uv vertex for every vertex in the polygon. If there are less, the undefined ones will be assumed to be (0,0). Extra uv vertices are ignored.
-
-
-
-
-
-
- Return the texture coordinates associated with every vertex of the polygon.
-
-
-
-
-
-
- Set the polygon fill color. If the polygon has a texture defined, the defined texture will be multiplied by the polygon fill color. This, also, is the default color for those vertices that are not defined by [method get_vertex_colors].
-
-
@@ -28810,84 +28845,6 @@ This method controls whether the position between two cached points is interpola
Return the polygon fill color.
-
-
-
-
- Set the color for each vertex of the polygon. There should be one color for every vertex in the polygon. If there are less, the undefined ones will be assumed to be [method get_color]. Extra color entries are ignored.
- Colors are interpolated between vertices, resulting in smooth gradients when they differ.
-
-
-
-
-
-
- Return the list of vertex colors.
-
-
-
-
-
-
- Set the polygon texture.
-
-
-
-
-
-
- Return the polygon texture
-
-
-
-
-
-
- Set the offset of the polygon texture. Initially the texture will appear anchored to the polygon position, the offset is used to move the texture location away from that point (notice that the texture origin is set to its top left corner, so when offset is 0,0 the top left corner of the texture is at the polygon position), for example setting the offset to 10, 10 will move the texture 10 units to the left and 10 units to the top.
-
-
-
-
-
-
- Return the polygon texture offset.
-
-
-
-
-
-
- Set the amount of rotation of the polygon texture, [code]texture_rotation[/code] is specified in radians and clockwise rotation.
-
-
-
-
-
-
- Return the rotation in radians of the texture polygon.
-
-
-
-
-
-
- Set the value that will multiply the uv coordinates ([method get_uv]) when applying the texture. Larger values make the texture smaller, and vice versa.
-
-
-
-
-
-
- Return the uv coordinate multiplier.
-
-
-
-
-
-
- Set the polygon as the defined polygon bounding box minus the defined polygon (the defined polygon will appear as a hole on the square that contains the defined polygon).
-
-
@@ -28895,13 +28852,6 @@ This method controls whether the position between two cached points is interpola
Return whether this polygon is inverted or not.
-
-
-
-
- Add extra padding around the bounding box, making it bigger. Too small a value can make the polygon triangulate strangely, due to numerical imprecision.
-
-
@@ -28909,6 +28859,83 @@ This method controls whether the position between two cached points is interpola
Return the added padding around the bounding box.
+
+
+
+
+ Return the offset for the polygon vertices.
+
+
+
+
+
+
+ Return the set of vertices that defines this polygon.
+
+
+
+
+
+
+ Return the polygon texture
+
+
+
+
+
+
+ Return the polygon texture offset.
+
+
+
+
+
+
+ Return the rotation in radians of the texture polygon.
+
+
+
+
+
+
+ Return the uv coordinate multiplier.
+
+
+
+
+
+
+ Return the texture coordinates associated with every vertex of the polygon.
+
+
+
+
+
+
+ Return the list of vertex colors.
+
+
+
+
+
+
+ Set the polygon fill color. If the polygon has a texture defined, the defined texture will be multiplied by the polygon fill color. This, also, is the default color for those vertices that are not defined by [method get_vertex_colors].
+
+
+
+
+
+
+ Set the polygon as the defined polygon bounding box minus the defined polygon (the defined polygon will appear as a hole on the square that contains the defined polygon).
+
+
+
+
+
+
+ Add extra padding around the bounding box, making it bigger. Too small a value can make the polygon triangulate strangely, due to numerical imprecision.
+
+
@@ -28916,11 +28943,54 @@ This method controls whether the position between two cached points is interpola
Set the an offset that will be added to the vertices' position. E.g. if the offset is set to (10,10) then all the polygon points will move 10 units to the right and 10 units to the bottom.
-
-
-
+
+
+
- Return the offset for the polygon vertices.
+ Define the set of vertices that will represent the polygon.
+
+
+
+
+
+
+ Set the polygon texture.
+
+
+
+
+
+
+ Set the offset of the polygon texture. Initially the texture will appear anchored to the polygon position, the offset is used to move the texture location away from that point (notice that the texture origin is set to its top left corner, so when offset is 0,0 the top left corner of the texture is at the polygon position), for example setting the offset to 10, 10 will move the texture 10 units to the left and 10 units to the top.
+
+
+
+
+
+
+ Set the amount of rotation of the polygon texture, [code]texture_rotation[/code] is specified in radians and clockwise rotation.
+
+
+
+
+
+
+ Set the value that will multiply the uv coordinates ([method get_uv]) when applying the texture. Larger values make the texture smaller, and vice versa.
+
+
+
+
+
+
+ Set the texture coordinates for every vertex of the polygon. There should be one uv vertex for every vertex in the polygon. If there are less, the undefined ones will be assumed to be (0,0). Extra uv vertices are ignored.
+
+
+
+
+
+
+ Set the color for each vertex of the polygon. There should be one color for every vertex in the polygon. If there are less, the undefined ones will be assumed to be [method get_color]. Extra color entries are ignored.
+ Colors are interpolated between vertices, resulting in smooth gradients when they differ.
@@ -28933,14 +29003,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
@@ -28951,6 +29013,20 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -28961,10 +29037,10 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
-
+
@@ -28985,17 +29061,11 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
+
+
+
+
-
-
-
-
-
-
@@ -29011,6 +29081,18 @@ This method controls whether the position between two cached points is interpola
Popup is a base [Control] used to show dialogs and popups. It's a subwindow and modal by default (see [Control]) and has helpers for custom popup behavior.
+
+
+
+
+ Returns whether the popup will hide other popups when shown on the screen.
+
+
+
+
+ Popup (show the control in modal form).
+
+
@@ -29018,13 +29100,6 @@ This method controls whether the position between two cached points is interpola
Popup (show the control in modal form) in the center of the screen, at the current size, or at a size determined by "size".
-
-
-
-
- Popup (show the control in modal form) in the center of the screen, scaled at a ratio of size of the screen.
-
-
@@ -29032,9 +29107,11 @@ This method controls whether the position between two cached points is interpola
Popup (show the control in modal form) in the center of the screen, ensuring the size is never smaller than [code]minsize[/code].
-
+
+
+
- Popup (show the control in modal form).
+ Popup (show the control in modal form) in the center of the screen, scaled at a ratio of size of the screen.
@@ -29044,25 +29121,18 @@ This method controls whether the position between two cached points is interpola
Make the popup hide other popups when shown on the screen.
-
-
-
-
- Returns whether the popup will hide other popups when shown on the screen.
-
-
-
-
- This signal is emitted when a popup is hidden.
-
-
This signal is emitted when a popup is about to be shown. (often used in [PopupMenu] for clearing the list of options and creating a new one according to the current context).
+
+
+ This signal is emitted when a popup is hidden.
+
+
@@ -29093,20 +29163,7 @@ This method controls whether the position between two cached points is interpola
PopupMenu is the typical Control that displays a list of options. They are popular in toolbars or context menus.
-
-
-
-
-
-
-
-
-
-
- Add a new item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index.
-
-
-
+
@@ -29114,7 +29171,15 @@ This method controls whether the position between two cached points is interpola
- Add a new item with text "label". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index.
+ Add a new checkable item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.
+
+
+
+
+
+
+
+
@@ -29130,7 +29195,40 @@ This method controls whether the position between two cached points is interpola
Add a new checkable item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Add a new item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index.
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -29138,7 +29236,20 @@ This method controls whether the position between two cached points is interpola
- Add a new checkable item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.
+ Add a new item with text "label". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index.
+
+
+
+
+ Add a separator between items. Separators also occupy an index.
+
+
+
+
+
+
+
+
@@ -29152,147 +29263,34 @@ This method controls whether the position between two cached points is interpola
Adds an item with a submenu. The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. An id can optionally be provided, but if is isn't provided, one will be created from the index.
-
-
-
-
-
-
-
+
+ Clear the popup menu, in effect removing all items.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Set the text of the item at index "idx".
-
-
-
-
-
-
-
-
- Set the icon of the item at index "idx".
-
-
-
-
-
-
-
-
- Set the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused.
-
-
-
-
-
-
-
-
- Sets the metadata of an item, which might be of any type. You can later get it with [method get_item_metadata], which provides a simple way of assigning context data to items.
-
-
-
-
-
-
-
-
- Set the checkstate status of the item at index "idx".
-
-
-
-
-
-
-
-
- Sets whether the item at index "idx" is disabled or not. When it is disabled it can't be selected, or its action invoked.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Sets the submenu of the item at index "idx". The submenu is the name of a child PopupMenu node that would be shown when the item is clicked.
-
-
-
-
-
-
-
-
- Mark the item at index "idx" as a seperator, which means that it would be displayed as a mere line.
-
-
-
-
-
-
-
-
- Set whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.
-
-
-
-
-
-
-
-
- Set the id of the item at index "idx".
-
-
-
-
+
+
- Return the text of the item at index "idx".
+ Return the id of the item at index "idx".
+
+
+
+
+
+
+
+
+ Return the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused.
+
+
+
+
+
+
+ Return the amount of items.
@@ -29304,6 +29302,15 @@ This method controls whether the position between two cached points is interpola
Return the icon of the item at index "idx".
+
+
+
+
+
+
+ Find and return the index of the item containing a given id.
+
+
@@ -29311,15 +29318,6 @@ This method controls whether the position between two cached points is interpola
Return the metadata of an item, which might be of any type. You can set it with [method set_item_metadata], which provides a simple way of assigning context data to items.
-
-
-
-
-
-
- Return the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused.
-
-
@@ -29337,13 +29335,13 @@ This method controls whether the position between two cached points is interpola
Return the submenu name of the item at index "idx".
-
-
+
+
- Return whether the item is a seperator. If it is, it would be displayed as a line.
+ Return the text of the item at index "idx".
@@ -29373,34 +29371,13 @@ This method controls whether the position between two cached points is interpola
Return whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked.
-
-
+
+
- Return the id of the item at index "idx".
-
-
-
-
-
-
-
-
- Find and return the index of the item containing a given id.
-
-
-
-
-
-
- Return the amount of items.
-
-
-
-
- Add a separator between items. Separators also occupy an index.
+ Return whether the item is a seperator. If it is, it would be displayed as a line.
@@ -29410,9 +29387,102 @@ This method controls whether the position between two cached points is interpola
Removes the item at index "idx" from the menu. Note that the indexes of items after the removed item are going to be shifted by one.
-
+
+
+
+
+
- Clear the popup menu, in effect removing all items.
+ Set the id of the item at index "idx".
+
+
+
+
+
+
+
+
+ Set the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused.
+
+
+
+
+
+
+
+
+ Set whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.
+
+
+
+
+
+
+
+
+ Mark the item at index "idx" as a seperator, which means that it would be displayed as a mere line.
+
+
+
+
+
+
+
+
+ Set the checkstate status of the item at index "idx".
+
+
+
+
+
+
+
+
+ Sets whether the item at index "idx" is disabled or not. When it is disabled it can't be selected, or its action invoked.
+
+
+
+
+
+
+
+
+ Set the icon of the item at index "idx".
+
+
+
+
+
+
+
+
+ Sets the metadata of an item, which might be of any type. You can later get it with [method get_item_metadata], which provides a simple way of assigning context data to items.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets the submenu of the item at index "idx". The submenu is the name of a child PopupMenu node that would be shown when the item is clicked.
+
+
+
+
+
+
+
+
+ Set the text of the item at index "idx".
@@ -29428,34 +29498,34 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
@@ -29482,39 +29552,11 @@ This method controls whether the position between two cached points is interpola
Portals provide virtual openings to [VisualInstance] nodes, so cameras can look at them from the outside. Note that portals are a visibility optimization technique, and are in no way related to the game of the same name (as in, they are not used for teleportation). For more information on how rooms and portals work, see [VisualInstance]. Portals are represented as 2D convex polygon shapes (in the X,Y local plane), and are placed on the surface of the areas occupied by a [VisualInstance], to indicate that the room can be accessed or looked-at through them. If two rooms are next to each other, and two similar portals in each of them share the same world position (and are parallel and opposed to each other), they will automatically "connect" and form "doors" (for example, the portals that connect a kitchen to a living room are placed in the door they share). Portals must always have a [VisualInstance] node as a parent, grandparent or far parent, or else they will not be active.
-
-
-
-
- Set the portal shape. The shape is an array of [Vector2] points, representing a convex polygon in the X,Y plane.
-
-
-
-
+
+
- Return the portal shape. The shape is an array of [Vector2] points, representing a convex polygon in the X,Y plane.
-
-
-
-
-
-
- Enable the portal (it is enabled by default though), disabling it will cause the parent [VisualInstance] to not be visible any longer when looking through the portal.
-
-
-
-
-
-
- Return whether the portal is active. When disabled it causes the parent [VisualInstance] to not be visible any longer when looking through the portal.
-
-
-
-
-
-
- Set the distance threshold for disabling the portal. Every time that the portal goes beyond "distance", it disables itself, becoming the opaque color (see [method set_disabled_color]).
+ Return the range for auto-connecting two portals from different rooms sharing the same space.
@@ -29524,13 +29566,6 @@ This method controls whether the position between two cached points is interpola
Return the distance threshold for disabling the portal. Every time that the portal goes beyond "distance", it disables itself, becoming the opaque color (see [method set_disabled_color]).
-
-
-
-
- When the portal goes beyond the disable distance (see [method set_disable_distance]), it becomes opaque and displayed with color "color".
-
-
@@ -29538,6 +29573,20 @@ This method controls whether the position between two cached points is interpola
Return the color for when the portal goes beyond the disable distance (see [method set_disable_distance]) and becomes disabled.
+
+
+
+
+ Return the portal shape. The shape is an array of [Vector2] points, representing a convex polygon in the X,Y plane.
+
+
+
+
+
+
+ Return whether the portal is active. When disabled it causes the parent [VisualInstance] to not be visible any longer when looking through the portal.
+
+
@@ -29545,11 +29594,32 @@ This method controls whether the position between two cached points is interpola
Set the range for auto-connecting two portals from different rooms sharing the same space.
-
-
-
+
+
+
- Return the range for auto-connecting two portals from different rooms sharing the same space.
+ Set the distance threshold for disabling the portal. Every time that the portal goes beyond "distance", it disables itself, becoming the opaque color (see [method set_disabled_color]).
+
+
+
+
+
+
+ When the portal goes beyond the disable distance (see [method set_disable_distance]), it becomes opaque and displayed with color "color".
+
+
+
+
+
+
+ Enable the portal (it is enabled by default though), disabling it will cause the parent [VisualInstance] to not be visible any longer when looking through the portal.
+
+
+
+
+
+
+ Set the portal shape. The shape is an array of [Vector2] points, representing a convex polygon in the X,Y plane.
@@ -29588,31 +29658,31 @@ This method controls whether the position between two cached points is interpola
General purpose progress bar. Shows fill percentage from right to left.
-
-
-
-
-
-
+
+
+
+
+
+
-
-
-
-
-
+
-
+
+
+
+
+
@@ -29624,12 +29694,6 @@ This method controls whether the position between two cached points is interpola
General purpose proximity-detection node.
-
-
-
-
-
-
@@ -29638,6 +29702,12 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
@@ -29650,9 +29720,9 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
@@ -29676,21 +29746,15 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
+
+
+
@@ -29700,15 +29764,21 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
+
+
+
+
+
+
-
-
-
+
+
+
@@ -29718,9 +29788,9 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
@@ -29736,6 +29806,38 @@ This method controls whether the position between two cached points is interpola
Quaternion is a 4 dimensional vector that is used to represent a rotation. It mainly exists to perform SLERP (spherical-linear interpolation) between to rotations obtained by a Matrix3 cheaply. Adding quaternions also cheaply adds the rotations, however quaternions need to be often normalized, or else they suffer from precision issues.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -29816,48 +29918,16 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-
@@ -29868,12 +29938,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
@@ -29882,6 +29946,12 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
@@ -29894,6 +29964,41 @@ This method controls whether the position between two cached points is interpola
Range is a base class for [Control] nodes that change a floating point [i]value[/i] between a [i]minimum[/i] and a [i]maximum[/i], using [i]step[/i] and [i]page[/i], for example a [ScrollBar].
+
+
+
+
+ Return the maximum value.
+
+
+
+
+
+
+ Return the minimum value.
+
+
+
+
+
+
+ Return the page size, if page is 0, paging is disabled.
+
+
+
+
+
+
+ Return the stepping, if step is 0, stepping is disabled.
+
+
+
+
+
+
+ Return value mapped to 0 to 1 (unit) range.
+
+
@@ -29907,108 +30012,73 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
- Return the minimum value.
-
-
-
-
-
-
- Return the maximum value.
-
-
-
-
-
-
- Return the stepping, if step is 0, stepping is disabled.
-
-
-
-
-
-
- Return the page size, if page is 0, paging is disabled.
-
-
-
-
-
-
- Return value mapped to 0 to 1 (unit) range.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Set minimum value, clamped range value to it if it's less.
-
-
-
-
-
-
-
-
-
-
-
-
- Set step value. If step is 0, stepping will be disabled.
-
-
-
-
-
-
- Set page size. Page is mainly used for scrollbars or anything that controls text scrolling.
-
-
-
-
-
-
- Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max.
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+ Set minimum value, clamped range value to it if it's less.
+
+
+
+
+
+
+ Set page size. Page is mainly used for scrollbars or anything that controls text scrolling.
+
+
+
+
+
+
+
+
+
+
+
+
+ Set step value. If step is 0, stepping will be disabled.
+
+
+
+
+
+
+ Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max.
+
+
+
+
+
+
+
+
+
+
+
@@ -30024,6 +30094,11 @@ This method controls whether the position between two cached points is interpola
+
+
+ This signal is emitted when min, max, range or step change.
+
+
@@ -30031,11 +30106,6 @@ This method controls whether the position between two cached points is interpola
This signal is emitted when value changes.
-
-
- This signal is emitted when min, max, range or step change.
-
-
@@ -30048,6 +30118,15 @@ This method controls whether the position between two cached points is interpola
Raw byte array. Contains bytes. Optimized for memory usage, can't fragment the memory.
+
+
+
+
+
+
+ Create from a generic array.
+
+
@@ -30092,15 +30171,6 @@ This method controls whether the position between two cached points is interpola
Return the size of the array.
-
-
-
-
-
-
- Create from a generic array.
-
-
@@ -30111,21 +30181,19 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
-
-
-
+
+
+
-
-
-
+
@@ -30135,12 +30203,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
@@ -30153,25 +30215,43 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -30183,13 +30263,15 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
-
+
+
+
@@ -30199,24 +30281,12 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
@@ -30229,25 +30299,22 @@ This method controls whether the position between two cached points is interpola
A RayCast2D represents a line from its origin to its destination position [code]cast_to[/code], it is used to query the 2D space in order to find the closest object intersecting with the ray.
-
-
+
+
- Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions.
+ Adds a collision exception so the ray does not report collisions with the specified [code]node[/code].
-
-
-
-
- Returns whether this raycast is enabled or not
-
-
-
-
+
+
- Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code]
+
+
+
+
+ Removes all collision exception for this ray.
@@ -30257,13 +30324,6 @@ This method controls whether the position between two cached points is interpola
Return the destination point of this ray object
-
-
-
-
- Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length).
-
-
@@ -30278,13 +30338,6 @@ This method controls whether the position between two cached points is interpola
Returns the collision shape of the closest object the ray is pointing to.
-
-
-
-
- Returns the collision point in which the ray intersects the closest object.
-
-
@@ -30292,41 +30345,11 @@ This method controls whether the position between two cached points is interpola
Returns the normal of the intersecting object shape face containing the collision point.
-
-
-
-
-
-
-
-
-
-
- Adds a collision exception so the ray does not report collisions with the specified [code]node[/code].
-
-
-
-
-
-
-
-
-
-
-
-
- Removes a collision exception so the ray does report collisions with the specified [code]node[/code].
-
-
-
-
- Removes all collision exception for this ray.
-
-
-
-
-
+
+
+
+ Returns the collision point in which the ray intersects the closest object.
@@ -30336,15 +30359,62 @@ This method controls whether the position between two cached points is interpola
Returns the layer mask for this ray.
-
+
+
+
+
+
+
+
+
+
+
+ Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length).
+
+
+
+
+
+
+ Returns whether this raycast is enabled or not
+
+
+
+
+
+
+ Removes a collision exception so the ray does report collisions with the specified [code]node[/code].
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code]
+
+
+
+
+
+
+ Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions.
+
+
+
-
-
-
+
+
+
@@ -30358,18 +30428,18 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
+
+
+
+
+
+
@@ -30382,13 +30452,6 @@ This method controls whether the position between two cached points is interpola
Ray 2D shape resource for physics. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters.
-
-
-
-
- Set the length of the ray.
-
-
@@ -30396,6 +30459,13 @@ This method controls whether the position between two cached points is interpola
Return the length of the ray.
+
+
+
+
+ Set the length of the ray.
+
+
@@ -30408,6 +30478,15 @@ This method controls whether the position between two cached points is interpola
Real Array. Array of floating point values. Can only contain floats. Optimized for memory usage, can't fragment the memory.
+
+
+
+
+
+
+ Create from a generic array.
+
+
@@ -30438,15 +30517,6 @@ This method controls whether the position between two cached points is interpola
Return the size of the array.
-
-
-
-
-
-
- Create from a generic array.
-
-
@@ -30459,6 +30529,32 @@ This method controls whether the position between two cached points is interpola
Rect2 provides an 2D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for fast overlap tests.
+
+
+
+
+
+
+
+
+ Construct a [Rect2] by position and size.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Construct a [Rect2] by x, y, width and height.
+
+
@@ -30536,43 +30632,17 @@ This method controls whether the position between two cached points is interpola
Combine this [Rect2] with another, a larger one is returned that contains both.
-
-
-
-
-
-
-
-
- Construct a [Rect2] by position and size.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Construct a [Rect2] by x, y, width and height.
-
-
+
+ Ending corner.
+
Position (starting corner).
Size from position to end.
-
- Ending corner.
-
@@ -30585,13 +30655,6 @@ This method controls whether the position between two cached points is interpola
Rectangle Shape for 2D Physics. This shape is useful for modeling box-like 2D objects.
-
-
-
-
- Set the half extents, the actual width and height of this shape is twice the half extents.
-
-
@@ -30599,6 +30662,13 @@ This method controls whether the position between two cached points is interpola
Return the half extents, the actual width and height of this shape is twice the half extents.
+
+
+
+
+ Set the half extents, the actual width and height of this shape is twice the half extents.
+
+
@@ -30674,6 +30744,11 @@ This method controls whether the position between two cached points is interpola
Word boundaries [code]\b[/code], [code]\B[/code]
+
+
+ This method resets the state of the object, as it was freshly created. Namely, it unassigns the regular expression of this object, and forgets all captures made by the last [method find].
+
+
@@ -30698,25 +30773,6 @@ This method controls whether the position between two cached points is interpola
This method tries to find the pattern within the string, and returns the position where it was found. It also stores any capturing group (see [method get_capture]) for further retrieval.
-
-
- This method resets the state of the object, as it was freshly created. Namely, it unassigns the regular expression of this object, and forgets all captures made by the last [method find].
-
-
-
-
-
-
- Returns whether this object has a valid regular expression assigned.
-
-
-
-
-
-
- Returns the number of capturing groups. A captured group is the part of a string that matches a part of the pattern delimited by parentheses (unless they are non-capturing parentheses [i](?:)[/i]).
-
-
@@ -30726,6 +30782,13 @@ This method controls whether the position between two cached points is interpola
Returns a captured group. A captured group is the part of a string that matches a part of the pattern delimited by parentheses (unless they are non-capturing parentheses [i](?:)[/i]).
+
+
+
+
+ Returns the number of capturing groups. A captured group is the part of a string that matches a part of the pattern delimited by parentheses (unless they are non-capturing parentheses [i](?:)[/i]).
+
+
@@ -30741,6 +30804,13 @@ This method controls whether the position between two cached points is interpola
Return a list of all the captures made by the regular expression.
+
+
+
+
+ Returns whether this object has a valid regular expression assigned.
+
+
@@ -30751,18 +30821,18 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
+
+
+
+
+
+
@@ -30785,32 +30855,18 @@ This method controls whether the position between two cached points is interpola
Resource is the base class for all resource types. Resources are primarily data containers. They are reference counted and freed when no longer in use. They are also loaded only once from disk, and further attempts to load the resource will return the same reference (all this in contrast to a [Node], which is not reference counted and can be instanced from disk as many times as desired). Resources can be saved externally on disk or bundled into another object, such as a [Node] or another resource.
-
-
+
+
+
+
- Set the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. Fails if another [Resource] already has path "path".
-
-
-
-
- Set the path of the resource. Differs from set_path(), if another [Resource] exists with "path" it over-takes it, instead of failing.
-
-
-
-
+
+
- Return the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else.
-
-
-
-
-
-
- Set the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only.
@@ -30820,6 +30876,13 @@ This method controls whether the position between two cached points is interpola
Return the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only.
+
+
+
+
+ Return the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else.
+
+
@@ -30833,18 +30896,25 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
+
+
+ Set the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only.
+
+
+
+
+
+
+ Set the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. Fails if another [Resource] already has path "path".
+
+
+
+
+
+
+ Set the path of the resource. Differs from set_path(), if another [Resource] exists with "path" it over-takes it, instead of failing.
@@ -30863,18 +30933,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
@@ -30883,47 +30941,9 @@ This method controls whether the position between two cached points is interpola
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -30939,6 +30959,56 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -30958,19 +31028,6 @@ This method controls whether the position between two cached points is interpola
Return the loaded resource (only if loaded). Otherwise, returns null.
-
-
-
-
- Poll the load. If OK is returned, this means poll will have to be called again. If ERR_EOF is returned, them the load has finished and the resource can be obtained by calling [method get_resource].
-
-
-
-
-
-
-
-
@@ -30985,6 +31042,19 @@ This method controls whether the position between two cached points is interpola
Return the total amount of stages (calls to [method poll]) needed to completely load this resource.
+
+
+
+
+ Poll the load. If OK is returned, this means poll will have to be called again. If ERR_EOF is returned, them the load has finished and the resource can be obtained by calling [method get_resource].
+
+
+
+
+
+
+
+
@@ -30997,15 +31067,29 @@ This method controls whether the position between two cached points is interpola
Resource Loader. This is a static object accessible as [ResourceLoader]. GDScript has a simplified load() function, though.
-
-
+
+
-
+
+
+
+
+
+
+
+
+
+ Return the list of recognized extensions for a resource type.
+
+
+
+
+
+
- Load a resource interactively, the returned object allows to load with high granularity.
@@ -31028,13 +31112,15 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
-
+
+
+
- Return the list of recognized extensions for a resource type.
+ Load a resource interactively, the returned object allows to load with high granularity.
@@ -31044,22 +31130,6 @@ This method controls whether the position between two cached points is interpola
Change the behavior on missing sub-resources. Default is to abort load.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -31081,31 +31151,6 @@ This method controls whether the position between two cached points is interpola
Add a resource to the preloader. Set the text-id that will be used to identify it (retrieve it/erase it/etc).
-
-
-
-
- Remove a resource from the preloader by text id.
-
-
-
-
-
-
-
-
- Rename a resource inside the preloader, from a text-id to a new text-id.
-
-
-
-
-
-
-
-
- Return true if the preloader has a given resource.
-
-
@@ -31122,6 +31167,31 @@ This method controls whether the position between two cached points is interpola
Return the list of resources inside the preloader.
+
+
+
+
+
+
+ Return true if the preloader has a given resource.
+
+
+
+
+
+
+ Remove a resource from the preloader by text id.
+
+
+
+
+
+
+
+
+ Rename a resource inside the preloader, from a text-id to a new text-id.
+
+
@@ -31134,6 +31204,15 @@ This method controls whether the position between two cached points is interpola
Resource Saving Interface. This interface is used for saving resources to disk.
+
+
+
+
+
+
+ Return the list of extensions available for saving a resource of a given type.
+
+
@@ -31147,29 +31226,20 @@ This method controls whether the position between two cached points is interpola
Save a resource to disk, to a given path.
-
-
-
-
-
-
- Return the list of extensions available for saving a resource of a given type.
-
-
+
+
+
+
-
-
-
-
@@ -31180,36 +31250,125 @@ This method controls whether the position between two cached points is interpola
Label that displays rich text. Rich text can contain custom text, fonts, images and some basic formatting. It also adapts itself to given width/heights.
+
+
+
+
+
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return true if selecting the text inside this richtext is allowed.
+
+
+
+
+
+
+
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
@@ -31232,12 +31391,55 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Set to true if selecting the text inside this richtext is allowed.
+
+
+
+
@@ -31252,147 +31454,15 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Set to true if selecting the text inside this richtext is allowed.
-
-
-
-
-
-
- Return true if selecting the text inside this richtext is allowed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
@@ -31414,16 +31484,12 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
+
+
@@ -31440,33 +31506,37 @@ This method controls whether the position between two cached points is interpola
-
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-
+
+
+
-
+
+
+
+
+
@@ -31485,210 +31555,6 @@ This method controls whether the position between two cached points is interpola
Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default it works in addition to the usual physics behavior, but [method set_use_custom_integrator] allows you to disable the default behavior and do fully custom force integration for a body.
-
-
-
-
- Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body.
-
-
-
-
-
-
- Return the current body mode, see [method set_mode].
-
-
-
-
-
-
- Set the body mass.
-
-
-
-
-
-
- Return the current body mass.
-
-
-
-
-
-
- Set the body weight given standard earth-weight (gravity 9.8).
-
-
-
-
-
-
- Return the current body weight, given standard earth-weight (gravity 9.8).
-
-
-
-
-
-
- Set the body friction, from 0 (frictionless) to 1 (max friction).
-
-
-
-
-
-
- Return the current body friction, from 0 (frictionless) to 1 (max friction).
-
-
-
-
-
-
- Set the body bounciness, from 0 (no bounciness) to 1 (max bounciness).
-
-
-
-
-
-
- Return the current body bounciness.
-
-
-
-
-
-
- Set the body linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state.
-
-
-
-
-
-
- Return the current body linear velocity.
-
-
-
-
-
-
- Set the body angular velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state.
-
-
-
-
-
-
- Return the current body angular velocity.
-
-
-
-
-
-
- Set the gravity factor. This factor multiplies gravity intensity just for this body.
-
-
-
-
-
-
- Return the current body gravity scale.
-
-
-
-
-
-
- Set the linear damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden.
-
-
-
-
-
-
- Return the current body linear damp. Default is -1.
-
-
-
-
-
-
- Set the angular damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any angular damp derived from the world or areas will be overridden.
-
-
-
-
-
-
- Return the current body angular damp. Default is -1.
-
-
-
-
-
-
- Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0.
-
-
-
-
-
-
- Return the maximum contacts that can be reported. See [method set_max_contacts_reported].
-
-
-
-
-
-
- Pass true to disable the internal force integration (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined.
-
-
-
-
-
-
- Return whether the body is using a custom integrator.
-
-
-
-
-
-
- Enable contact monitoring. This allows the body to emit signals when it collides with another.
-
-
-
-
-
-
- Return whether contact monitoring is enabled.
-
-
-
-
-
-
- Set the continuous collision detection mode from the enum CCD_MODE_*.
- Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fast-moving objects.
-
-
-
-
-
-
- Return whether this body is using continuous collision detection.
-
-
-
-
-
-
- Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
-
-
@@ -31698,11 +31564,109 @@ This method controls whether the position between two cached points is interpola
Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the offset from the body origin are in global coordinates.
-
-
-
+
+
+
- Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] wakes them up. Until then, they behave like a static body.
+ Return the current body angular damp. Default is -1.
+
+
+
+
+
+
+ Return the current body angular velocity.
+
+
+
+
+
+
+ Return the current axis lock of the body. One of AXIS_LOCK_* enum.
+
+
+
+
+
+
+ Return the current body bounciness.
+
+
+
+
+
+
+ Return a list of the bodies colliding with this one.
+
+
+
+
+
+
+ Return the current body friction, from 0 (frictionless) to 1 (max friction).
+
+
+
+
+
+
+ Return the current body gravity scale.
+
+
+
+
+
+
+ Return the current body linear damp. Default is -1.
+
+
+
+
+
+
+ Return the current body linear velocity.
+
+
+
+
+
+
+ Return the current body mass.
+
+
+
+
+
+
+ Return the maximum contacts that can be reported. See [method set_max_contacts_reported].
+
+
+
+
+
+
+ Return the current body mode, see [method set_mode].
+
+
+
+
+
+
+ Return the current body weight, given standard earth-weight (gravity 9.8).
+
+
+
+
+
+
+ Return whether the body has the ability to fall asleep when not moving. See [method set_can_sleep].
+
+
+
+
+
+
+ Return whether contact monitoring is enabled.
@@ -31712,6 +31676,55 @@ This method controls whether the position between two cached points is interpola
Return whether the body is sleeping.
+
+
+
+
+ Return whether this body is using continuous collision detection.
+
+
+
+
+
+
+ Return whether the body is using a custom integrator.
+
+
+
+
+
+
+ Set the angular damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any angular damp derived from the world or areas will be overridden.
+
+
+
+
+
+
+ Set the body angular velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state.
+
+
+
+
+
+
+ Set the axis lock of the body, from the AXIS_LOCK_* enum. Axis lock stops the body from moving along the specified axis(X/Y/Z) and rotating along the other two axes.
+
+
+
+
+
+
+ Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
+
+
+
+
+
+
+ Set the body bounciness, from 0 (no bounciness) to 1 (max bounciness).
+
+
@@ -31720,32 +31733,89 @@ This method controls whether the position between two cached points is interpola
Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body.
-
-
-
-
- Return whether the body has the ability to fall asleep when not moving. See [method set_can_sleep].
-
-
-
-
+
+
- Set the axis lock of the body, from the AXIS_LOCK_* enum. Axis lock stops the body from moving along the specified axis(X/Y/Z) and rotating along the other two axes.
+ Enable contact monitoring. This allows the body to emit signals when it collides with another.
-
-
-
+
+
+
- Return the current axis lock of the body. One of AXIS_LOCK_* enum.
+ Set the body friction, from 0 (frictionless) to 1 (max friction).
-
-
-
+
+
+
- Return a list of the bodies colliding with this one.
+ Set the gravity factor. This factor multiplies gravity intensity just for this body.
+
+
+
+
+
+
+ Set the linear damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden.
+
+
+
+
+
+
+ Set the body linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state.
+
+
+
+
+
+
+ Set the body mass.
+
+
+
+
+
+
+ Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0.
+
+
+
+
+
+
+ Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body.
+
+
+
+
+
+
+ Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] wakes them up. Until then, they behave like a static body.
+
+
+
+
+
+
+ Set the continuous collision detection mode from the enum CCD_MODE_*.
+ Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fast-moving objects.
+
+
+
+
+
+
+ Pass true to disable the internal force integration (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined.
+
+
+
+
+
+
+ Set the body weight given standard earth-weight (gravity 9.8).
@@ -31799,18 +31869,18 @@ This method controls whether the position between two cached points is interpola
-
- Static mode. The body behaves like a [StaticBody], and can only move by user code.
-
-
- Kinematic body. The body behaves like a [KinematicBody], and can only move by user code.
-
Rigid body. This is the "natural" state of a rigid body. It is affected by forces, and can move, rotate, and be affected by user code.
+
+ Static mode. The body behaves like a [StaticBody], and can only move by user code.
+
Character body. This behaves like a rigid body, but can not rotate.
+
+ Kinematic body. The body behaves like a [KinematicBody], and can only move by user code.
+
@@ -31830,222 +31900,13 @@ This method controls whether the position between two cached points is interpola
Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default it works in addition to the usual physics behavior, but [method set_use_custom_integrator] allows you to disable the default behavior and do fully custom force integration for a body.
-
-
+
+
+
+
- Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body.
-
-
-
-
-
-
- Return the current body mode, see [method set_mode].
-
-
-
-
-
-
- Set the body mass.
-
-
-
-
-
-
- Return the body mass.
-
-
-
-
-
-
- Return the body's moment of inertia. This is usually automatically computed from the mass and the shapes. Note that this doesn't seem to work in a [code]_ready[/code] function: it apparently has not been auto-computed yet.
-
-
-
-
-
-
- Set the body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it.
-
-
-
-
-
-
- Set the body weight given standard earth-weight (gravity 9.8). Not really useful for 2D since most measures for this node are in pixels.
-
-
-
-
-
-
- Return the body weight given standard earth-weight (gravity 9.8).
-
-
-
-
-
-
- Set the body friction, from 0 (frictionless) to 1 (full friction).
-
-
-
-
-
-
- Return the body friction.
-
-
-
-
-
-
- Set the body bounciness, from 0 (no bounce) to 1 (full bounce).
-
-
-
-
-
-
- Return the body bounciness.
-
-
-
-
-
-
- Set the gravity factor. This factor multiplies gravity intensity just for this body.
-
-
-
-
-
-
- Return the gravity factor.
-
-
-
-
-
-
- Set the linear damp for this body. If this value is different from -1, any linear damp derived from the world or areas will be overridden.
-
-
-
-
-
-
- Return the linear damp for this body.
-
-
-
-
-
-
- Set the angular damp for this body. If this value is different from -1, any angular damp derived from the world or areas will be overridden.
-
-
-
-
-
-
- Return the angular damp for this body.
-
-
-
-
-
-
- Set the body linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state.
-
-
-
-
-
-
- Return the body linear velocity. This changes by physics granularity. See [method set_linear_velocity].
-
-
-
-
-
-
- Set the body angular velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state.
-
-
-
-
-
-
- Return the body angular velocity. This changes by physics granularity. See [method set_angular_velocity].
-
-
-
-
-
-
- Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0.
-
-
-
-
-
-
- Return the maximum contacts that can be reported. See [method set_max_contacts_reported].
-
-
-
-
-
-
- Pass true to disable the internal force integration (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined.
-
-
-
-
-
-
- Return true if the body is not doing any built-in force integration.
-
-
-
-
-
-
- Enable contact monitoring. This allows the body to emit signals when it collides with another.
-
-
-
-
-
-
- Return whether contact monitoring is enabled.
-
-
-
-
-
-
- Set the continuous collision detection mode from the enum CCD_MODE_*.
- Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fast-moving objects.
-
-
-
-
-
-
- Return whether this body is using continuous collision detection.
-
-
-
-
-
-
- Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
+ Add a positioned force to the applied force and torque. As with [method apply_impulse], both the force and the offset from the body origin are in global coordinates.
@@ -32057,11 +31918,18 @@ This method controls whether the position between two cached points is interpola
Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the offset from the body origin are in global coordinates.
-
-
-
+
+
+
- Set the applied force vector. This is the equivalent of pushing a box over the ground: the force applied is applied constantly.
+ Return the angular damp for this body.
+
+
+
+
+
+
+ Return the body angular velocity. This changes by physics granularity. See [method set_angular_velocity].
@@ -32071,13 +31939,6 @@ This method controls whether the position between two cached points is interpola
Return the applied force vector.
-
-
-
-
- Set a constant torque which will be applied to this body.
-
-
@@ -32085,20 +31946,102 @@ This method controls whether the position between two cached points is interpola
Return the torque which is being applied to this body.
-
-
-
-
-
+
+
+
- Add a positioned force to the applied force and torque. As with [method apply_impulse], both the force and the offset from the body origin are in global coordinates.
+ Return the body bounciness.
-
-
-
+
+
+
- Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body.
+ Return a list of the bodies colliding with this one.
+
+
+
+
+
+
+ Return whether this body is using continuous collision detection.
+
+
+
+
+
+
+ Return the body friction.
+
+
+
+
+
+
+ Return the gravity factor.
+
+
+
+
+
+
+ Return the body's moment of inertia. This is usually automatically computed from the mass and the shapes. Note that this doesn't seem to work in a [code]_ready[/code] function: it apparently has not been auto-computed yet.
+
+
+
+
+
+
+ Return the linear damp for this body.
+
+
+
+
+
+
+ Return the body linear velocity. This changes by physics granularity. See [method set_linear_velocity].
+
+
+
+
+
+
+ Return the body mass.
+
+
+
+
+
+
+ Return the maximum contacts that can be reported. See [method set_max_contacts_reported].
+
+
+
+
+
+
+ Return the current body mode, see [method set_mode].
+
+
+
+
+
+
+ Return the body weight given standard earth-weight (gravity 9.8).
+
+
+
+
+
+
+ Return true if the body has the ability to fall asleep when not moving. See [method set_can_sleep].
+
+
+
+
+
+
+ Return whether contact monitoring is enabled.
@@ -32108,6 +32051,55 @@ This method controls whether the position between two cached points is interpola
Return whether the body is sleeping.
+
+
+
+
+ Return true if the body is not doing any built-in force integration.
+
+
+
+
+
+
+ Set the angular damp for this body. If this value is different from -1, any angular damp derived from the world or areas will be overridden.
+
+
+
+
+
+
+ Set the body angular velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state.
+
+
+
+
+
+
+ Set the applied force vector. This is the equivalent of pushing a box over the ground: the force applied is applied constantly.
+
+
+
+
+
+
+ Set a constant torque which will be applied to this body.
+
+
+
+
+
+
+ Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
+
+
+
+
+
+
+ Set the body bounciness, from 0 (no bounce) to 1 (full bounce).
+
+
@@ -32116,11 +32108,96 @@ This method controls whether the position between two cached points is interpola
Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body.
-
-
-
+
+
+
- Return true if the body has the ability to fall asleep when not moving. See [method set_can_sleep].
+ Enable contact monitoring. This allows the body to emit signals when it collides with another.
+
+
+
+
+
+
+ Set the continuous collision detection mode from the enum CCD_MODE_*.
+ Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fast-moving objects.
+
+
+
+
+
+
+ Set the body friction, from 0 (frictionless) to 1 (full friction).
+
+
+
+
+
+
+ Set the gravity factor. This factor multiplies gravity intensity just for this body.
+
+
+
+
+
+
+ Set the body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it.
+
+
+
+
+
+
+ Set the linear damp for this body. If this value is different from -1, any linear damp derived from the world or areas will be overridden.
+
+
+
+
+
+
+ Set the body linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state.
+
+
+
+
+
+
+ Set the body mass.
+
+
+
+
+
+
+ Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0.
+
+
+
+
+
+
+ Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body.
+
+
+
+
+
+
+ Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body.
+
+
+
+
+
+
+ Pass true to disable the internal force integration (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined.
+
+
+
+
+
+
+ Set the body weight given standard earth-weight (gravity 9.8). Not really useful for 2D since most measures for this node are in pixels.
@@ -32136,13 +32213,6 @@ This method controls whether the position between two cached points is interpola
Return whether the body would collide, if it tried to move in the given vector. This method allows two extra parameters: A margin, which increases slightly the size of the shapes involved in the collision detection, and an object of type [Physics2DTestMotionResult], which will store additional information about the collision (should there be one).
-
-
-
-
- Return a list of the bodies colliding with this one.
-
-
@@ -32194,18 +32264,6 @@ This method controls whether the position between two cached points is interpola
-
- Static mode. The body behaves like a [StaticBody2D], and can only move by user code.
-
-
- Kinematic body. The body behaves like a [KinematicBody2D], and can only move by user code.
-
-
- Rigid body. This is the "natural" state of a rigid body. It is affected by forces, and can move, rotate, and be affected by user code.
-
-
- Character body. This behaves like a rigid body, but can not rotate.
-
Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects.
@@ -32215,6 +32273,18 @@ This method controls whether the position between two cached points is interpola
Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise.
+
+ Rigid body. This is the "natural" state of a rigid body. It is affected by forces, and can move, rotate, and be affected by user code.
+
+
+ Static mode. The body behaves like a [StaticBody2D], and can only move by user code.
+
+
+ Character body. This behaves like a rigid body, but can not rotate.
+
+
+ Kinematic body. The body behaves like a [KinematicBody2D], and can only move by user code.
+
@@ -32225,9 +32295,7 @@ This method controls whether the position between two cached points is interpola
Room contains the data to define the bounds of a scene (using a BSP Tree). It is instanced by a [VisualInstance] node to create rooms. See that class documentation for more information about rooms.
-
-
-
+
@@ -32237,7 +32305,15 @@ This method controls whether the position between two cached points is interpola
-
+
+
+
+
+
+
+
+
+
@@ -32247,12 +32323,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
@@ -32263,24 +32333,12 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
@@ -32295,6 +32353,18 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
@@ -32319,6 +32389,13 @@ This method controls whether the position between two cached points is interpola
Calling this method overrides previously existing data. Stereo samples are interleaved pairs of left and right points (in that order), but count as one sample for length purposes.
+
+
+
+
+ Return sample data as little endian.
+
+
@@ -32326,13 +32403,6 @@ This method controls whether the position between two cached points is interpola
Return the sample format.
-
-
-
-
- Return whether the current sample was created as stereo.
-
-
@@ -32340,6 +32410,41 @@ This method controls whether the position between two cached points is interpola
Return the sample length in samples. Stereo samples count as one, even if they are made of a left and a right sample.
+
+
+
+
+ Return the loop begin position.
+
+
+
+
+
+
+ Return the loop end position.
+
+
+
+
+
+
+ Return the loop format.
+
+
+
+
+
+
+ Return the mix rate for the sample.
+
+
+
+
+
+
+ Return whether the current sample was created as stereo.
+
+
@@ -32351,41 +32456,6 @@ This method controls whether the position between two cached points is interpola
If the sample is stereo ([method is_stereo]), multiply it by 2.
-
-
-
-
- Return sample data as little endian.
-
-
-
-
-
-
- Set the mix rate for the sample (expected playback frequency).
-
-
-
-
-
-
- Return the mix rate for the sample.
-
-
-
-
-
-
- Set the loop format (use LOOP_* constants as argument).
-
-
-
-
-
-
- Return the loop format.
-
-
@@ -32393,13 +32463,6 @@ This method controls whether the position between two cached points is interpola
Set the loop begin position. It must be a valid frame and less than the loop end position.
-
-
-
-
- Return the loop begin position.
-
-
@@ -32407,11 +32470,18 @@ This method controls whether the position between two cached points is interpola
Set the loop end position. It must be a valid frame and greater than the loop begin position.
-
-
-
+
+
+
- Return the loop end position.
+ Set the loop format (use LOOP_* constants as argument).
+
+
+
+
+
+
+ Set the mix rate for the sample (expected playback frequency).
@@ -32478,13 +32548,13 @@ This method controls whether the position between two cached points is interpola
Remove the sample matching the given text ID.
-
+
+
+
-
-
- Set the volume (in dB) for the given sample.
+ Return the pitch scale for the given sample.
@@ -32505,13 +32575,13 @@ This method controls whether the position between two cached points is interpola
Set the pitch scale for the given sample.
-
-
-
+
+
+
- Return the pitch scale for the given sample.
+ Set the volume (in dB) for the given sample.
@@ -32526,145 +32596,140 @@ This method controls whether the position between two cached points is interpola
SamplePlayer is a [Node] meant for simple sample playback. A library of samples is loaded and played back "as is", without positioning or anything.
-
-
+
+
+
+
- Set the sample library for the player.
+ Return the current chorus send level for a given voice.
-
-
+
+
- Return the sample library used by the player.
+ Return the default chorus send level of the player.
-
-
-
+
+
+
- Set the polyphony of the player (maximum amount of simultaneous voices).
+ Return the default filter cutoff frequency of the player.
-
+
+
+
+
+ Return the default filter gain of the player.
+
+
+
+
+
+
+ Return the default filter resonance of the player.
+
+
+
- Return the polyphony of the player.
+ Return the default filter type in use (see FILTER_* constants) for the player.
-
+
+
+
+
+ Return the default panning of the player.
+
+
+
+
+
+
+ Return the default pan depth of the player.
+
+
+
+
+
+
+ Return the default pan height of the player.
+
+
+
+
+
+
+ Return the default pitch scale of the player.
+
+
+
+
+
+
+ Return the default reverberation send level of the player.
+
+
+
-
-
-
-
- Play a sample referenced by its name.
- Optionally, the playback can be made "unique" to force stopping all other samples currently played. The voices allocated for playback will then be returned.
+ Return the default reverberation room type of the player (see REVERB_* enum).
-
+
+
+
+
+ Return the default volume (on a linear scale) of the player.
+
+
+
+
+
+
+ Return the default volume (in dB) of the player.
+
+
+
+
+
- Stop a given voice.
+ Return the current filter cutoff frequency for a given voice.
-
-
- Stop all playing voices.
-
-
-
+
+
+
-
-
- Set the mix rate (in Hz) of a given voice.
+ Return the current filter gain for a given voice.
-
+
+
+
-
-
- Set the pitch scale of a given voice. A ratio of 1.0 is the normal scale.
+ Return the current filter resonance for a given voice.
-
+
+
+
-
-
- Set the volume of a given voice using a linear scale.
- The "volume" argument should be a positive factor ranging from 0.0 (mute) up to 16.0 (i.e. 24 dB).
- A factor of 1.0 means that the voice will be played at normal system volume. Factors above 1.0 might be limited by the platform's audio output.
-
-
-
-
-
-
-
-
- Set the volume of a given voice in dB.
- The "dB" argument can range from -80 to 24 dB, 0 dB being the maximum volume. Every 6 dB (resp. -6 dB), the volume is increased (resp. reduced) by half.
-
-
-
-
-
-
-
-
-
-
-
-
- Set the panning of a voice. Panning goes from -1.0 (left) to +1.0 (right).
- Optionally, for hardware than support 3D sound, one can also set depth and height (also in range -1.0 to +1.0).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Set the filter for a given voice, using the given type (see FILTER_* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0).
- Optionally, a gain can also be given (from 0 to 2.0).
-
-
-
-
-
-
-
-
- Set the chorus send level of a voice (from 0 to 1.0). For setting chorus parameters, see [AudioServer].
-
-
-
-
-
-
-
-
-
-
- Set the reverberation type (see REVERB_* constants) and send level (from 0 to 1.0) of a voice.
+ Return the current filter type in use (see FILTER_* constants) for a given voice.
@@ -32676,33 +32741,6 @@ This method controls whether the position between two cached points is interpola
Return the current mix rate for a given voice.
-
-
-
-
-
-
- Return the current pitch scale for a given voice.
-
-
-
-
-
-
-
-
- Return the current volume (on a linear scale) for a given voice.
-
-
-
-
-
-
-
-
- Return the current volume (in dB) for a given voice.
-
-
@@ -32730,58 +32768,20 @@ This method controls whether the position between two cached points is interpola
Return the current pan height for a given voice.
-
+
+
+
+
+
+
+ Return the current pitch scale for a given voice.
+
+
+
-
-
- Return the current filter type in use (see FILTER_* constants) for a given voice.
-
-
-
-
-
-
-
-
- Return the current filter cutoff frequency for a given voice.
-
-
-
-
-
-
-
-
- Return the current filter resonance for a given voice.
-
-
-
-
-
-
-
-
- Return the current filter gain for a given voice.
-
-
-
-
-
-
-
-
- Return the current chorus send level for a given voice.
-
-
-
-
-
-
-
-
- Return the current reverberation room type for a given voice (see REVERB_* enum).
+ Return the polyphony of the player.
@@ -32793,6 +32793,110 @@ This method controls whether the position between two cached points is interpola
Return the current reverberation send level for a given voice.
+
+
+
+
+
+
+ Return the current reverberation room type for a given voice (see REVERB_* enum).
+
+
+
+
+
+
+ Return the sample library used by the player.
+
+
+
+
+
+
+
+
+ Return the current volume (on a linear scale) for a given voice.
+
+
+
+
+
+
+
+
+ Return the current volume (in dB) for a given voice.
+
+
+
+
+
+
+ Return whether the player is currently active.
+
+
+
+
+
+
+
+
+ Return whether the given voice is currently active.
+
+
+
+
+
+
+
+
+
+
+ Play a sample referenced by its name.
+ Optionally, the playback can be made "unique" to force stopping all other samples currently played. The voices allocated for playback will then be returned.
+
+
+
+
+
+
+
+
+ Set the chorus send level of a voice (from 0 to 1.0). For setting chorus parameters, see [AudioServer].
+
+
+
+
+
+
+ Set the default chorus send level of the player (from 0 to 1.0). For setting chorus parameters, see [AudioServer].
+
+
+
+
+
+
+
+
+
+
+
+
+ Set the default filter for the player, using the given type (see FILTER_* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0).
+ Optionally, a gain can also be given (from 0 to 2.0).
+
+
+
+
+
+
+
+
+
+
+ Set the default panning of the player. Panning goes from -1.0 (left) to +1.0 (right).
+ Optionally, for hardware than support 3D sound, one can also set depth and height (also in range -1.0 to +1.0).
+
+
@@ -32800,6 +32904,15 @@ This method controls whether the position between two cached points is interpola
Set the default pitch scale of the player. A ratio of 1.0 is the normal scale.
+
+
+
+
+
+
+ Set the default reverberation type (see REVERB_* constants) and send level (from 0 to 1.0) of the player.
+
+
@@ -32817,153 +32930,110 @@ This method controls whether the position between two cached points is interpola
The "dB" argument can range from -80 to 24 dB, 0 dB being the maximum volume. Every 6 dB (resp. -6 dB), the volume is increased (resp. reduced) by half.
-
-
+
+
-
+
-
+
+
+
+
+
- Set the default panning of the player. Panning goes from -1.0 (left) to +1.0 (right).
- Optionally, for hardware than support 3D sound, one can also set depth and height (also in range -1.0 to +1.0).
-
-
-
-
-
-
-
-
-
-
-
-
- Set the default filter for the player, using the given type (see FILTER_* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0).
+ Set the filter for a given voice, using the given type (see FILTER_* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0).
Optionally, a gain can also be given (from 0 to 2.0).
-
-
+
+
+
+
- Set the default chorus send level of the player (from 0 to 1.0). For setting chorus parameters, see [AudioServer].
+ Set the mix rate (in Hz) of a given voice.
-
-
+
+
-
+
+
+
+
+
- Set the default reverberation type (see REVERB_* constants) and send level (from 0 to 1.0) of the player.
+ Set the panning of a voice. Panning goes from -1.0 (left) to +1.0 (right).
+ Optionally, for hardware than support 3D sound, one can also set depth and height (also in range -1.0 to +1.0).
-
-
-
+
+
+
+
+
- Return the default pitch scale of the player.
+ Set the pitch scale of a given voice. A ratio of 1.0 is the normal scale.
-
-
-
+
+
+
- Return the default volume (on a linear scale) of the player.
+ Set the polyphony of the player (maximum amount of simultaneous voices).
-
-
-
+
+
+
+
+
+
+
- Return the default volume (in dB) of the player.
+ Set the reverberation type (see REVERB_* constants) and send level (from 0 to 1.0) of a voice.
-
-
-
+
+
+
- Return the default panning of the player.
+ Set the sample library for the player.
-
-
-
+
+
+
+
+
- Return the default pan depth of the player.
+ Set the volume of a given voice using a linear scale.
+ The "volume" argument should be a positive factor ranging from 0.0 (mute) up to 16.0 (i.e. 24 dB).
+ A factor of 1.0 means that the voice will be played at normal system volume. Factors above 1.0 might be limited by the platform's audio output.
-
-
-
+
+
+
+
+
- Return the default pan height of the player.
+ Set the volume of a given voice in dB.
+ The "dB" argument can range from -80 to 24 dB, 0 dB being the maximum volume. Every 6 dB (resp. -6 dB), the volume is increased (resp. reduced) by half.
-
-
-
-
- Return the default filter type in use (see FILTER_* constants) for the player.
-
-
-
-
-
-
- Return the default filter cutoff frequency of the player.
-
-
-
-
-
-
- Return the default filter resonance of the player.
-
-
-
-
-
-
- Return the default filter gain of the player.
-
-
-
-
-
-
- Return the default chorus send level of the player.
-
-
-
-
-
-
- Return the default reverberation room type of the player (see REVERB_* enum).
-
-
-
-
-
-
- Return the default reverberation send level of the player.
-
-
-
-
-
-
- Return whether the player is currently active.
-
-
-
-
-
+
- Return whether the given voice is currently active.
+ Stop a given voice.
+
+
+
+
+ Stop all playing voices.
@@ -32995,6 +33065,9 @@ This method controls whether the position between two cached points is interpola
High-shelf filter is used for voice.
+
+ Value returned if the voice ID is invalid.
+
Small reverberation room (house room).
@@ -33007,9 +33080,6 @@ This method controls whether the position between two cached points is interpola
Huge reverberation room (cathedral, warehouse).
-
- Value returned if the voice ID is invalid.
-
@@ -33020,11 +33090,18 @@ This method controls whether the position between two cached points is interpola
Sample player for positional 2D Sound. Plays sound samples positionally, left and right depending on the distance/place on the screen.
-
-
-
+
+
+
- Set the sample library for the player.
+ Return the polyphony of the player.
+
+
+
+
+
+
+ Return the amplitude used for random pitch scale variations.
@@ -33034,18 +33111,13 @@ This method controls whether the position between two cached points is interpola
Return the sample library used by the player.
-
-
+
+
+
+
- Set the polyphony of the player (maximum amount of simultaneous voices).
-
-
-
-
-
-
- Return the polyphony of the player.
+ Return whether a voice is still active or has stopped playing.
@@ -33060,6 +33132,42 @@ This method controls whether the position between two cached points is interpola
Return a voice ID which can be used to modify the voice parameters, or INVALID_VOICE if the voice or sample are invalid.
+
+
+
+
+ Set the polyphony of the player (maximum amount of simultaneous voices).
+
+
+
+
+
+
+ Set the amplitude for random pitch scale variations. If different from zero, the pitch scale will vary randomly around 1.0 in a range defined by val.
+ The actual pitch scale will be, with "variation" ranging from -val to val:
+ * variation > 0: 1.0 + variation
+ * variation < 0: 1.0/(1.0 - variation)
+
+
+
+
+
+
+ Set the sample library for the player.
+
+
+
+
+ Stop all playing voices.
+
+
+
+
+
+
+ Stop a given voice.
+
+
@@ -33078,44 +33186,6 @@ This method controls whether the position between two cached points is interpola
Change the volume scale (in dB) of a currently playing voice.
-
-
-
-
-
-
- Return whether a voice is still active or has stopped playing.
-
-
-
-
-
-
- Stop a given voice.
-
-
-
-
- Stop all playing voices.
-
-
-
-
-
-
- Set the amplitude for random pitch scale variations. If different from zero, the pitch scale will vary randomly around 1.0 in a range defined by val.
- The actual pitch scale will be, with "variation" ranging from -val to val:
- * variation > 0: 1.0 + variation
- * variation < 0: 1.0/(1.0 - variation)
-
-
-
-
-
-
- Return the amplitude used for random pitch scale variations.
-
-
@@ -33132,13 +33202,83 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -33154,16 +33294,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
@@ -33172,34 +33302,12 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -33230,21 +33338,7 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -33252,32 +33346,8 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
@@ -33294,28 +33364,66 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
-
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
+
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -33338,89 +33446,111 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
@@ -33434,75 +33564,27 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
@@ -33512,15 +33594,7 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
+
@@ -33528,10 +33602,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
@@ -33542,18 +33612,18 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
+
+
+
+
+
+
@@ -33573,13 +33643,11 @@ This method controls whether the position between two cached points is interpola
Return true if this script can be instance (ie not a library).
-
-
+
+
-
-
- Return true if a given object uses an instance of this script.
+ Return the script source code (if available).
@@ -33589,18 +33657,13 @@ This method controls whether the position between two cached points is interpola
Return true if the script contains source code.
-
-
+
+
-
- Return the script source code (if available).
-
-
-
-
+
- Set the script source code.
+ Return true if a given object uses an instance of this script.
@@ -33611,6 +33674,13 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+ Set the script source code.
+
+
@@ -33623,18 +33693,18 @@ This method controls whether the position between two cached points is interpola
Scrollbars are a [Range] based [Control], that display a draggable area (the size of the page). Horizontal ([HScrollBar]) and Vertical ([VScrollBar]) versions are available.
-
-
-
-
-
-
+
+
+
+
+
+
@@ -33647,11 +33717,18 @@ This method controls whether the position between two cached points is interpola
A ScrollContainer node with a [Control] child and scrollbar child ([HScrollbar], [VScrollBar], or both) will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a [Panel] control.
-
-
-
+
+
+
- Set allows horizontal scrool.
+ Return current horizontal scroll value.
+
+
+
+
+
+
+ Return current vertical scroll value.
@@ -33661,13 +33738,6 @@ This method controls whether the position between two cached points is interpola
Return true if horizontal scrool is allowed.
-
-
-
-
- Set allows vertical scrool.
-
-
@@ -33675,6 +33745,20 @@ This method controls whether the position between two cached points is interpola
Return true if vertical scrool is allowed.
+
+
+
+
+ Set allows horizontal scrool.
+
+
+
+
+
+
+ Set allows vertical scrool.
+
+
@@ -33682,13 +33766,6 @@ This method controls whether the position between two cached points is interpola
Set horizontal scroll value.
-
-
-
-
- Return current horizontal scroll value.
-
-
@@ -33696,13 +33773,6 @@ This method controls whether the position between two cached points is interpola
Set vertical scroll value.
-
-
-
-
- Return current vertical scroll value.
-
-
@@ -33715,13 +33785,6 @@ This method controls whether the position between two cached points is interpola
Segment Shape for 2D Collision Detection, consists of two points, 'a' and 'b'.
-
-
-
-
- Set the first point's position.
-
-
@@ -33729,13 +33792,6 @@ This method controls whether the position between two cached points is interpola
Return the first point's position.
-
-
-
-
- Set the second point's position.
-
-
@@ -33743,6 +33799,20 @@ This method controls whether the position between two cached points is interpola
Return the second point's position.
+
+
+
+
+ Set the first point's position.
+
+
+
+
+
+
+ Set the second point's position.
+
+
@@ -33755,13 +33825,6 @@ This method controls whether the position between two cached points is interpola
A synchronization Semaphore. Element used in multi-threadding. Initialized to zero on creation.
-
-
-
-
- Tries to wait for the [Semaphore], if it's value is zero, blocks until non-zero.
-
-
@@ -33769,6 +33832,13 @@ This method controls whether the position between two cached points is interpola
Lowers the [Semaphore], allowing one more thread in.
+
+
+
+
+ Tries to wait for the [Semaphore], if it's value is zero, blocks until non-zero.
+
+
@@ -33793,12 +33863,46 @@ This method controls whether the position between two cached points is interpola
To be changed, ignore.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -33813,24 +33917,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -33839,22 +33925,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -33871,513 +33941,9 @@ This method controls whether the position between two cached points is interpola
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -34401,18 +33967,20 @@ This method controls whether the position between two cached points is interpola
-
+
-
+
+
+
-
-
+
+
@@ -34421,6 +33989,16 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
@@ -34437,18 +34015,64 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
-
+
-
+
+
+
+
+
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -34475,18 +34099,66 @@ This method controls whether the position between two cached points is interpola
-
+
+
+
-
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -34501,6 +34173,404 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -34509,26 +34579,16 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -34549,10 +34609,12 @@ This method controls whether the position between two cached points is interpola
-
+
+
+
@@ -34569,6 +34631,8 @@ This method controls whether the position between two cached points is interpola
+
+
@@ -34581,81 +34645,17 @@ This method controls whether the position between two cached points is interpola
-
+
-
+
-
+
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -34679,23 +34679,11 @@ This method controls whether the position between two cached points is interpola
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -34717,22 +34705,104 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -34741,26 +34811,12 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -34769,6 +34825,20 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -34791,21 +34861,6 @@ This method controls whether the position between two cached points is interpola
Base class for all 2D Shapes. All 2D shape types inherit from this.
-
-
-
-
- Use a custom solver bias. No need to change this unless you really know what you are doing.
- The solver bias is a factor controlling how much two objects "rebound" off each other, when colliding, to avoid them getting into each other because of numerical imprecision.
-
-
-
-
-
-
- Return the custom solver bias.
-
-
@@ -34820,6 +34875,20 @@ This method controls whether the position between two cached points is interpola
This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]).
+
+
+
+
+
+
+
+
+
+
+ Return a list of the points where this shape touches another. If there are no collisions, the list is empty.
+ This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]).
+
+
@@ -34838,20 +34907,6 @@ This method controls whether the position between two cached points is interpola
This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]).
-
-
-
-
-
-
-
-
-
-
- Return a list of the points where this shape touches another. If there are no collisions, the list is empty.
- This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]).
-
-
@@ -34870,6 +34925,21 @@ This method controls whether the position between two cached points is interpola
This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]).
+
+
+
+
+ Return the custom solver bias.
+
+
+
+
+
+
+ Use a custom solver bias. No need to change this unless you really know what you are doing.
+ The solver bias is a factor controlling how much two objects "rebound" off each other, when colliding, to avoid them getting into each other because of numerical imprecision.
+
+
@@ -34880,9 +34950,9 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
@@ -34892,12 +34962,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
@@ -34906,12 +34970,18 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
+
+
+
+
+
+
@@ -34931,6 +35001,20 @@ This method controls whether the position between two cached points is interpola
Add a bone, with name "name". [method get_bone_count] will become the bone index.
+
+
+
+
+
+
+ Deprecated soon.
+
+
+
+
+ Clear all the bones in this skeleton.
+
+
@@ -34940,6 +35024,29 @@ This method controls whether the position between two cached points is interpola
Return the bone index that matches "name" as its name.
+
+
+
+
+ Return the amount of bones in the skeleton.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -34958,26 +35065,13 @@ This method controls whether the position between two cached points is interpola
Return the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx".
-
-
-
-
-
-
- Set the bone index "parent_idx" as the parent of the bone at "bone_idx". If -1, then bone has no parent. Note: "parent_idx" must be less than "bone_idx".
-
-
-
-
+
+
-
- Return the amount of bones in the skeleton.
-
-
-
+ Return the pose transform for bone "bone_idx".
@@ -34989,49 +35083,14 @@ This method controls whether the position between two cached points is interpola
Return the rest transform for a bone "bone_idx".
-
-
-
-
-
-
- Set the rest transform for bone "bone_idx"
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
-
- Deprecated soon.
-
-
-
-
-
-
-
-
- Deprecated soon.
-
-
@@ -35041,47 +35100,8 @@ This method controls whether the position between two cached points is interpola
Deprecated soon.
-
-
- Clear all the bones in this skeleton.
-
-
-
-
-
-
-
-
- Return the pose transform for bone "bone_idx".
-
-
-
-
-
-
-
-
- Return the pose transform for bone "bone_idx".
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
@@ -35096,9 +35116,59 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Set the bone index "parent_idx" as the parent of the bone at "bone_idx". If -1, then bone has no parent. Note: "parent_idx" must be less than "bone_idx".
+
+
+
+
+
+
+
+
+ Return the pose transform for bone "bone_idx".
+
+
+
+
+
+
+
+
+ Set the rest transform for bone "bone_idx"
+
+
+
+
+
+
+
+
+ Deprecated soon.
+
+
+
@@ -35118,13 +35188,6 @@ This method controls whether the position between two cached points is interpola
Base class for GUI Sliders.
-
-
-
-
- Set amount of ticks to display in slider.
-
-
@@ -35139,6 +35202,13 @@ This method controls whether the position between two cached points is interpola
Return true if ticks are visible on borders.
+
+
+
+
+ Set amount of ticks to display in slider.
+
+
@@ -35156,14 +35226,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
@@ -35172,28 +35234,20 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -35214,12 +35268,28 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -35230,14 +35300,6 @@ This method controls whether the position between two cached points is interpola
Base class for playing spatial 2D sound.
-
-
-
-
-
-
-
-
@@ -35246,6 +35308,14 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
@@ -35268,14 +35338,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
@@ -35284,27 +35346,35 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
+
+
+
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
@@ -35320,73 +35390,10 @@ This method controls whether the position between two cached points is interpola
Spatial is the base for every type of 3D [Node]. It contains a 3D [Transform] which can be set or get as local or global. If a Spatial [Node] has Spatial children, their transforms will be relative to the parent.
-
-
-
-
- Set the transform locally, relative to the parent spatial node.
-
-
-
-
+
+
- Return the local transform, relative to the bone parent.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Set the transform globally, relative to worldspace.
@@ -35403,20 +35410,33 @@ This method controls whether the position between two cached points is interpola
Return the parent [Spatial], or an empty [Object] if no parent exists or parent is not of type [Spatial].
-
-
-
+
+
+
-
-
-
+
+
+
-
-
+
+
+
+
+
+
+
+
+
+
+ Return the local transform, relative to the bone parent.
+
+
+
+
@@ -35427,23 +35447,17 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
+
+
+
+
-
-
-
-
-
-
-
+
+
+
@@ -35451,45 +35465,53 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -35515,19 +35537,28 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
-
-
+
+
-
+
+
+
+
+ Set the transform globally, relative to worldspace.
+
+
+
+
+
@@ -35535,24 +35566,63 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
+
+
-
-
+
+
-
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Set the transform locally, relative to the parent spatial node.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -35588,14 +35658,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
@@ -35604,6 +35666,14 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
@@ -35630,9 +35700,9 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
@@ -35642,15 +35712,11 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
+
+
+
+
@@ -35664,6 +35730,28 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -35680,24 +35768,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -35754,124 +35824,90 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -35884,15 +35920,49 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -35906,18 +35976,18 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
+
+
+
+
+
+
@@ -35930,11 +36000,16 @@ This method controls whether the position between two cached points is interpola
SpinBox is a numerical input text field. It allows entering integers and floats.
-
-
-
+
+
+
+
+
+
+
+
+
- Set a specific suffix.
@@ -35944,17 +36019,11 @@ This method controls whether the position between two cached points is interpola
Return the specific suffix.
-
-
-
-
- Set a prefix.
-
-
-
-
+
+
+ Return if the spinbox is editable.
@@ -35964,17 +36033,18 @@ This method controls whether the position between two cached points is interpola
Set whether the spinbox is editable.
-
-
-
+
+
+
- Return if the spinbox is editable.
+ Set a prefix.
-
-
-
+
+
+
+ Set a specific suffix.
@@ -35993,11 +36063,11 @@ This method controls whether the position between two cached points is interpola
Container for splitting two controls vertically or horizontally, with a grabber that allows adjusting the split offset or ratio.
-
-
-
+
+
+
- Set the split offset.
+ Return visibility of the split dragger(One of [DRAGGER_VISIBLE], [DRAGGER_HIDDEN] or [DRAGGER_HIDDEN_COLLAPSED]).
@@ -36007,13 +36077,6 @@ This method controls whether the position between two cached points is interpola
Return the split offset.
-
-
-
-
- Set if the split must be collapsed.
-
-
@@ -36021,6 +36084,13 @@ This method controls whether the position between two cached points is interpola
Return true if the split is collapsed.
+
+
+
+
+ Set if the split must be collapsed.
+
+
@@ -36028,11 +36098,11 @@ This method controls whether the position between two cached points is interpola
Set visibility of the split dragger([i]mode[/i] must be one of [DRAGGER_VISIBLE], [DRAGGER_HIDDEN] or [DRAGGER_HIDDEN_COLLAPSED]).
-
-
-
+
+
+
- Return visibility of the split dragger(One of [DRAGGER_VISIBLE], [DRAGGER_HIDDEN] or [DRAGGER_HIDDEN_COLLAPSED]).
+ Set the split offset.
@@ -36077,111 +36147,6 @@ This method controls whether the position between two cached points is interpola
General purpose Sprite node. This Sprite node can show any texture as a sprite. The texture can be used as a spritesheet for animation, or only a region from a bigger texture can referenced, like an atlas.
-
-
-
-
- Set the base texture for the sprite.
-
-
-
-
-
-
- Return the base texture for the sprite.
-
-
-
-
-
-
- Set whether the sprite should be centered on the origin.
-
-
-
-
-
-
- Return if the sprite is centered at the local origin.
-
-
-
-
-
-
- Set the sprite draw offset, useful for setting rotation pivots.
-
-
-
-
-
-
- Return sprite draw offset.
-
-
-
-
-
-
- Set true to flip the sprite horizontally.
-
-
-
-
-
-
- Return true if the sprite is flipped horizontally.
-
-
-
-
-
-
- Set true to flip the sprite vertically.
-
-
-
-
-
-
- Return true if the sprite is flipped vertically.
-
-
-
-
-
-
- Set the sprite as a sub-region of a bigger texture. Useful for texture-atlases.
-
-
-
-
-
-
- Return if the sprite reads from a region.
-
-
-
-
-
-
- Set the region rect to read from.
-
-
-
-
-
-
- Return the region rect to read from.
-
-
-
-
-
-
- Set the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1.
-
-
@@ -36189,27 +36154,6 @@ This method controls whether the position between two cached points is interpola
Return the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1.
-
-
-
-
- Set the amount of vertical frames and converts the sprite into a sprite-sheet. This is useful for animation.
-
-
-
-
-
-
- Return the amount of vertical frames. See [method set_vframes].
-
-
-
-
-
-
- Set the amount of horizontal frames and converts the sprite into a sprite-sheet. This is useful for animation.
-
-
@@ -36217,6 +36161,104 @@ This method controls whether the position between two cached points is interpola
Return the amount of horizontal frames. See [method set_hframes].
+
+
+
+
+ Return color modulation for the sprite. All sprite pixels are multiplied by this color.
+
+
+
+
+
+
+ Return sprite draw offset.
+
+
+
+
+
+
+ Return the region rect to read from.
+
+
+
+
+
+
+ Return the base texture for the sprite.
+
+
+
+
+
+
+ Return the amount of vertical frames. See [method set_vframes].
+
+
+
+
+
+
+ Return if the sprite is centered at the local origin.
+
+
+
+
+
+
+ Return true if the sprite is flipped horizontally.
+
+
+
+
+
+
+ Return true if the sprite is flipped vertically.
+
+
+
+
+
+
+ Return if the sprite reads from a region.
+
+
+
+
+
+
+ Set whether the sprite should be centered on the origin.
+
+
+
+
+
+
+ Set true to flip the sprite horizontally.
+
+
+
+
+
+
+ Set true to flip the sprite vertically.
+
+
+
+
+
+
+ Set the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1.
+
+
+
+
+
+
+ Set the amount of horizontal frames and converts the sprite into a sprite-sheet. This is useful for animation.
+
+
@@ -36224,11 +36266,39 @@ This method controls whether the position between two cached points is interpola
Set color modulation for the sprite. All sprite pixels are multiplied by this color. Color may contain rgb values above 1 to achieve a highlight effect.
-
-
-
+
+
+
- Return color modulation for the sprite. All sprite pixels are multiplied by this color.
+ Set the sprite draw offset, useful for setting rotation pivots.
+
+
+
+
+
+
+ Set the sprite as a sub-region of a bigger texture. Useful for texture-atlases.
+
+
+
+
+
+
+ Set the region rect to read from.
+
+
+
+
+
+
+ Set the base texture for the sprite.
+
+
+
+
+
+
+ Set the amount of vertical frames and converts the sprite into a sprite-sheet. This is useful for animation.
@@ -36247,9 +36317,21 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -36259,9 +36341,9 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
@@ -36271,51 +36353,39 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -36335,110 +36405,18 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -36447,38 +36425,130 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
+
+
+
+
+
+
@@ -36495,6 +36565,60 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -36509,6 +36633,14 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
@@ -36517,22 +36649,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -36541,38 +36657,10 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -36587,24 +36675,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -36619,25 +36689,11 @@ This method controls whether the position between two cached points is interpola
Alternatively, a constant linear or angular velocity can be set for the static body, so even if it doesn't move, it affects other bodies as if it was moving (this is useful for simulating conveyor belts or conveyor wheels).
-
-
-
-
- Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving.
-
-
-
-
-
-
- Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating.
-
-
-
-
+
+
- Return the constant linear velocity for the body.
+ Return the body bounciness.
@@ -36647,11 +36703,11 @@ This method controls whether the position between two cached points is interpola
Return the constant angular velocity for the body.
-
-
-
+
+
+
- Set the body friction, from 0 (frictionless) to 1 (full friction).
+ Return the constant linear velocity for the body.
@@ -36668,11 +36724,25 @@ This method controls whether the position between two cached points is interpola
Set the body bounciness, from 0 (not bouncy) to 1 (bouncy).
-
-
-
+
+
+
- Return the body bounciness.
+ Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating.
+
+
+
+
+
+
+ Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving.
+
+
+
+
+
+
+ Set the body friction, from 0 (frictionless) to 1 (full friction).
@@ -36689,25 +36759,11 @@ This method controls whether the position between two cached points is interpola
Alternatively, a constant linear or angular velocity can be set for the static body, so even if it doesn't move, it affects other bodies as if it was moving (this is useful for simulating conveyor belts or conveyor wheels).
-
-
-
-
- Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving.
-
-
-
-
-
-
- Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating.
-
-
-
-
+
+
- Return the constant linear velocity for the body.
+ Return the body bounciness.
@@ -36717,11 +36773,11 @@ This method controls whether the position between two cached points is interpola
Return the constant angular velocity for the body.
-
-
-
+
+
+
- Set the body friction, from 0 (frictionless) to 1 (full friction).
+ Return the constant linear velocity for the body.
@@ -36738,11 +36794,25 @@ This method controls whether the position between two cached points is interpola
Set the body bounciness, from 0 (not bouncy) to 1 (bouncy).
-
-
-
+
+
+
- Return the body bounciness.
+ Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating.
+
+
+
+
+
+
+ Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving.
+
+
+
+
+
+
+ Set the body friction, from 0 (frictionless) to 1 (full friction).
@@ -36757,22 +36827,39 @@ This method controls whether the position between two cached points is interpola
StreamPeer is an abstraction and base class for stream-based protocols (such as TCP or Unix Sockets). It provides an API for sending and receiving data through streams as raw data or strings.
-
+
-
-
- Send a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an Error code.
+ Get a signed 16 bit value from the stream.
-
-
+
+
-
-
- Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an Error code and an integer, describing how much data was actually sent.
+ Get a signed 32 bit value from the stream.
+
+
+
+
+
+
+ Get a signed 64 bit value from the stream.
+
+
+
+
+
+
+ Get a signed byte from the stream.
+
+
+
+
+
+
+ Return the amount of bytes this [StreamPeer] has available.
@@ -36784,174 +36871,11 @@ This method controls whether the position between two cached points is interpola
Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array.
-
-
-
-
-
-
- Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array.
-
-
-
-
+
+
- Return the amount of bytes this [StreamPeer] has available.
-
-
-
-
-
-
- Set this [StreamPeer] to use big-endian format. Default is false.
-
-
-
-
-
-
- Return whether this [StreamPeer] is using big-endian format.
-
-
-
-
-
-
- Put a signed byte into the stream.
-
-
-
-
-
-
- Put an unsigned byte into the stream.
-
-
-
-
-
-
- Put a signed 16 bit value into the stream.
-
-
-
-
-
-
- Put an unsigned 16 bit value into the stream.
-
-
-
-
-
-
- Put a signed 32 bit value into the stream.
-
-
-
-
-
-
- Put an unsigned 32 bit value into the stream.
-
-
-
-
-
-
- Put a signed 64 bit value into the stream.
-
-
-
-
-
-
- Put an unsigned 64 bit value into the stream.
-
-
-
-
-
-
- Put a single-precision float into the stream.
-
-
-
-
-
-
- Put a double-precision float into the stream.
-
-
-
-
-
-
- Put a zero-terminated utf8 string into the stream.
-
-
-
-
-
-
- Put a Variant into the stream.
-
-
-
-
-
-
- Get a signed byte from the stream.
-
-
-
-
-
-
- Get an unsigned byte from the stream.
-
-
-
-
-
-
- Get a signed 16 bit value from the stream.
-
-
-
-
-
-
- Get an unsigned 16 bit value from the stream.
-
-
-
-
-
-
- Get a signed 32 bit value from the stream.
-
-
-
-
-
-
- Get an unsigned 32 bit value from the stream.
-
-
-
-
-
-
- Get a signed 64 bit value from the stream.
-
-
-
-
-
-
- Get an unsigned 16 bit value from the stream.
+ Get a double-precision float from the stream.
@@ -36961,11 +36885,13 @@ This method controls whether the position between two cached points is interpola
Get a single-precision float from the stream.
-
-
+
+
+
+
- Get a double-precision float from the stream.
+ Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array.
@@ -36977,6 +36903,34 @@ This method controls whether the position between two cached points is interpola
Get a string with byte-length "bytes" from the stream.
+
+
+
+
+ Get an unsigned 16 bit value from the stream.
+
+
+
+
+
+
+ Get an unsigned 32 bit value from the stream.
+
+
+
+
+
+
+ Get an unsigned 16 bit value from the stream.
+
+
+
+
+
+
+ Get an unsigned byte from the stream.
+
+
@@ -36993,6 +36947,122 @@ This method controls whether the position between two cached points is interpola
Get a Variant from the stream.
+
+
+
+
+ Return whether this [StreamPeer] is using big-endian format.
+
+
+
+
+
+
+ Put a signed 16 bit value into the stream.
+
+
+
+
+
+
+ Put a signed 32 bit value into the stream.
+
+
+
+
+
+
+ Put a signed 64 bit value into the stream.
+
+
+
+
+
+
+ Put a signed byte into the stream.
+
+
+
+
+
+
+
+
+ Send a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an Error code.
+
+
+
+
+
+
+ Put a double-precision float into the stream.
+
+
+
+
+
+
+ Put a single-precision float into the stream.
+
+
+
+
+
+
+
+
+ Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an Error code and an integer, describing how much data was actually sent.
+
+
+
+
+
+
+ Put an unsigned 16 bit value into the stream.
+
+
+
+
+
+
+ Put an unsigned 32 bit value into the stream.
+
+
+
+
+
+
+ Put an unsigned 64 bit value into the stream.
+
+
+
+
+
+
+ Put an unsigned byte into the stream.
+
+
+
+
+
+
+ Put a zero-terminated utf8 string into the stream.
+
+
+
+
+
+
+ Put a Variant into the stream.
+
+
+
+
+
+
+ Set this [StreamPeer] to use big-endian format. Default is false.
+
+
@@ -37026,6 +37096,11 @@ This method controls whether the position between two cached points is interpola
Connect to a peer using an underlying [StreamPeer] "stream", when "validate_certs" is true, [StreamPeerSSL] will validate that the certificate presented by the peer matches the "for_hostname".
+
+
+ Disconnect from host.
+
+
@@ -37033,11 +37108,6 @@ This method controls whether the position between two cached points is interpola
Return the status of the connection, one of STATUS_* enum.
-
-
- Disconnect from host.
-
-
@@ -37073,18 +37143,9 @@ This method controls whether the position between two cached points is interpola
Connect to the specified IP:port pair. Returns [OK] on success or [FAILED] on failure.
-
-
-
+
- Return whether this peer is connected. Returns true while connecting and connected.
-
-
-
-
-
-
- Return the status of the connection, one of STATUS_* enum.
+ Disconnect from host.
@@ -37101,9 +37162,18 @@ This method controls whether the position between two cached points is interpola
Return the port of this peer.
-
+
+
+
- Disconnect from host.
+ Return the status of the connection, one of STATUS_* enum.
+
+
+
+
+
+
+ Return whether this peer is connected. Returns true while connecting and connected.
@@ -37130,103 +37200,6 @@ This method controls whether the position between two cached points is interpola
Base class for audio stream playback. Audio stream players inherit from it.
-
-
-
-
- Set the [EventStream] this player will play.
-
-
-
-
-
-
- Return the currently assigned stream.
-
-
-
-
-
-
- Play the currently assigned stream, starting from a given position (in seconds).
-
-
-
-
- Stop the playback.
-
-
-
-
-
-
- Return whether this player is playing.
-
-
-
-
-
-
- Pause stream playback.
-
-
-
-
-
-
- Return whether the playback is currently paused.
-
-
-
-
-
-
- Set whether the stream will be restarted at the end.
-
-
-
-
-
-
- Return whether the stream will be restarted at the end.
-
-
-
-
-
-
- Set the playback volume for this player. This is a float between 0.0 (silent) and 1.0 (full volume). Values over 1.0 will amplify sound even more, but may introduce distortion. Negative values will just invert the output waveform, which produces no audible difference.
-
-
-
-
-
-
- Return the playback volume for this player.
-
-
-
-
-
-
- Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for overamplifying (see [method set_volume]) still apply.
-
-
-
-
-
-
- Return the playback volume for this player, in decibels.
-
-
-
-
-
-
- Set the size (in milliseconds) of the audio buffer. A long audio buffer protects better against slowdowns, but responds worse to changes (in volume, stream played...). A shorter buffer takes less time to respond to changes, but may stutter if the application suffers some slowdown.
- Default is 500 milliseconds.
-
-
@@ -37234,25 +37207,11 @@ This method controls whether the position between two cached points is interpola
Return the size of the audio buffer.
-
-
-
-
- Set the point in time the stream will rewind to, when looping.
-
-
-
+
- Return the point in time the stream will rewind to, when looping.
-
-
-
-
-
-
- Return the name of the currently assigned stream. This is not the file name, but a field inside the file. If no stream is assigned, if returns "<No Stream>".
+ Return the length of the stream, in seconds.
@@ -37262,6 +37221,13 @@ This method controls whether the position between two cached points is interpola
Return the number of times the playback has looped.
+
+
+
+
+ Return the point in time the stream will rewind to, when looping.
+
+
@@ -37269,6 +37235,69 @@ This method controls whether the position between two cached points is interpola
Return the playback position, in seconds.
+
+
+
+
+ Return the currently assigned stream.
+
+
+
+
+
+
+ Return the name of the currently assigned stream. This is not the file name, but a field inside the file. If no stream is assigned, if returns "<No Stream>".
+
+
+
+
+
+
+ Return the playback volume for this player.
+
+
+
+
+
+
+ Return the playback volume for this player, in decibels.
+
+
+
+
+
+
+ Return whether this player will start playing as soon as it enters the scene tree.
+
+
+
+
+
+
+ Return whether the stream will be restarted at the end.
+
+
+
+
+
+
+ Return whether the playback is currently paused.
+
+
+
+
+
+
+ Return whether this player is playing.
+
+
+
+
+
+
+ Play the currently assigned stream, starting from a given position (in seconds).
+
+
@@ -37283,18 +37312,59 @@ This method controls whether the position between two cached points is interpola
Set whether this player will start playing as soon as it enters the scene tree.
-
-
-
+
+
+
- Return whether this player will start playing as soon as it enters the scene tree.
+ Set the size (in milliseconds) of the audio buffer. A long audio buffer protects better against slowdowns, but responds worse to changes (in volume, stream played...). A shorter buffer takes less time to respond to changes, but may stutter if the application suffers some slowdown.
+ Default is 500 milliseconds.
-
-
-
+
+
+
- Return the length of the stream, in seconds.
+ Set whether the stream will be restarted at the end.
+
+
+
+
+
+
+ Set the point in time the stream will rewind to, when looping.
+
+
+
+
+
+
+ Pause stream playback.
+
+
+
+
+
+
+ Set the [EventStream] this player will play.
+
+
+
+
+
+
+ Set the playback volume for this player. This is a float between 0.0 (silent) and 1.0 (full volume). Values over 1.0 will amplify sound even more, but may introduce distortion. Negative values will just invert the output waveform, which produces no audible difference.
+
+
+
+
+
+
+ Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for overamplifying (see [method set_volume]) still apply.
+
+
+
+
+ Stop the playback.
@@ -37819,6 +37889,15 @@ This method controls whether the position between two cached points is interpola
String Array. Array of strings. Can only contain strings. Optimized for memory usage, can't fragment the memory.
+
+
+
+
+
+
+ Create from a generic array.
+
+
@@ -37849,15 +37928,6 @@ This method controls whether the position between two cached points is interpola
Return the size of the array.
-
-
-
-
-
-
- Create from a generic array.
-
-
@@ -37870,24 +37940,18 @@ This method controls whether the position between two cached points is interpola
StyleBox is [Resource] that provides an abstract base class for drawing stylized boxes for the UI. StyleBoxes are used for drawing the styles of buttons, line edit backgrounds, tree backgrounds, etc. and also for testing a transparency mask for pointer signals. If mask test fails on a StyleBox assigned as mask to a control, clicks and motion signals will go through it to the one below.
-
-
-
-
+
+
- Test a position in a rectangle, return whether it passes the mask test.
-
-
-
-
-
+
+
+
- Set the default offset "offset" of the margin "margin" (see MARGIN_* enum) for a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded.
@@ -37915,12 +37979,6 @@ This method controls whether the position between two cached points is interpola
Return the minimum size that this stylebox can be shrunk to.
-
-
-
-
-
-
@@ -37928,12 +37986,24 @@ This method controls whether the position between two cached points is interpola
Return the "offset" of a stylebox, this is a helper function, like writing [code]Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))[/code].
-
-
+
+
+
+
+
+
+ Set the default offset "offset" of the margin "margin" (see MARGIN_* enum) for a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded.
+
+
+
+
+
+
+ Test a position in a rectangle, return whether it passes the mask test.
@@ -37960,69 +38030,27 @@ This method controls whether the position between two cached points is interpola
Stylebox of a single color. Displays the stylebox of a single color, alternatively a border with light/dark colors can be assigned.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
@@ -38032,6 +38060,48 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -38044,11 +38114,20 @@ This method controls whether the position between two cached points is interpola
This StyleBox is similar to [StyleBoxTexture], but only meant to be used for mask testing. It takes an image and applies stretch rules to determine if the point clicked is masked or not.
-
-
+
+
+
+
+ Return whether the expand property is set(default). When expanding, the image will use the same rules as [StyleBoxTexture] for expand. If not expanding, the image will always be tested at its original size.
+
+
+
+
+
+
- Set the image used for mask testing. Pixels (converted to grey) that have a value, less than 0.5 will fail the test.
+ Return the expand margin size (from enum MARGIN_*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand.
@@ -38065,13 +38144,6 @@ This method controls whether the position between two cached points is interpola
Set the expand property (default). When expanding, the image will use the same rules as [StyleBoxTexture] for expand. If not expanding, the image will always be tested at its original size.
-
-
-
-
- Return whether the expand property is set(default). When expanding, the image will use the same rules as [StyleBoxTexture] for expand. If not expanding, the image will always be tested at its original size.
-
-
@@ -38081,13 +38153,11 @@ This method controls whether the position between two cached points is interpola
Set an expand margin size (from enum MARGIN_*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand.
-
-
-
-
+
+
- Return the expand margin size (from enum MARGIN_*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand.
+ Set the image used for mask testing. Pixels (converted to grey) that have a value, less than 0.5 will fail the test.
@@ -38102,23 +38172,17 @@ This method controls whether the position between two cached points is interpola
Texture Based 3x3 scale style. This stylebox performs a 3x3 scaling of a texture, where only the center cell is fully stretched. This allows for the easy creation of bordered styles.
-
-
-
-
-
-
-
-
+
+
-
+
+
+
-
-
@@ -38130,43 +38194,49 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -38182,14 +38252,8 @@ This method controls whether the position between two cached points is interpola
Helper tool to create geometry.
-
-
-
-
-
-
-
-
+
+
@@ -38206,42 +38270,18 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
@@ -38258,21 +38298,37 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
-
+
+
+
-
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -38284,7 +38340,21 @@ This method controls whether the position between two cached points is interpola
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -38300,6 +38370,13 @@ This method controls whether the position between two cached points is interpola
TCP Server class. Listens to connections on a port and returns a [StreamPeerTCP] when got a connection.
+
+
+
+
+ Return true if a connection is available for taking.
+
+
@@ -38311,11 +38388,9 @@ This method controls whether the position between two cached points is interpola
Listen on a port, alternatively give a white-list of accepted hosts.
-
-
-
+
- Return true if a connection is available for taking.
+ Stop listening.
@@ -38325,11 +38400,6 @@ This method controls whether the position between two cached points is interpola
If a connection is available, return a StreamPeerTCP with the connection/
-
-
- Stop listening.
-
-
@@ -38343,18 +38413,11 @@ This method controls whether the position between two cached points is interpola
Children controls of this one automatically.
-
-
+
+
- Return the amount of tabs.
-
-
-
-
-
-
- Bring a tab (and the Control it represents) to the front, and hide the rest.
+ Return whether the tabs should be visible or hidden.
@@ -38370,21 +38433,12 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
-
-
-
-
-
-
- Set tab alignment, from the ALIGN_* enum. Moves tabs to the left, right or center.
-
-
@@ -38392,27 +38446,27 @@ This method controls whether the position between two cached points is interpola
Return tab alignment, from the ALIGN_* enum.
-
-
+
+
+
+
- Set whether the tabs should be visible or hidden.
-
-
+
+
- Return whether the tabs should be visible or hidden.
+ Return the amount of tabs.
-
+
+
+
-
-
- Set a title for the tab. Tab titles are by default the children node name, but this can be overridden.
@@ -38424,6 +38478,26 @@ This method controls whether the position between two cached points is interpola
Return the title for the tab. Tab titles are by default the children node name, but this can be overridden.
+
+
+
+
+ Bring a tab (and the Control it represents) to the front, and hide the rest.
+
+
+
+
+
+
+
+
+
+
+
+
+ Set tab alignment, from the ALIGN_* enum. Moves tabs to the left, right or center.
+
+
@@ -38433,24 +38507,20 @@ This method controls whether the position between two cached points is interpola
Set an icon for a tab.
-
-
-
+
-
-
-
-
-
+
+ Set a title for the tab. Tab titles are by default the children node name, but this can be overridden.
-
-
-
+
+
+
+ Set whether the tabs should be visible or hidden.
@@ -38470,39 +38540,39 @@ This method controls whether the position between two cached points is interpola
-
+
-
+
-
-
-
-
-
+
-
-
-
-
-
-
-
+
-
+
-
+
-
+
+
+
+
+
+
+
+
+
-
+
+
+
@@ -38514,14 +38584,16 @@ This method controls whether the position between two cached points is interpola
Simple tabs control, similar to [TabContainer] but is only in charge of drawing tabs, not interact with children.
-
-
-
+
+
+
+
+
-
-
+
+
@@ -38532,11 +38604,23 @@ This method controls whether the position between two cached points is interpola
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
@@ -38548,32 +38632,14 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
@@ -38584,26 +38650,24 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
+
+
-
-
+
+
+
+
-
-
-
-
-
-
@@ -38616,6 +38680,12 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
@@ -38624,47 +38694,47 @@ This method controls whether the position between two cached points is interpola
+
+
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
-
+
-
+
-
+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
@@ -38688,57 +38758,55 @@ This method controls whether the position between two cached points is interpola
TextEdit is meant for editing large, multiline text. It also has facilities for editing code, such as syntax highlighting support and multiple levels of undo/redo.
-
-
+
+
+
+
+
+
+
+
- Set the entire text.
+ Add color region (given the delimiters) and its colors.
-
-
+
+
+
+
- Insert a given text at the cursor position.
+ Add a keyword and its color.
-
-
+
+
+ Clear all the syntax coloring information.
+
+
+
+
+ Clear the undo history.
+
+
+
+
+ Copy the current selection.
+
+
+
+
- Return the amount of total lines in the text.
+ Gets whether the text editor caret is blinking.
-
-
+
+
- Return the whole text.
-
-
-
-
-
-
-
-
- Return the text of a specific line.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+ Gets the text editor caret blink speed.
@@ -38762,13 +38830,6 @@ This method controls whether the position between two cached points is interpola
Set the text editor caret to blink.
-
-
-
-
- Gets whether the text editor caret is blinking.
-
-
@@ -38776,32 +38837,20 @@ This method controls whether the position between two cached points is interpola
Set the text editor caret blink speed. Cannot be less then or equal to 0.
-
-
-
-
- Gets the text editor caret blink speed.
-
-
-
-
+
+
+
+
- Set the text editor as read-only. Text can be displayed but not edited.
-
-
+
+
+
+
- Enable text wrapping when it goes beyond he edge of what is visible.
-
-
-
-
-
-
- Set the maximum amount of characters editable.
@@ -38809,46 +38858,26 @@ This method controls whether the position between two cached points is interpola
Cut the current selection.
-
-
- Copy the current selection.
-
-
-
-
- Paste the current selection.
-
-
-
-
- Select all the text.
-
-
-
-
-
-
-
-
-
-
-
-
- Perform selection, from line/column to line/column.
-
-
-
-
+
+
+
+
- Return true if the selection is active.
+ Return the text of a specific line.
-
+
- Return the selection begin line.
+ Return the amount of total lines in the text.
+
+
+
+
+
+
@@ -38858,18 +38887,11 @@ This method controls whether the position between two cached points is interpola
Return the selection begin column.
-
+
- Return the selection end line.
-
-
-
-
-
-
- Return the selection end column.
+ Return the selection begin line.
@@ -38879,12 +38901,70 @@ This method controls whether the position between two cached points is interpola
Return the text inside the selection.
+
+
+
+
+ Return the selection end column.
+
+
+
+
+
+
+ Return the selection end line.
+
+
+
+
+
+
+ Return the whole text.
+
+
+
+
+
+
+ Insert a given text at the cursor position.
+
+
+
+
+
+
+ Return true if the selection is active.
+
+
+
+
+
+
+ Return true if the syntax coloring is enabled.
+
+
+
+
+
+
+
+
+
+
+ Paste the current selection.
+
+
+
+
+ Perform redo operation.
+
+
@@ -38900,62 +38980,22 @@ This method controls whether the position between two cached points is interpola
Perform a search inside the text. Search flags can be specified in the SEARCH_* enum.
-
+
+
+
+
+
+
+
+
+
- Perform undo operation.
+ Perform selection, from line/column to line/column.
-
+
- Perform redo operation.
-
-
-
-
- Clear the undo history.
-
-
-
-
-
-
- Set to enable the syntax coloring.
-
-
-
-
-
-
- Return true if the syntax coloring is enabled.
-
-
-
-
-
-
-
-
- Add a keyword and its color.
-
-
-
-
-
-
-
-
-
-
-
-
- Add color region (given the delimiters) and its colors.
-
-
-
-
-
-
- Set the color for symbols.
+ Select all the text.
@@ -38965,30 +39005,55 @@ This method controls whether the position between two cached points is interpola
Set a custom background color. A background color with alpha==0 disables this.
-
-
- Clear all the syntax coloring information.
-
-
-
-
+
+
+ Set the maximum amount of characters editable.
-
-
-
+
+
+
+ Set the text editor as read-only. Text can be displayed but not edited.
+
+
+
+
+
+
+ Set the color for symbols.
+
+
+
+
+
+
+ Set to enable the syntax coloring.
+
+
+
+
+
+
+ Set the entire text.
+
+
+
+
+
+
+ Enable text wrapping when it goes beyond he edge of what is visible.
+
+
+
+
+ Perform undo operation.
-
-
- Emitted when the text changes.
-
-
Emitted when the cursor changes.
@@ -38998,17 +39063,13 @@ This method controls whether the position between two cached points is interpola
+
+
+ Emitted when the text changes.
+
+
-
- Match case when searching.
-
-
- Match whole words when searching.
-
-
- Search from end to beginning.
-
@@ -39023,49 +39084,58 @@ This method controls whether the position between two cached points is interpola
+
+ Match case when searching.
+
+
+ Match whole words when searching.
+
+
+ Search from end to beginning.
+
-
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -39077,54 +39147,6 @@ This method controls whether the position between two cached points is interpola
A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D [Sprite] or GUI [Control].
-
-
-
-
- Return the texture width.
-
-
-
-
-
-
- Return the texture height.
-
-
-
-
-
-
- Return the texture size.
-
-
-
-
-
-
- Return the texture RID as used in the [VisualServer].
-
-
-
-
-
-
-
-
-
-
-
-
- Change the texture flags.
-
-
-
-
-
-
- Return the current texture flags.
-
-
@@ -39165,28 +39187,76 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+ Return the current texture flags.
+
+
+
+
+
+
+ Return the texture height.
+
+
+
+
+
+
+ Return the texture RID as used in the [VisualServer].
+
+
+
+
+
+
+ Return the texture size.
+
+
+
+
+
+
+ Return the texture width.
+
+
+
+
+
+
+
+
+
+
+
+
+ Change the texture flags.
+
+
Generate mipmaps, to enable smooth zooming out of the texture.
+
+
Repeat (instead of clamp to edge).
+
+
Turn on magnifying filter, to enable smooth zooming in of the texture.
Texture is a video surface.
-
- Default flags. Generate mipmaps, repeat, and filter are enabled.
-
-
-
-
+
+ Default flags. Generate mipmaps, repeat, and filter are enabled.
@@ -39199,68 +39269,8 @@ This method controls whether the position between two cached points is interpola
Only the normal texture is required, the others are optional.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
@@ -39277,8 +39287,26 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -39289,9 +39317,51 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -39307,9 +39377,15 @@ This method controls whether the position between two cached points is interpola
Control frame that simply draws an assigned texture. It can stretch or not. It's a simple way to just show an image in a UI.
-
-
-
+
+
+
+
+
+
+
+
+
@@ -39319,14 +39395,8 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
+
+
@@ -39337,9 +39407,9 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
@@ -39349,9 +39419,9 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
@@ -39381,57 +39451,33 @@ This method controls whether the position between two cached points is interpola
[ProgressBar] implementation that is easier to theme (by just passing a few textures).
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -39441,14 +39487,8 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
+
+
@@ -39459,9 +39499,39 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -39490,19 +39560,7 @@ This method controls whether the position between two cached points is interpola
Theme resources can be alternatively loaded by writing them in a .theme file, see wiki for more info.
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -39510,9 +39568,15 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
+
+
+
+
+
+
@@ -39528,6 +39592,88 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -39536,16 +39682,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
@@ -39556,24 +39692,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -39588,45 +39706,7 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -39634,26 +39714,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -39664,42 +39724,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -39710,7 +39734,9 @@ This method controls whether the position between two cached points is interpola
-
+
+
+
@@ -39718,10 +39744,42 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -39732,21 +39790,33 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -39762,6 +39832,20 @@ This method controls whether the position between two cached points is interpola
A unit of execution in a process. Can run methods on [Object]s simultaneously. The use of synchronization via [Mutex], [Semaphore] is advised if working with shared objects.
+
+
+
+
+ Return the id of the thread, uniquely identifying it among all threads.
+
+
+
+
+
+
+ Whether this thread is currently active, an active Thread cannot start work on a new method but can be joined with [method wait_to_finish].
+
+
@@ -39778,20 +39862,6 @@ This method controls whether the position between two cached points is interpola
Returns OK on success, or ERR_CANT_CREATE on failure.
-
-
-
-
- Return the id of the thread, uniquely identifying it among all threads.
-
-
-
-
-
-
- Whether this thread is currently active, an active Thread cannot start work on a new method but can be joined with [method wait_to_finish].
-
-
@@ -39818,269 +39888,9 @@ This method controls whether the position between two cached points is interpola
To optimize drawing and culling (sort of like [GridMap]), you can specify a quadrant size, so chunks of the map will be batched together at drawing time.
-
-
-
+
- Set the current tileset.
-
-
-
-
-
-
- Return the current tileset.
-
-
-
-
-
-
- Set the orientation mode as square, isometric or custom (use MODE_* constants as argument).
-
-
-
-
-
-
- Return the orientation mode.
-
-
-
-
-
-
- Set an half offset on the X coordinate, Y coordinate, or none (use HALF_OFFSET_* constants as argument).
- Half offset sets every other tile off by a half tile size in the specified direction.
-
-
-
-
-
-
- Return the current half offset configuration.
-
-
-
-
-
-
- Set custom transform matrix, to use in combination with the custom orientation mode.
-
-
-
-
-
-
- Return the custom transform matrix.
-
-
-
-
-
-
- Set the cell size.
-
-
-
-
-
-
- Return the cell size.
-
-
-
-
-
-
- Set the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time.
- Allowed values are integers ranging from 1 to 128.
-
-
-
-
-
-
- Return the quadrant size.
-
-
-
-
-
-
- Set the tile origin to the tile center or its top-left corner (use TILE_ORIGIN_* constants as argument).
-
-
-
-
-
-
- Return the tile origin configuration.
-
-
-
-
-
-
- Set tiles to be centered in x coordinate. (by default this is false and they are drawn from upper left cell corner).
-
-
-
-
-
-
- Return true if tiles are to be centered in x coordinate (by default this is false and they are drawn from upper left cell corner).
-
-
-
-
-
-
- Set tiles to be centered in y coordinate. (by default this is false and they are drawn from upper left cell corner).
-
-
-
-
-
-
- Return true if tiles are to be centered in y coordinate (by default this is false and they are drawn from upper left cell corner).
-
-
-
-
-
-
- Set the Y sort mode. Enabled Y sort mode means that children of the tilemap will be drawn in the order defined by their Y coordinate.
- A tile with a higher Y coordinate will therefore be drawn later, potentially covering up the tile(s) above it if its sprite is higher than its cell size.
-
-
-
-
-
-
- Return the Y sort mode.
-
-
-
-
-
-
- Set the tilemap to handle collisions as a kinematic body (enabled) or a static body (disabled).
-
-
-
-
-
-
- Return whether the tilemap handles collisions as a kinematic body.
-
-
-
-
-
-
- Set the collision layer.
- Layers are referenced by binary indexes, so allowable values to describe the 20 available layers range from 0 to 2^20-1.
-
-
-
-
-
-
- Return the collision layer.
-
-
-
-
-
-
- Set the collision masks.
- Masks are referenced by binary indexes, so allowable values to describe the 20 available masks range from 0 to 2^20-1.
-
-
-
-
-
-
- Return the collision mask.
-
-
-
-
-
-
- Set the collision friction parameter.
- Allowable values range from 0 to 1.
-
-
-
-
-
-
- Return the collision friction parameter.
-
-
-
-
-
-
- Set the collision bounce parameter.
- Allowable values range from 0 to 1.
-
-
-
-
-
-
- Return the collision bounce parameter.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Set the tile index for the cell referenced by its grid-based X and Y coordinates.
- A tile index of -1 clears the cell.
- Optionally, the tile can also be flipped over the X and Y coordinates or transposed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Set the tile index for the cell referenced by a Vector2 of grid-based coordinates.
- A tile index of -1 clears the cell.
- Optionally, the tile can also be flipped over the X and Y axes or transposed.
+ Clear all cells.
@@ -40094,6 +39904,13 @@ This method controls whether the position between two cached points is interpola
Return the tile index of the referenced cell.
+
+
+
+
+ Return the cell size.
+
+
@@ -40103,6 +39920,121 @@ This method controls whether the position between two cached points is interpola
Return the tile index of the cell referenced by a Vector2.
+
+
+
+
+ Return true if tiles are to be centered in x coordinate (by default this is false and they are drawn from upper left cell corner).
+
+
+
+
+
+
+ Return true if tiles are to be centered in y coordinate (by default this is false and they are drawn from upper left cell corner).
+
+
+
+
+
+
+ Return the collision bounce parameter.
+
+
+
+
+
+
+ Return the collision friction parameter.
+
+
+
+
+
+
+ Return the collision layer.
+
+
+
+
+
+
+ Return the collision mask.
+
+
+
+
+
+
+ Return whether the tilemap handles collisions as a kinematic body.
+
+
+
+
+
+
+ Return the custom transform matrix.
+
+
+
+
+
+
+ Return the current half offset configuration.
+
+
+
+
+
+
+ Return the orientation mode.
+
+
+
+
+
+
+
+
+
+
+
+
+ Return the quadrant size.
+
+
+
+
+
+
+ Return the tile origin configuration.
+
+
+
+
+
+
+ Return the current tileset.
+
+
+
+
+
+
+ Return an array of all cells containing a tile from the tileset (i.e. a tile index different from -1).
+
+
+
+
+
+
+
+
+
+
+ Return whether the referenced cell is transposed, i.e. the X and Y axes are swapped (mirroring with regard to the (1,1) vector).
+
+
@@ -40125,27 +40057,11 @@ This method controls whether the position between two cached points is interpola
Return whether the referenced cell is flipped over the Y axis.
-
+
-
-
-
-
- Return whether the referenced cell is transposed, i.e. the X and Y axes are swapped (mirroring with regard to the (1,1) vector).
-
-
-
-
- Clear all cells.
-
-
-
-
-
-
- Return an array of all cells containing a tile from the tileset (i.e. a tile index different from -1).
+ Return the Y sort mode.
@@ -40160,6 +40076,160 @@ This method controls whether the position between two cached points is interpola
Optionally, the tilemap's potential half offset can be ignored.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Set the tile index for the cell referenced by its grid-based X and Y coordinates.
+ A tile index of -1 clears the cell.
+ Optionally, the tile can also be flipped over the X and Y coordinates or transposed.
+
+
+
+
+
+
+ Set the cell size.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Set the tile index for the cell referenced by a Vector2 of grid-based coordinates.
+ A tile index of -1 clears the cell.
+ Optionally, the tile can also be flipped over the X and Y axes or transposed.
+
+
+
+
+
+
+ Set tiles to be centered in x coordinate. (by default this is false and they are drawn from upper left cell corner).
+
+
+
+
+
+
+ Set tiles to be centered in y coordinate. (by default this is false and they are drawn from upper left cell corner).
+
+
+
+
+
+
+ Set the collision bounce parameter.
+ Allowable values range from 0 to 1.
+
+
+
+
+
+
+ Set the collision friction parameter.
+ Allowable values range from 0 to 1.
+
+
+
+
+
+
+ Set the collision layer.
+ Layers are referenced by binary indexes, so allowable values to describe the 20 available layers range from 0 to 2^20-1.
+
+
+
+
+
+
+ Set the collision masks.
+ Masks are referenced by binary indexes, so allowable values to describe the 20 available masks range from 0 to 2^20-1.
+
+
+
+
+
+
+ Set the tilemap to handle collisions as a kinematic body (enabled) or a static body (disabled).
+
+
+
+
+
+
+ Set custom transform matrix, to use in combination with the custom orientation mode.
+
+
+
+
+
+
+ Set an half offset on the X coordinate, Y coordinate, or none (use HALF_OFFSET_* constants as argument).
+ Half offset sets every other tile off by a half tile size in the specified direction.
+
+
+
+
+
+
+ Set the orientation mode as square, isometric or custom (use MODE_* constants as argument).
+
+
+
+
+
+
+
+
+
+
+
+
+ Set the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time.
+ Allowed values are integers ranging from 1 to 128.
+
+
+
+
+
+
+ Set the tile origin to the tile center or its top-left corner (use TILE_ORIGIN_* constants as argument).
+
+
+
+
+
+
+ Set the current tileset.
+
+
+
+
+
+
+ Set the Y sort mode. Enabled Y sort mode means that children of the tilemap will be drawn in the order defined by their Y coordinate.
+ A tile with a higher Y coordinate will therefore be drawn later, potentially covering up the tile(s) above it if its sprite is higher than its cell size.
+
+
@@ -40178,6 +40248,15 @@ This method controls whether the position between two cached points is interpola
+
+ Half offset on the X coordinate.
+
+
+ Half offset on the Y coordinate.
+
+
+ Half offset disabled.
+
Returned when a cell doesn't exist.
@@ -40190,15 +40269,6 @@ This method controls whether the position between two cached points is interpola
Custom orientation mode.
-
- Half offset on the X coordinate.
-
-
- Half offset on the Y coordinate.
-
-
- Half offset disabled.
-
Tile origin at its top-left corner.
@@ -40216,246 +40286,16 @@ This method controls whether the position between two cached points is interpola
Tiles are referenced by a unique integer ID.
-
-
-
-
- Create a new tile which will be referenced by the given ID.
-
-
-
-
-
-
-
-
- Set the name of the tile, for descriptive purposes.
-
-
-
-
-
-
-
-
- Return the name of the tile.
-
-
-
-
-
-
-
-
- Set the texture of the tile.
-
-
-
-
-
-
-
-
- Return the texture of the tile.
-
-
-
-
-
-
-
-
- Set the material of the tile.
-
-
-
-
-
-
-
-
- Return the material of the tile.
-
-
-
-
-
-
-
-
- Set the texture offset of the tile.
-
-
-
-
-
-
-
-
- Return the texture offset of the tile.
-
-
-
-
-
-
-
-
- Set the shape offset of the tile.
-
-
-
-
-
-
-
-
- Return the shape offset of the tile.
-
-
-
-
-
-
-
-
- Set the tile sub-region in the texture. This is common in texture atlases.
-
-
-
-
-
-
-
-
- Return the tile sub-region in the texture.
-
-
-
-
-
-
-
-
- Set a shape for the tile, enabling physics to collide with it.
-
-
-
-
-
-
-
-
- Return the shape of the tile.
-
-
-
-
-
-
-
-
- Set an array of shapes for the tile, enabling physics to collide with it.
-
-
-
-
-
-
-
-
- Return the array of shapes of the tile.
-
-
-
-
-
-
-
-
- Set a navigation polygon for the tile.
-
-
-
-
-
-
-
-
- Return the navigation polygon of the tile.
-
-
-
-
-
-
-
-
- Set an offset for the tile's navigation polygon.
-
-
-
-
-
-
-
-
- Return the offset of the tile's navigation polygon.
-
-
-
-
-
-
-
-
- Set a light occluder for the tile.
-
-
-
-
-
-
-
-
- Return the light occluder of the tile.
-
-
-
-
-
-
-
-
- Set an offset for the tile's light occluder.
-
-
-
-
-
-
-
-
- Return the offset of the tile's light occluder.
-
-
-
-
-
-
- Remove the tile referenced by the given ID.
-
-
Clear all tiles.
-
-
-
+
+
+
- Return the ID following the last currently used ID, useful when creating a new tile.
+ Create a new tile which will be referenced by the given ID.
@@ -40467,6 +40307,13 @@ This method controls whether the position between two cached points is interpola
Find the first tile matching the given name.
+
+
+
+
+ Return the ID following the last currently used ID, useful when creating a new tile.
+
+
@@ -40474,6 +40321,229 @@ This method controls whether the position between two cached points is interpola
Return an array of all currently used tile IDs.
+
+
+
+
+ Remove the tile referenced by the given ID.
+
+
+
+
+
+
+
+
+ Return the light occluder of the tile.
+
+
+
+
+
+
+
+
+ Return the material of the tile.
+
+
+
+
+
+
+
+
+ Return the name of the tile.
+
+
+
+
+
+
+
+
+ Return the navigation polygon of the tile.
+
+
+
+
+
+
+
+
+ Return the offset of the tile's navigation polygon.
+
+
+
+
+
+
+
+
+ Return the offset of the tile's light occluder.
+
+
+
+
+
+
+
+
+ Return the tile sub-region in the texture.
+
+
+
+
+
+
+
+
+ Return the shape of the tile.
+
+
+
+
+
+
+
+
+ Return the shape offset of the tile.
+
+
+
+
+
+
+
+
+ Return the array of shapes of the tile.
+
+
+
+
+
+
+
+
+ Return the texture of the tile.
+
+
+
+
+
+
+
+
+ Return the texture offset of the tile.
+
+
+
+
+
+
+
+
+ Set a light occluder for the tile.
+
+
+
+
+
+
+
+
+ Set the material of the tile.
+
+
+
+
+
+
+
+
+ Set the name of the tile, for descriptive purposes.
+
+
+
+
+
+
+
+
+ Set a navigation polygon for the tile.
+
+
+
+
+
+
+
+
+ Set an offset for the tile's navigation polygon.
+
+
+
+
+
+
+
+
+ Set an offset for the tile's light occluder.
+
+
+
+
+
+
+
+
+ Set the tile sub-region in the texture. This is common in texture atlases.
+
+
+
+
+
+
+
+
+ Set a shape for the tile, enabling physics to collide with it.
+
+
+
+
+
+
+
+
+ Set the shape offset of the tile.
+
+
+
+
+
+
+
+
+ Set an array of shapes for the tile, enabling physics to collide with it.
+
+
+
+
+
+
+
+
+ Set the texture of the tile.
+
+
+
+
+
+
+
+
+ Set the texture offset of the tile.
+
+
@@ -40486,11 +40556,18 @@ This method controls whether the position between two cached points is interpola
Timer node. This is a simple node that will emit a timeout callback when the timer runs out. It can optionally be set to loop.
-
-
-
+
+
+
- Set wait time in seconds. When the time is over, it will emit the timeout signal.
+ Return the time left for timeout in seconds if the timer is active, 0 otherwise.
+
+
+
+
+
+
+ Return the timer's processing mode.
@@ -40500,11 +40577,18 @@ This method controls whether the position between two cached points is interpola
Return the wait time in seconds.
-
-
-
+
+
+
- Set as one-shot. If enabled, the timer will stop after timeout, otherwise it will automatically restart.
+ Return true if set to automatically start when entering the scene.
+
+
+
+
+
+
+ Return if the timer is active or not.
@@ -40514,6 +40598,13 @@ This method controls whether the position between two cached points is interpola
Return true if configured as one-shot.
+
+
+
+
+ Set whether the timer is active or not. An inactive timer will be paused until it is activated again.
+
+
@@ -40521,11 +40612,25 @@ This method controls whether the position between two cached points is interpola
Set to automatically start when entering the scene.
-
-
-
+
+
+
- Return true if set to automatically start when entering the scene.
+ Set as one-shot. If enabled, the timer will stop after timeout, otherwise it will automatically restart.
+
+
+
+
+
+
+ Set the timer's processing mode (fixed or idle, use TIMER_PROCESS_* constants as argument).
+
+
+
+
+
+
+ Set wait time in seconds. When the time is over, it will emit the timeout signal.
@@ -40538,41 +40643,6 @@ This method controls whether the position between two cached points is interpola
Stop (cancel) the timer.
-
-
-
-
- Set whether the timer is active or not. An inactive timer will be paused until it is activated again.
-
-
-
-
-
-
- Return if the timer is active or not.
-
-
-
-
-
-
- Return the time left for timeout in seconds if the timer is active, 0 otherwise.
-
-
-
-
-
-
- Set the timer's processing mode (fixed or idle, use TIMER_PROCESS_* constants as argument).
-
-
-
-
-
-
- Return the timer's processing mode.
-
-
@@ -40600,28 +40670,28 @@ This method controls whether the position between two cached points is interpola
-
+
-
+
+
+
+
+
-
-
-
-
-
-
-
+
+
+
@@ -40630,57 +40700,27 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-
-
+
+
+
@@ -40690,12 +40730,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
@@ -40708,13 +40742,49 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
+
@@ -40730,6 +40800,59 @@ This method controls whether the position between two cached points is interpola
Transform is used to store transformations, including translations. It consists of a Matrix3 "basis" and Vector3 "origin". Transform is used to represent transformations of any object in space. It is similar to a 4x3 matrix.
+
+
+
+
+
+
+
+
+
+
+
+
+ Construct the Transform from four Vector3. Each axis creates the basis.
+
+
+
+
+
+
+
+
+
+
+ Construct the Transform from a Matrix3 and Vector3.
+
+
+
+
+
+
+
+
+ Construct the Transform from a Matrix32.
+
+
+
+
+
+
+
+
+ Construct the Transform from a Quat. The origin will be Vector3(0, 0, 0)
+
+
+
+
+
+
+
+
+ Construct the Transform from a Matrix3. The origin will be Vector3(0, 0, 0)
+
+
@@ -40809,59 +40932,6 @@ This method controls whether the position between two cached points is interpola
Inverse-transforms vector "v" by this transform.
-
-
-
-
-
-
-
-
-
-
-
-
- Construct the Transform from four Vector3. Each axis creates the basis.
-
-
-
-
-
-
-
-
-
-
- Construct the Transform from a Matrix3 and Vector3.
-
-
-
-
-
-
-
-
- Construct the Transform from a Matrix32.
-
-
-
-
-
-
-
-
- Construct the Transform from a Quat. The origin will be Vector3(0, 0, 0)
-
-
-
-
-
-
-
-
- Construct the Transform from a Matrix3. The origin will be Vector3(0, 0, 0)
-
-
@@ -40882,20 +40952,6 @@ This method controls whether the position between two cached points is interpola
Translations are resources that can be loaded/unloaded on demand. They map a string to another string.
-
-
-
-
- Set the locale of the translation.
-
-
-
-
-
-
- Return the locale of the translation.
-
-
@@ -40905,6 +40961,20 @@ This method controls whether the position between two cached points is interpola
Add a message for translation.
+
+
+
+
+ Erase a message.
+
+
+
+
+
+
+ Return the locale of the translation.
+
+
@@ -40914,11 +40984,10 @@ This method controls whether the position between two cached points is interpola
Return a message for translation.
-
-
-
+
+
+
- Erase a message.
@@ -40928,10 +40997,11 @@ This method controls whether the position between two cached points is interpola
Return all the messages (keys).
-
-
-
+
+
+
+ Set the locale of the translation.
@@ -40945,39 +41015,39 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
@@ -40991,6 +41061,12 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
@@ -41003,25 +41079,29 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
+
+
+
+
-
-
-
-
+
+
+
+
-
+
+
+
-
-
@@ -41033,56 +41113,24 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
@@ -41095,12 +41143,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
@@ -41119,30 +41161,78 @@ This method controls whether the position between two cached points is interpola
-
+
+
+
+
+
+
+
+
+
-
-
-
+
+
+
-
-
-
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -41151,53 +41241,39 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
+
+
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-
-
+
+
+
+
+
+
+
+
+
@@ -41207,34 +41283,38 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -41245,12 +41325,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
@@ -41261,100 +41335,96 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
+
-
+
-
-
-
-
-
-
+
+
+
+
+
+
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -41363,10 +41433,58 @@ This method controls whether the position between two cached points is interpola
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -41379,46 +41497,20 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
+
+
+
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -41427,11 +41519,11 @@ This method controls whether the position between two cached points is interpola
-
+
+
+
-
-
@@ -41443,27 +41535,39 @@ This method controls whether the position between two cached points is interpola
-
+
-
-
-
-
+
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -41475,20 +41579,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -41497,32 +41587,36 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
+
+
+
-
+
+
+
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -41533,55 +41627,11 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -41601,44 +41651,46 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
@@ -41653,64 +41705,98 @@ This method controls whether the position between two cached points is interpola
-
+
+
+
-
-
-
+
+
+
+
+
-
+
-
-
-
-
-
+
-
-
-
+
+
+
-
-
-
+
-
+
-
+
-
+
-
-
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -41723,22 +41809,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -41771,155 +41841,56 @@ This method controls whether the position between two cached points is interpola
Many of the methods accept [code]trans_type[/code] and [code]ease_type[/code]. The first accepts an TRANS_* constant, and refers to the way the timing of the animation is handled (you might want to see [code]http://easings.net/[/code] for some examples). The second accepts an EASE_* constant, and controls the where [code]trans_type[/code] is applied to the interpolation (in the begining, the end, or both). If you don't know which transision and easing to pick, you can try different TRANS_* constants with EASE_IN_OUT, and use the one that looks best.
-
-
-
-
- Returns true if any tweens are currently running, and false otherwise. Note that this method doesn't consider tweens that have ended.
-
-
-
-
-
-
- Activate/deactivate the tween. You can use this for pausing animations, though [method stop_all] and [method resume_all] might be more fit for this.
-
-
-
-
-
-
- Returns true if repeat has been set from editor GUI or [method set_repeat].
-
-
-
-
-
-
- Make the tween repeat after all tweens have finished.
-
-
-
-
-
-
- Set the speed multiplier of the tween. Set it to 1 for normal speed, 2 for two times nromal speed, and 0.5 for half of the normal speed. Setting it to 0 would pause the animation, but you might consider using [method set_active] or [method stop_all] and [method resume_all] for this.
-
-
-
-
-
-
- Returns the speed that has been set from editor GUI or [method set_repeat].
-
-
-
-
-
-
- Set whether the Tween uses [code]_process[/code] or [code]_fixed_process[/code] (accepts TWEEN_PROCESS_IDLE and TWEEN_PROCESS_FIXED constants, respectively).
-
-
-
-
-
-
- Returns the process mode that has been set from editor GUI or [method set_tween_process_mode]
-
-
-
-
-
-
- Start the tween node. You can define tweens both before and after this.
-
-
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Resets a tween to the initial value (the one given, not the one before the tween), given its object and property/method pair.
+ Follow [code]method[/code] of [code]object[/code] and apply the returned value on [code]target_method[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] later. Methods are animated by calling them with consequitive values.
+ [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
-
-
-
-
- Resets all tweens to their initial values (the ones given, not those before the tween).
-
-
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Stop animating a tween, given its object and property/method pair.
-
-
-
-
-
-
- Stop animating all tweens.
-
-
-
-
-
-
-
-
-
-
- Continue animating a stopped tween, given its object and property/method pair.
-
-
-
-
-
-
- Continue animating all stopped tweens.
-
-
-
-
-
-
-
-
-
-
- Stop animating and completely remove a tween, given its object and property/method pair.
-
-
-
-
-
-
- Stop animating and completely remove all tweens.
-
-
-
-
-
-
-
-
- Seek the animation to the given [code]time[/code] in seconds.
-
-
-
-
-
-
- Returns the current time of the tween.
+ Follow [code]property[/code] of [code]object[/code] and apply it on [code]target_property[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. Note that [code]target:target_property[/code] would equal [code]object:property[/code] at the end of the tween.
+ [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
@@ -41929,52 +41900,18 @@ This method controls whether the position between two cached points is interpola
Returns the time needed for all tweens to end in seconds, measured from the start. Thus, if you have two tweens, one ending 10 seconds after the start and the other - 20 seconds, it would return 20 seconds, as by that time all tweens would have finished.
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Animate [code]property[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later.
- [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
+ Returns the speed that has been set from editor GUI or [method set_repeat].
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Animate [code]method[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values.
- [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
+ Returns the process mode that has been set from editor GUI or [method set_tween_process_mode]
@@ -42023,33 +41960,7 @@ This method controls whether the position between two cached points is interpola
Call [code]callback[/code] of [code]object[/code] after [code]times_in_sec[/code] on the main thread (similar to [methog Object.call_deferred). [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Follow [code]property[/code] of [code]object[/code] and apply it on [code]target_property[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. Note that [code]target:target_property[/code] would equal [code]object:property[/code] at the end of the tween.
- [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
-
-
-
+
@@ -42058,9 +41969,187 @@ This method controls whether the position between two cached points is interpola
-
+
-
+
+
+
+
+
+
+
+
+
+ Animate [code]method[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values.
+ [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Animate [code]property[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later.
+ [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
+
+
+
+
+
+
+ Returns true if any tweens are currently running, and false otherwise. Note that this method doesn't consider tweens that have ended.
+
+
+
+
+
+
+ Returns true if repeat has been set from editor GUI or [method set_repeat].
+
+
+
+
+
+
+
+
+
+
+ Stop animating and completely remove a tween, given its object and property/method pair.
+
+
+
+
+
+
+ Stop animating and completely remove all tweens.
+
+
+
+
+
+
+
+
+
+
+ Resets a tween to the initial value (the one given, not the one before the tween), given its object and property/method pair.
+
+
+
+
+
+
+ Resets all tweens to their initial values (the ones given, not those before the tween).
+
+
+
+
+
+
+
+
+
+
+ Continue animating a stopped tween, given its object and property/method pair.
+
+
+
+
+
+
+ Continue animating all stopped tweens.
+
+
+
+
+
+
+
+
+ Seek the animation to the given [code]time[/code] in seconds.
+
+
+
+
+
+
+ Activate/deactivate the tween. You can use this for pausing animations, though [method stop_all] and [method resume_all] might be more fit for this.
+
+
+
+
+
+
+ Make the tween repeat after all tweens have finished.
+
+
+
+
+
+
+ Set the speed multiplier of the tween. Set it to 1 for normal speed, 2 for two times nromal speed, and 0.5 for half of the normal speed. Setting it to 0 would pause the animation, but you might consider using [method set_active] or [method stop_all] and [method resume_all] for this.
+
+
+
+
+
+
+ Set whether the Tween uses [code]_process[/code] or [code]_fixed_process[/code] (accepts TWEEN_PROCESS_IDLE and TWEEN_PROCESS_FIXED constants, respectively).
+
+
+
+
+
+
+ Start the tween node. You can define tweens both before and after this.
+
+
+
+
+
+
+
+
+
+
+ Stop animating a tween, given its object and property/method pair.
+
+
+
+
+
+
+ Stop animating all tweens.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -42071,7 +42160,7 @@ This method controls whether the position between two cached points is interpola
- Follow [code]method[/code] of [code]object[/code] and apply the returned value on [code]target_method[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] later. Methods are animated by calling them with consequitive values.
+ Animate [code]method[/code] of [code]object[/code] from the value returned by [code]initial.initial_method[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values.
[code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
@@ -42101,30 +42190,11 @@ This method controls whether the position between two cached points is interpola
[code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Animate [code]method[/code] of [code]object[/code] from the value returned by [code]initial.initial_method[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values.
- [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
+ Returns the current time of the tween.
@@ -42138,6 +42208,15 @@ This method controls whether the position between two cached points is interpola
This signal is emitted when a tween ends.
+
+
+
+
+
+
+ This signal is emitted when a tween starts.
+
+
@@ -42151,22 +42230,19 @@ This method controls whether the position between two cached points is interpola
This signal is emitted each step of the tweening.
-
-
-
-
-
-
- This signal is emitted when a tween starts.
-
-
-
- The [Tween] should use [code]_fixed_process[/code] for timekeeping when this is enabled.
+
+ Signifies that the interpolation should be focused in the beginning.
-
- The [Tween] should use [code]_process[/code] for timekeeping when this is enabled (default).
+
+ Signifies that the interpolation should be focused in the end.
+
+
+ Signifies that the interpolation should be focused in both ends.
+
+
+ Signifies that the interpolation should be focused in both ends, but they should be switched (a bit hard to explain, try it for yourself to be sure).
Means that the animation is interpolated linearly.
@@ -42174,6 +42250,9 @@ This method controls whether the position between two cached points is interpola
Means that the animation is interpolated using a sine wave.
+
+ Means that the animation is interpolated backing out at edges.
+
Means that the animation is interpolated with a quinary (to the power of 5) function.
@@ -42198,20 +42277,11 @@ This method controls whether the position between two cached points is interpola
Means that the animation is interpolated by bouncing at, but never surpassing, the end.
-
- Means that the animation is interpolated backing out at edges.
+
+ The [Tween] should use [code]_fixed_process[/code] for timekeeping when this is enabled.
-
- Signifies that the interpolation should be focused in the beginning.
-
-
- Signifies that the interpolation should be focused in the end.
-
-
- Signifies that the interpolation should be focused in both ends.
-
-
- Signifies that the interpolation should be focused in both ends, but they should be switched (a bit hard to explain, try it for yourself to be sure).
+
+ The [Tween] should use [code]_process[/code] for timekeeping when this is enabled (default).
@@ -42227,24 +42297,6 @@ This method controls whether the position between two cached points is interpola
functions or property changes, then commiting the action.
-
-
-
-
-
-
- Create a new action. After this is called, do all
- your calls to [method add_do_method],
- [method add_undo_method], [method add_do_property]
- and [method add_undo_property].
-
-
-
-
- Commit the action. All 'do' methods/properties are
- called/set when this function is called.
-
-
@@ -42265,6 +42317,26 @@ This method controls whether the position between two cached points is interpola
arguments.
+
+
+
+
+
+
+
+
+ Set a property with a custom value.
+
+
+
+
+
+
+ Add a 'do' reference that will be erased if the 'do'
+ history is lost. This is useful mostly for new nodes
+ created for the 'do' call. Do not use for resources.
+
+
@@ -42286,17 +42358,6 @@ This method controls whether the position between two cached points is interpola
calls.
-
-
-
-
-
-
-
-
- Set a property with a custom value.
-
-
@@ -42308,15 +42369,6 @@ This method controls whether the position between two cached points is interpola
Undo setting of a property with a custom value.
-
-
-
-
- Add a 'do' reference that will be erased if the 'do'
- history is lost. This is useful mostly for new nodes
- created for the 'do' call. Do not use for resources.
-
-
@@ -42333,6 +42385,24 @@ This method controls whether the position between two cached points is interpola
references.
+
+
+ Commit the action. All 'do' methods/properties are
+ called/set when this function is called.
+
+
+
+
+
+
+
+
+ Create a new action. After this is called, do all
+ your calls to [method add_do_method],
+ [method add_undo_method], [method add_do_property]
+ and [method add_undo_property].
+
+
@@ -42386,24 +42456,24 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-
-
-
+
+
+
@@ -42417,22 +42487,22 @@ This method controls whether the position between two cached points is interpola
-
+
-
-
-
+
-
+
-
+
+
+
@@ -42465,16 +42535,16 @@ This method controls whether the position between two cached points is interpola
-
+
-
-
+
+
@@ -42491,11 +42561,11 @@ This method controls whether the position between two cached points is interpola
-
+
-
+
@@ -42507,6 +42577,17 @@ This method controls whether the position between two cached points is interpola
2-element structure that can be used to represent positions in 2d-space, or any other pair of numeric values.
+
+
+
+
+
+
+
+
+ Constructs a new Vector2 from the given x and y.
+
+
@@ -42677,31 +42758,20 @@ This method controls whether the position between two cached points is interpola
Returns a perpendicular vector.
-
-
-
-
-
-
-
-
- Constructs a new Vector2 from the given x and y.
-
-
+
+ Height of the vector (Same as Y).
+
+
+ Width of the vector (Same as X).
+
X component of the vector.
Y component of the vector.
-
- Width of the vector (Same as X).
-
-
- Height of the vector (Same as Y).
-
@@ -42714,6 +42784,15 @@ This method controls whether the position between two cached points is interpola
An Array specifically designed to hold Vector2.
+
+
+
+
+
+
+ Construct a new [Vector2Array]. Optionally, you can pass in an Array that will be converted.
+
+
@@ -42744,15 +42823,6 @@ This method controls whether the position between two cached points is interpola
Return the size of the array.
-
-
-
-
-
-
- Construct a new [Vector2Array]. Optionally, you can pass in an Array that will be converted.
-
-
@@ -42765,6 +42835,19 @@ This method controls whether the position between two cached points is interpola
Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vector math operations.
+
+
+
+
+
+
+
+
+
+
+ Returns a Vector3 with the given components.
+
+
@@ -42928,19 +43011,6 @@ This method controls whether the position between two cached points is interpola
Return a copy of the vector, snapped to the lowest neared multiple.
-
-
-
-
-
-
-
-
-
-
- Returns a Vector3 with the given components.
-
-
@@ -42973,6 +43043,15 @@ This method controls whether the position between two cached points is interpola
An Array specifically designed to hold Vector3.
+
+
+
+
+
+
+ Construct a new Vector3Array. Optionally, you can pass in an Array that will be converted.
+
+
@@ -43003,15 +43082,6 @@ This method controls whether the position between two cached points is interpola
Return the size of the array.
-
-
-
-
-
-
- Construct a new Vector3Array. Optionally, you can pass in an Array that will be converted.
-
-
@@ -43022,61 +43092,19 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -43093,6 +43121,48 @@ This method controls whether the position between two cached points is interpola
[/codeblock]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -43103,9 +43173,21 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -43115,9 +43197,9 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
@@ -43127,9 +43209,9 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
@@ -43139,26 +43221,14 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
-
+
+
@@ -43169,57 +43239,57 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -43233,9 +43303,15 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
+
+
+
+
+
+
@@ -43245,68 +43321,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -43319,9 +43333,21 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -43331,15 +43357,37 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
+
+
+
@@ -43349,15 +43397,37 @@ This method controls whether the position between two cached points is interpola
-
-
-
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -43398,18 +43468,11 @@ This method controls whether the position between two cached points is interpola
Finally, viewports can also behave as render targets, in which case they will not be visible unless the associated texture is used to draw.
-
-
-
-
- Set the viewport rect. If the viewport is child of a control, it will use the same rect as the parent.
-
-
-
-
+
+
- Return the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. Otherwise, if the rect is empty, the viewport will use all the allowed space.
+ Return the 3D world of the viewport, or if no such present, the one of the parent viewport.
@@ -43419,32 +43482,11 @@ This method controls whether the position between two cached points is interpola
Return the 2D world of the viewport.
-
-
-
-
- Change the 3D world of the viewport.
-
-
-
-
+
+
- Return the 3D world of the viewport.
-
-
-
-
-
-
- Return the 3D world of the viewport, or if no such present, the one of the parent viewport.
-
-
-
-
-
-
- Set the canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]s. This is relative to the global canvas transform of the viewport.
+ Return the active 3D camera.
@@ -43454,11 +43496,11 @@ This method controls whether the position between two cached points is interpola
Get the canvas transform of the viewport.
-
-
-
+
+
+
- Set the global canvas transform of the viewport. The canvas transform is relative to this.
+ Get the total transform of the viewport.
@@ -43468,11 +43510,88 @@ This method controls whether the position between two cached points is interpola
Get the global canvas transform of the viewport.
-
-
+
+
- Get the total transform of the viewport.
+ Get the mouse position, relative to the viewport.
+
+
+
+
+
+
+ Get whether picking for all physics objects inside the viewport is enabled.
+
+
+
+
+
+
+ Return the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. Otherwise, if the rect is empty, the viewport will use all the allowed space.
+
+
+
+
+
+
+ Return whether automatic clearing of the render target on each frame is enabled.
+
+
+
+
+
+
+ Get whether the rendered texture has filters enabled.
+
+
+
+
+
+
+ Get whether the rendered texture will have mipmaps generated.
+
+
+
+
+
+
+ Get the render target's texture, for use with various objects that you want to texture with the viewport.
+
+
+
+
+
+
+ Get when the render target would be updated, will be one of the [code]RENDER_TARGET_UPDATE_*[/code] constants.
+
+
+
+
+
+
+ Set whether the render target is flipped on the Y axis.
+
+
+
+
+
+
+ Return the captured screenshot after [method queue_screen_capture]. You might need to check more than one frame untill the right image is returned.
+
+
+
+
+
+
+ Get the size override set with [method set_size_override].
+
+
+
+
+
+
+ Get the viewport RID from the visual server.
@@ -43482,11 +43601,25 @@ This method controls whether the position between two cached points is interpola
Return the final, visible rect in global screen coordinates.
-
-
-
+
+
+
- If this viewport is a child of another viewport, keep the previously drawn background visible.
+ Return the 3D world of the viewport.
+
+
+
+
+
+
+ Returs the drag data from the GUI, that was previously returned by [method Control.get_drag_data].
+
+
+
+
+
+
+ Returs whether there are shown modals on-screen.
@@ -43496,6 +43629,169 @@ This method controls whether the position between two cached points is interpola
Return whether the viewport lets whatever is behind it to show.
+
+
+
+
+
+
+
+
+
+
+ Returns whether the viewport sends sounds to the speakers.
+
+
+
+
+
+
+ Returns whether the viewport sends soundsfrom 2D emitters to the speakers.
+
+
+
+
+
+
+ Return whether input to the viewport is disabled.
+
+
+
+
+
+
+ Return whether the viewport is set as a render target by [method set_as_render_target].
+
+
+
+
+
+
+ Get the enabled status of the size override set with [method set_size_override].
+
+
+
+
+
+
+ Get the enabled status of the size strech override set with [method set_size_override_stretch].
+
+
+
+
+
+
+ Return whether the viewport is using a world separate from the parent viewport's world.
+
+
+
+
+ Queue a multithreaded screenshot, you can retrive it at a later frame via [method get_screen_capture].
+
+
+
+
+ Clear the render target manually.
+
+
+
+
+
+
+ Makes the viewport send sounds to the speakers.
+
+
+
+
+
+
+ Makes the viewport send sounds from 2D emitters to the speakers.
+
+
+
+
+
+
+ Set the viewport's render target mode.
+
+
+
+
+
+
+ Set the canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]s. This is relative to the global canvas transform of the viewport.
+
+
+
+
+
+
+ Set whether input to the viewport is disabled.
+
+
+
+
+
+
+ Set the global canvas transform of the viewport. The canvas transform is relative to this.
+
+
+
+
+
+
+ Enable/disable picking for all physics objects inside the viewport.
+
+
+
+
+
+
+ Set the viewport rect. If the viewport is child of a control, it will use the same rect as the parent.
+
+
+
+
+
+
+ Enable/disable automatic clearing of the render target on each frame. You might find it better to disable this if you are using the viewport for rarely updated textures. To clear manually, check [method render_target_clear]
+
+
+
+
+
+
+ Set whether the rendered texture should have filters enabled. Disable if you want the texture's pixels be visible.
+
+
+
+
+
+
+ Set whether the rendered texture should have mipmaps generated. Mipmaps allow the texture to have better antialiasing from far away.
+
+
+
+
+
+
+ Map a part of the screen to the render target directly.
+
+
+
+
+
+
+ Set when the render target should be updated, has to be one of the [code]RENDER_TARGET_UPDATE_*[/code] constants.
+
+
+
+
+
+
+ Set whether the render target should be flipped on the Y axis.
+
+
@@ -43507,20 +43803,6 @@ This method controls whether the position between two cached points is interpola
Set the size of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to [code](-1, -1)[/code], it won't update the size.
-
-
-
-
- Get the size override set with [method set_size_override].
-
-
-
-
-
-
- Get the enabled status of the size override set with [method set_size_override].
-
-
@@ -43528,146 +43810,25 @@ This method controls whether the position between two cached points is interpola
Set whether the size override affects stretch as well.
-
-
-
-
- Get the enabled status of the size strech override set with [method set_size_override_stretch].
-
-
-
-
- Queue a multithreaded screenshot, you can retrive it at a later frame via [method get_screen_capture].
-
-
-
-
-
-
- Return the captured screenshot after [method queue_screen_capture]. You might need to check more than one frame untill the right image is returned.
-
-
-
+
- Set the viewport's render target mode.
+ If this viewport is a child of another viewport, keep the previously drawn background visible.
-
-
-
-
- Return whether the viewport is set as a render target by [method set_as_render_target].
-
-
-
+
- Set whether the render target should be flipped on the Y axis.
+ Make the viewport use a world separate from the parent viewport's world.
-
-
-
-
- Set whether the render target is flipped on the Y axis.
-
-
-
-
-
-
- Enable/disable automatic clearing of the render target on each frame. You might find it better to disable this if you are using the viewport for rarely updated textures. To clear manually, check [method render_target_clear]
-
-
-
-
-
-
- Return whether automatic clearing of the render target on each frame is enabled.
-
-
-
-
- Clear the render target manually.
-
-
-
-
-
-
- Set whether the rendered texture should have filters enabled. Disable if you want the texture's pixels be visible.
-
-
-
-
-
-
- Get whether the rendered texture has filters enabled.
-
-
-
-
-
-
- Set whether the rendered texture should have mipmaps generated. Mipmaps allow the texture to have better antialiasing from far away.
-
-
-
-
-
-
- Get whether the rendered texture will have mipmaps generated.
-
-
-
-
-
-
- Set when the render target should be updated, has to be one of the [code]RENDER_TARGET_UPDATE_*[/code] constants.
-
-
-
-
-
-
- Get when the render target would be updated, will be one of the [code]RENDER_TARGET_UPDATE_*[/code] constants.
-
-
-
-
-
-
- Get the render target's texture, for use with various objects that you want to texture with the viewport.
-
-
-
-
-
-
- Enable/disable picking for all physics objects inside the viewport.
-
-
-
-
-
-
- Get whether picking for all physics objects inside the viewport is enabled.
-
-
-
-
-
-
- Get the viewport RID from the visual server.
-
-
-
-
+
+
+ Change the 3D world of the viewport.
@@ -43681,69 +43842,6 @@ This method controls whether the position between two cached points is interpola
Force update of the 2D and 3D worlds.
-
-
-
-
- Make the viewport use a world separate from the parent viewport's world.
-
-
-
-
-
-
- Return whether the viewport is using a world separate from the parent viewport's world.
-
-
-
-
-
-
- Return the active 3D camera.
-
-
-
-
-
-
- Makes the viewport send sounds to the speakers.
-
-
-
-
-
-
- Returns whether the viewport sends sounds to the speakers.
-
-
-
-
-
-
- Makes the viewport send sounds from 2D emitters to the speakers.
-
-
-
-
-
-
- Returns whether the viewport sends soundsfrom 2D emitters to the speakers.
-
-
-
-
-
-
- Map a part of the screen to the render target directly.
-
-
-
-
-
-
- Get the mouse position, relative to the viewport.
-
-
@@ -43751,34 +43849,6 @@ This method controls whether the position between two cached points is interpola
Wrap the mouse to a position, relative to the viewport.
-
-
-
-
- Returs whether there are shown modals on-screen.
-
-
-
-
-
-
- Returs the drag data from the GUI, that was previously returned by [method Control.get_drag_data].
-
-
-
-
-
-
- Set whether input to the viewport is disabled.
-
-
-
-
-
-
- Return whether input to the viewport is disabled.
-
-
@@ -43810,39 +43880,11 @@ This method controls whether the position between two cached points is interpola
Used to display a [Viewport] node at some position in the world, without having to mess with [RenderTargetTexture]s.
-
-
-
-
- Set the path to the shown [Viewport] node.
-
-
-
-
+
+
- Return the path to the shown [Viewport] node.
-
-
-
-
-
-
- Set whether the viewport's texture should be centered on the origin.
-
-
-
-
-
-
- Return whether the viewport's texture is centered on the origin.
-
-
-
-
-
-
- Set the offset to the origin of the texture.
+ Get color modulation for the texture. All texture pixels are multiplied by this color.
@@ -43852,6 +43894,27 @@ This method controls whether the position between two cached points is interpola
get the offset to the origin of the texture.
+
+
+
+
+ Return the path to the shown [Viewport] node.
+
+
+
+
+
+
+ Return whether the viewport's texture is centered on the origin.
+
+
+
+
+
+
+ Set whether the viewport's texture should be centered on the origin.
+
+
@@ -43859,11 +43922,18 @@ This method controls whether the position between two cached points is interpola
Set color modulation for the texture. All texture pixels are multiplied by this color. Color may contain rgb values above 1 to achieve a highlight effect.
-
-
-
+
+
+
- Get color modulation for the texture. All texture pixels are multiplied by this color.
+ Set the offset to the origin of the texture.
+
+
+
+
+
+
+ Set the path to the shown [Viewport] node.
@@ -43878,15 +43948,6 @@ This method controls whether the position between two cached points is interpola
The VisibilityEnabler will disable [RigidBody] and [AnimationPlayer] nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler itself.
-
-
-
-
-
-
- Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler is not in view. See the constants for enablers and what they affect.
-
-
@@ -43896,14 +43957,23 @@ This method controls whether the position between two cached points is interpola
Returns whether the specified enabler was set to true or not.
+
+
+
+
+
+
+ Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler is not in view. See the constants for enablers and what they affect.
+
+
-
- This enabler will freeze [RigidBody] nodes.
-
This enabler will pause [AnimationPlayer] nodes.
+
+ This enabler will freeze [RigidBody] nodes.
+
@@ -43916,15 +43986,6 @@ This method controls whether the position between two cached points is interpola
The VisibilityEnabler2D will disable [RigidBody2D], [AnimationPlayer], and other nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler2D itself.
-
-
-
-
-
-
- Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler2D is not in view. See the constants for enablers and what they affect.
-
-
@@ -43934,25 +43995,34 @@ This method controls whether the position between two cached points is interpola
Returns whether the specified enabler was set to true or not.
+
+
+
+
+
+
+ Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler2D is not in view. See the constants for enablers and what they affect.
+
+
-
- This enabler will freeze [RigidBody2D] nodes.
-
This enabler will pause [AnimationPlayer] nodes.
+
+ This enabler will freeze [RigidBody2D] nodes.
+
This enabler will stop [Particles2D] nodes.
-
-
This enabler will stop the parent's _process function.
This enabler will stop the parent's _fixed_process function.
+
+
@@ -43965,13 +44035,6 @@ This method controls whether the position between two cached points is interpola
The VisibilityNotifier is used to notify when its bounding box enters the screen, is visible on the screen, or when it exits the screen.
-
-
-
-
- Set the visibility bounding box of the VisibilityNotifier.
-
-
@@ -43986,13 +44049,15 @@ This method controls whether the position between two cached points is interpola
Return true if any part of the bounding box is on the screen.
+
+
+
+
+ Set the visibility bounding box of the VisibilityNotifier.
+
+
-
-
- Emitted when the VisibilityNotifier enters the screen.
-
-
@@ -44000,9 +44065,9 @@ This method controls whether the position between two cached points is interpola
Emitted when the VisibilityNotifier enters a [Camera]'s view.
-
+
- Emitted when the VisibilityNotifier exits the screen.
+ Emitted when the VisibilityNotifier enters the screen.
@@ -44012,6 +44077,11 @@ This method controls whether the position between two cached points is interpola
Emitted when the VisibilityNotifier exits a [Camera]'s view.
+
+
+ Emitted when the VisibilityNotifier exits the screen.
+
+
@@ -44024,13 +44094,6 @@ This method controls whether the position between two cached points is interpola
The VisibilityNotifier2D is used to notify when its bounding rectangle enters the screen, is visible on the screen, or when it exits the screen.
-
-
-
-
- Set the visibility bounding rectangle of the VisibilityNotifier2D.
-
-
@@ -44045,6 +44108,13 @@ This method controls whether the position between two cached points is interpola
Return true if any part of the bounding rectangle is on the screen.
+
+
+
+
+ Set the visibility bounding rectangle of the VisibilityNotifier2D.
+
+
@@ -44081,6 +44151,12 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
@@ -44093,12 +44169,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
@@ -44112,812 +44182,26 @@ This method controls whether the position between two cached points is interpola
The visual server is completely opaque, the internals are entirely implementation specific and cannot be accessed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -44928,7 +44212,7 @@ This method controls whether the position between two cached points is interpola
-
+
@@ -44940,7 +44224,7 @@ This method controls whether the position between two cached points is interpola
-
+
@@ -44960,340 +44244,20 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -45322,6 +44286,22 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -45354,56 +44334,118 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -45430,34 +44472,280 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
-
-
-
-
-
+
-
-
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -45474,6 +44762,112 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -45482,57 +44876,747 @@ This method controls whether the position between two cached points is interpola
-
+
+
+
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
+
-
+
-
+
-
+
-
-
-
-
-
+
@@ -45546,38 +45630,24 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
@@ -45588,134 +45658,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -45736,6 +45678,134 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -45765,11 +45835,11 @@ This method controls whether the position between two cached points is interpola
Windowdialog is the base class for all window-based dialogs. It's a by-default toplevel [Control] that draws a window decoration and allows motion and resizing.
-
-
-
+
+
+
- Set the title of the window.
+ Return the close [TextureButton].
@@ -45779,34 +45849,34 @@ This method controls whether the position between two cached points is interpola
Return the title of the window.
-
-
-
+
+
+
- Return the close [TextureButton].
+ Set the title of the window.
+
+
-
-
-
-
-
-
-
-
-
+
+
+
+
+
-
+
+
+
@@ -45818,8 +45888,14 @@ This method controls whether the position between two cached points is interpola
Class that has everything pertaining to a world. A physics space, a visual scenario and a sound space. Spatial nodes register their resources into the current world.
-
-
+
+
+
+
+
+
+
+
@@ -45836,24 +45912,18 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
@@ -45872,8 +45942,8 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
@@ -45884,8 +45954,8 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
@@ -45900,18 +45970,18 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
+
+
+
+
+
+
@@ -45922,36 +45992,6 @@ This method controls whether the position between two cached points is interpola
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -45974,11 +46014,9 @@ This method controls whether the position between two cached points is interpola
-
-
+
+
-
-
@@ -45998,30 +46036,44 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -46038,6 +46090,24 @@ This method controls whether the position between two cached points is interpola
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -46064,13 +46134,6 @@ This method controls whether the position between two cached points is interpola
Sort all child nodes based on their Y positions. The child node must inherit from [CanvasItem] for it to be sorted. Nodes that have a higher Y position will be drawn later, so they will appear on top of nodes that have a lower Y position.
-
-
-
-
- Set whether the children nodes are sorted or not. (default true)
-
-
@@ -46078,6 +46141,13 @@ This method controls whether the position between two cached points is interpola
Returns true if the children nodes are being sorted.
+
+
+
+
+ Set whether the children nodes are sorted or not. (default true)
+
+